Key-value pairs to configure app behavior

Table 1. key-value pairs to configure app behavior

Key

Value: Enter/Select one

Description and Value

Specifies the level of detail for logs

log_level

  • DEBUG

  • INFO

  • WARNING

  • ERROR

Select one of the following:

  • DEBUG: Includes debug level information for application flow and request, response messages for target repositories. This is the highest level and verbose, so choose this level only when needed.

  • INFO: Includes only information related to specific flows and requests.

  • WARNING: Includes only warnings about runtime errors and target repositories.

  • ERROR: Includes only runtime errors, and error and status codes from requests to target repositories.

Email logs

support_email_id

Enter a valid email address.

Automatically populates the email address when the device user emails the device logs.

Disallow adding some document storages

blocked_storage_domains

Enter one or more of the following:

  • Box

  • Dropbox

  • Microsoft SharePoint

  • WebDAV

  • CIFS

Blocks device users from adding the content site to [email protected]:

Enter the values as a semicolon (;) separated list.

Example: Box Dropbox;CIFS

Microsoft SharePoint includes Office 365 SharePoint sites.

Disallow adding user sites

disable_user_sites

  • true

  • false

Prevents device users from adding sites to [email protected]

User added sites will be removed. Documents from User sites marked as Starred, Offline or in Recents will be removed.

Restrict number of allowed user sites

restrict_number_of_user_sites

Connector type:

Number of sites that are allowed.

For example:

SharePoint:2, Box:1

Restricts the number of User sites that a device user can add. If a site type is not configured, there are no restrictions on the number of User sites for that site type.

Restricting number of User sites has no impact on blocked sites. This key-value pair only applies to allowed sites. The configuration is ignored if DISABLE_USER_SITES is true.

Enter the following value:

site type and number in the following format:

Site type1:number; Site type2:number.

Valid entries for site type are: SharePoint, Box, Dropbox, WebDAV, CIFS.

Number is a positive integer greater than 0.

Example:

SharePoint:2; Box:1

In this example, the device user will be able to add up to two SharePoint sites, and only one Box site. There are no restrictions on any other type site.

Allows sending analytics from [email protected] to Mixpanel

allow_analytics

  • true

  • false

Use the following values to set the key-value pair:

The default value is set to True.

Disables editing, importing, and uploading files

disable_editing

  • true

  • false

Disables the following in My Files and all content sites in [email protected]:

  • Editing.

  • Importing images from photo gallery.

  • Uploading to and deleting files in the backend resource.

Automatically populates the user name for the content site.

AUTOFILL_CREDENTIALS

Enter parameters for the content site in the following JSON format:

{"URL":

{"domainType":"DomainType","userName":"$USERID$","password":"$PASSWORD$"},"default":"Domain/$USERID$"}

For JSON format:

  • Ensure that there are no spaces.

  • Values are case sensitive.

  • Ensure that the JSON format is valid.

  • The variable for user name can be preceded by either a single forward slash or two back slashes: Domain/$USERID$ or Domain\\$USERID$

 

  • Copying and pasting JSON strings may result in invalid JSON.

  • Validate the JSON string. There are many sites, example: jsonlint.com, that will validate the JSON string.

URL: Enter the URL for the content site. Include the protocol. Example: http, https.

Domain Type: Enter one of the following: SharePoint, WebDAV, Box, BoxEnterprise, CIFS.

Domain: Enter the domain name to which the username defaults if the username for the URL cannot be resolved. Variables are not supported.

Password: The user is directly logged in to the Site from the Sites screen. This feature is applicable for CIFS and WebDAV sites only on Core.

$PASSWORD$ value will be available only when admin enables "Save User Password" in device registration settings on Core and user registered [email protected] client after that. Refer to Coredocumentation for its usage.

Examples:

  • {"https://sharepoint.miacme.com": {"domainType":"SharePoint","userName":"miacme/$USERID$"},"default":"miacme.com/$USERID$"}

  • {"https://sharepoint.miacme.com":{"domainType":"SharePoint","userName":"miacme\\$USERID$"},"default":"miacme.com\\$USERID$"}

  • {"default": "domain/$USERID$"}

  • {"domainType": "CIFS","userName": "$USERID$","password":"$PASSWORD$"}}

Displays watermark text on the fies and folders

watermark_text

Use a user identifying variables as values such as, $USERID$ and $EMAIL$.

Displays a diagonal watermark text (provided by the administrator) over all the documents viewed or edited using [email protected]

Displays the title of files and folders in SharePoint

show_title

  • True

  • False

Displays user friendly title for files and folders in Sharepoint.

Use the following values to set the key-value pair:

  • True: Enables title display.

  • False: Disables title display.

The default value is set to False.

Sets box metadata cache expiry

box_metadata_timeout

Default value: 15 minutes

Box metadata for a particular folder is cached whenever response is received from server.

This cached metadata expires after timeout and if a new request for metadata comes for the same folder, it is sent to BOX server.

Duration in minutes after which box metadata cache expires.

ENABLE_POLARIS_VIEWER

 

Enables the embedded viewer in [email protected] for viewing files.

Enter the following value:

Yes.

MAILTO_PREFIX

 

Opens a mailto: link in Email+.

If this key-value pair is not configured, tapping on a mailto link does not bring up any email client.

Enter the following value:

email+launcher://docsatwork?url=mailto:

HTTP_PREFIX

 

Allows users to tap on a URL starting with http:// and view the site in a browser. If the key-value pair is not configured, users will not be able to view an http link in a browser.

If the key-value pair is not configured, http:// links are not opened in any browser.

Ivanti recommends that both HTTP_PREFIX and HTTPS_PREFIX are configured. If only one URL scheme is configured, the unconfigured URL scheme will not be opened in any browser thus impacting user experience.

Enter one of the following values:

mibrowser

URLs starting with http:// are opened in [email protected]

http

URLs starting with http:// are opened in Safari.

HTTPS_PREFIX

 

Allows users to tap on a URL starting with https:// and view the site in a browser. If the key-value pair is not configured, users will not be able to view an https link in a browser.

If the key-value pair is not configured, https:// links are not opened in any browser.

Ivanti recommends that both HTTP_PREFIX and HTTPS_PREFIX are configured. If only one URL scheme is configured, the unconfigured URL scheme will not be opened in any browser thus impacting user experience.

Enter one of the following values:

mibrowsers

URLs starting with https:// are opened in [email protected]

https

URLs starting with https:// are opened in Safari.

APPLY_SSO_LABEL

 

Changes the NoAuthn label to Corporate single sign-on (SSO) in [email protected] The NoAuthn option is seen in the Authentication settings for SharePoint sites in [email protected] There is no functional change.

Enter the following value:

true

ENABLE_PDF_DOCUMENT_DEFINE

 

Makes the Define option available for PDF documents, regardless of whether Copy/Paste is enabled in AppConnect policy.

Enter the following value:

true

ENABLE_POLARIS_DOCUMENT_CONTENT_SHARE

 

Makes the Share option available for PDF documents, regardless of whether Copy/Paste is enabled in AppConnect policy.

Enter the following value:

true

ENABLE_WEBVIEW_AUTHENTICATION

 

Use this key-value pair if the Sharepoint server is not set up to use persistent authentication cookies and users encounter issues with opening WebView for SharePoint sites.

Enter the following value:

true

Allow digital signature for PDF

signing_certificate

Certificate

This key allows the admin to add signing certificate which is used for digital signature for PDF forms for Android AppConnect.

To enable digital signature add configure signing certificate, add signing_certificate key and select the signing certificate from drop-down menu.

Only one signing certificate is supported and it should be in .p12 format. It needs to be added as certificate enrollment configuration.

signing_certificate_ca_n

Certificate

This key allows the admin to add multiple Certificate Authorities to trusted CA’s. The certificate must be DER-encoded.

Where, the value of n can be from 0 to 9.

For example:

signing_certificate_ca_0,

signing_certificate_ca_1

Default viewer for PDF files

enable_pspdfkit

  • True

  • False

This key allows the admin to change default viewer for PDF files. If set to true, this enhances user interface experience and also supports digital signature feature.

Grouping of Offline files

group_offline_files

  • True

  • False

This key allows files under offline section to be grouped under folder path header. The default value is set to False.

Miscellaneous

ENABLE_CIFS_RETRY_ON_SHARING_VIOLATION

  • True

  • False

This key allows the admin to resolve an issue where CIFS would cause a sharing violation error, when you try to open a file which was already opened/updated on desktop.