Inkscreen

Key

Description

Default if not configured

licensekey

License key for use of application used to determine and track number of devices provisioned. 

IMPORTANT:  The application must be able to reach https://api.backendless.com/ in order to authenticate the license. Please check firewall settings to ensure devices can reach this domain. 

REQUIRED FOR ACTIVATION

CAPTOR will only work in unencrypted PIN-mode if the appropriate license key is not added

captoruser

Links the username field within the app to either the email address or user ID for that user as listed in Ivanti. The app user will not be able to change the app username once this key-pair is set. The MobileIron admin can change this value any time without negatively impacting users. Value entered should be either $USERID$ or $EMAIL$ or any other wildcard variable supported by Ivanti. Please note:  the username can be displayed on the photo or video as a caption, and inserted as metadata.

REQUIRED FOR ACTIVATION

If key-value pair is not configured, the app will not be able to authenticate against the license server.

filenamebase

Sets a base name for photos, videos, and documents captured with the app. The nomenclature system appends the base with a sequential number starting with 000 (ex. CAPTOR000.JPG). Value can be an alpha-numeric string 1-20 characters with no spaces, or a wildcard variable such as $USERID$

ADDING THIS KEY-VALUE PAIR IS HIGHLY RECOMMENDED

If key-value pair is not configured, the default filename base will be CAPTOR and the user can edit.

Sets the default capture mode when user opens app. Value entered can be: "photo" "video" "doc" or "audio"

App user will be able to select their own default if not configured

disablecapturemodephoto

Disables the Photo capture mode and removes the option from the application. Value entered should be either true or false.

disablecapturemodevideo

Disables the Video capture mode and removes the option from the application. Value entered should be either true or false.

disablecapturemodeaudio

Disables the Audio capture mode and removes the option from the application. Value entered should be either true or false.

disablecapturemodedoc

Disables the Document capture mode and removes the option from the application. Value entered should be either true or false.

disablecapturemodeqr

Disables the QR-Code and Barcode Reader from Photo capture mode. Value entered should be either true or false.

allowemail

Enables or disables the use of the native iOS email client. Value entered should be either true or false.

For Ivanti EPMM deployments, it is also required to set the Container Policy for Allow Open In to the “whitelist” option, and include the following two bundle IDs:

com.apple.UIKit.activity.Mail

com.apple.mobilemail

Note:  If you use Email+ or any other non-native email app, these options will appear in the Open In menu. 

If key-value pair is not configured, the default is to disable the ability to share using the native email app.

allowimport

Enables or disables the ability to bring photos and videos into CAPTOR from the native media gallery. Value entered should be either true or false.

If key-value pair is not configured, importing media will not be allowed.

emptytrash

Sets a value (in days) to wait before permanently deleting media content that a user has moved to the Trash folder in the app. Value entered should be a whole number 0 - 999. Entering “0” means the Trash folder will be emptied each time the app is launched.

If key-value pair is not configured, the default setting is to delete contents of the Trash folder that are older than 30 days.

localization

Sets the language to be one of the five supported currently by CAPTOR. Value entered is the two character abbreviation for the language setting. Current options include:

en = English

es = Spanish

fr = French

de = German

it = Italian

nl = Dutch

*This should only be used if the device language is not offered by CAPTOR and the user is not conversant in English.

If key-value pair is not configured, the default localization setting will be English (en) and the user can change it in the app settings.

showcaption

Enforces the printed caption on the border of photos, and the addition of a final frame to shared videos. The caption includes 1) username of who captured the media, 2) time and date of capture, 3) location where media was captured (lat/long or city/state/country), and a note (up to 255 char). Value entered should be TRUE or FALSE, whereby TRUE dictates the caption will always be included and FALSE removes the caption in all cases. Please note:  this feature does not impact Documents or Audio.

If key-value pair is not configured, the user will have the ability to set the caption on or off in the app Settings.

browserscheme

Sets the default web browser so that any links accessed from the app launch the desired web browser. Value entered may be one of the following (only enter the bold text):

mibrowser:// (Web@Work HTTP)

mibrowsers:// (Web@Work HTTPS)

googlechrome:// (Google Chrome)

Please note:  If none of the supported browsers are present on the device, Safari will be used.

If key-value pair is not configured, the default browser is Safari.

pdfversion

Sets the version of PDF that will be created when sharing documents or photos in the PDF file format. Value entered may be:

1.3

1.4

1.5

1.6

1.7

PDF/A-1a

PDF/A-1b

PDF/A-2a

PDF/A-2b

PDF/A-2u

PDF/A-3a

PDF/A-3b

PDF/A-3u

If key pair is not configured, the default will be 1.3 and the user will be able to adjust.

*If set to any of the PDF/A subtypes, the option to set a PDF password will be disabled.

allowlocation

Determines whether the application will prompt to allow location services and tag media with location information. Values entered may be:

user (allows user to decide whether to enable location services)

false (completely disables all location services)

If key pair is not configured, the default will allow the user to accept or deny location services.

filesizelimit

Sets the maximum size of a shared file (in MB). Values entered may be 1 - 30.

If key pair is not configured, the default will be “unlimited”, allowing the user to attempt to share files of any size.

watermark

Adds a semi-transparent watermark across photos and document pages. 50 character limit. Supports wildcard variables such as $USERID$ and $EMAIL$, or custom strings.

If key pair is not configured, the default is to allow the user to enter their own watermark if desired. 

disableappanalytics

If key pair is not configured, the default is to report event data.

disablecrashreporting

Key

Description

Default if not configured

compliance

Turns on compliance event logging. Enter value “True” to enable logging. 

REQUIRED:  To enable Compliance reporting it is required you also contact Inkscreen. 

Service will not be enabled and the app will not log and communicate compliance event.

Key

Description

Default if not configured

enablebackup

This is the master switch to turn on the backup service. The value entered identifies which transfer protocol will be used. Only one protocol can be established at a time, so the remaining protocols will be disabled. Values entered may be:

webdav

sftp

smb

onedrive

user

*Entering "user" will enable the service and allow the user to select the protocol.

If key pair is not configured, the backup service will be disabled.

backupmethod

The backup process can be automated, or allowed to be conducted by the user on demand. Values entered may be:

auto

manual

If key pair is not configured and enable backup is configured, the default will be manual.

automatebackupafter

If you intend the backup process to be automated, this key is required. The value entered indicates how long the system will wait before backing up content. For example, setting a value “7” means that the system will backup content that was captured at least 7 days prior. Entering a value “0” will backup content in the next user session. Entering "instant" will trigger prompts for the user to backup content in the same session it is captured. Values entered may be 0-30 or "instant".

If key pair is not configured and backupmethod is set to “auto”, the default will be 1.

deletebackedupafter

When configured this will move backed-up content to the CAPTOR Trash folder after a specified number of days after it was backed up. For example, a value “3” would instruct the system to trash an item three days after it was backedup. A value “0” instructs the system to trash items immediately after backup. Values entered can be 0-30. 

If key pair is not configured, the default is set to never delete content after it is backedup. 

contentquality

Sets the quality of the content that is backedup. The system uses the same quality standards as the normal sharing options . Values entered maybe:

low

med

high

If key pair is not configured, the default is high.

backupshowcaption

Adds the caption to photos and videos that are backed up. This configuration was previously part of "showcaption". Value entered can be true or false.

If key pair is not configured, the caption will be added to photos and videos that are backed up.

Key

Description

Default if not configured

webdavuser

Assigns the username for authentication of backup server. For most customers the value entered should be $USERID$

If key pair is not configured, the user will be allowed to set the username within app.

webdavpassword

Assigns the password for authentication of backup server. MobileIron no longer supports $PASSWORD$ as a standard attribute so consider creating a custom attribute or allowing the user to enter the password within the app.

If key pair is not configured, the user will be allowed to set the password within app.

webdavurl

Assigns the URL to the backup server. Value entered should be a valid url; for example “https://23-22.companynet.com"

If key pair is not configured, the user will be allowed to set the URL within app.

webdavpath

Assigns the directory path for the user’s folder on the backup server. *Please note, the user folders must be created on the server by the IT Admin prior to setting this configuration. For most customers, the value entered should be:  /$USERID$/

If key pair is not configured, the user will be allowed to set the path within app.

*SMB requires a VPN (ex. MobileIron Tunnel App, Cisco AnyConnect) for all situations except transferring files over a local network.

**Supports SMB2 and SMB3

For detailed instructions on configuring SMB please go to this knowledge base article: https://inkscreen.freshdesk.com/support/solutions/articles/1000316184-captor-smb-backup-configuration-guide

Key

Description

Default if not configured

smbhost

Assigns the URL or IP address for the backup server. 

If key pair is not configured, the user will be allowed to set the host within app.

smbuser

Assigns the username for authentication of backup server. For most customers the value entered should be $USERID$

If key pair is not configured, the user will be allowed to set the username within app.

smbpassword

Assigns the password for authentication of backup server. MobileIron no longer supports $PASSWORD$ as a standard attribute so consider creating a custom attribute or allowing the user to enter the password within the app.

If key pair is not configured, the user will be allowed to set the password within app.

smbshare

Assigns the SMB share name. This field may not be required for all implementations.

If key pair is not configured, the user will be allowed to set the share within app.

smbpath

Assigns the directory path for the user’s folder on the backup server. *Please note, the user folders must be created on the server by the IT Admin prior to setting this configuration. For most customers, the value entered should be:  $USERID$

The Path cannot be empty or just a slash (/).

If key pair is not configured, the user will be allowed to set the path within app.

Key

Description

Default if not configured

sftphost

Assigns the IP address or URL for the backup server. 

If key pair is not configured, the user will be allowed to set the host within app.

sftpuser

Assigns the username for authentication of backup server. For most customers the value entered should be $USERID$

If key pair is not configured, the user will be allowed to set the username within app.

sftppassword

Assigns the password for authentication of backup server. MobileIron no longer supports $PASSWORD$ as a standard attribute so consider creating a custom attribute or allowing the user to enter the password within the app.

If key pair is not configured, the user will be allowed to set the password within app.

sftpport

Assigns the network port. Value entered should be numeric (for example:  22). 

If key pair is not configured, the user will be allowed to set the port within app.

sftppath

Assigns the directory path for the user’s folder on the backup server. *Please note, the user folders must be created on the server by the IT Admin prior to setting this configuration. For most customers, the value entered should be:  /$USERID$

If key pair is not configured, the user will be allowed to set the path within app.

sftpsshpassphrase

Only for SFTP implementations utilizing SSH2/RSA keys. This field assigns the SSH Key Passphrase. Not all SSH Key implementations will require this key. 

If key pair is not configured, the user will be allowed to enter the value within app.

sftpsshkey

Only for SFTP implementations utilizing private SSH2/RSA keys. This field would contain the actual text of the key. Most situations require the end user to copy and paste the key into the app.

If key pair is not configured, the user will be allowed to enter the value within app.

Requires Microsoft Entra/AD Admin to grant CAPTOR permission to access MS Graph. Please review MS Conditional Access policies before deploying CAPTOR with OneDrive backup. 

Key

Description

Default if not configured

onedrivepath

Assigns the directory path for the user’s folder. Supports substitutions variables. Use a single / to write CAPTOR folders to the root directory. 

If key pair is not configured, the user will be allowed to set the path within app.