This is an AppConfig app intended to be deployed and managed within an EMM platform that supports AppConfig. Please see www.appconfig.org for a list of compatible systems. Since each EMM handles the setup process in their own unique way, this article does not outline the specific configuration steps, but it does provide all of the key/value pairs that can be configured to control CAPTOR and manage the content captured by users of the app.
BundleID: com.inkscreen.captor
App Store: https://apps.apple.com/us/app/captor-for-enterprise/id1071870839
What's New?
5.0.0 Default Capture Mode, Disable Capture Modes, changes to Show Caption, and more. New and updated configs highlighted in yellow.
4.1.8 OneDrive updates to MSAL authentication and Conditional Access
4.1.0 SMB updates, OneDrive auth update, new config "disableimagerecognition" for new object recognition feature
4.0.6 New configs for "backuppdfpagesize" and "watermarktimedate", pause and restart audio recording, SMB fixes
4.0.0 New app icons
3.6.7 Bugfix release for mutli-page document scanning
3.6.5 SMB3 support; copy/paste audio recording transcripts
3.6.4 Enhanced Search using Speech Recognition to process audio and video recordings so they are searchable by detected speech. *Requires adding config key "allowspeechrecognition" and value "True"
3.6.3 Enhanced Search using OCR to process photos and documents so they are searchable by detected text
3.6.2 Accessibility improvements
3.5.8 eSignature annotation
Note on Wildcard/Lookup/Placeholder Variables:
Each EMM platform has its own unique set of wildcard (or lookup or placeholder) variables. Inkscreen strives to support as many of these variables as possible however we cannot support all options for all platforms. All of the following configuration keys allow variables to be used as the value. For example, if the intent was to use email address as the CAPTOR username, you might enter {{EMAIL}} as the configuration value (if that is the format your EMM platform uses). If you encounter a wildcard variable that we do not support and feel it would improve your CAPTOR experience please send details to support@inkscreen.com and we will do our best to engineer support.
Key | Type | Description | Default Value |
licensekey | String | REQUIRED KEY. To request a license key please send a request to sales@inkscreen.com Entering a valid license key allows the application to be deployed, managed, and controlled by an EMM platform that is compatible with AppConfig applications. | N/A |
captoruser | String | REQUIRED KEY. Links the username field within the app to either the email address or user ID for that user. The app user will not be able to change the app username once this key-pair is set. For example, value entered could be {EmailAddress}. Please note: the app username can be displayed on the photo or video as a caption, and inserted as metadata. | App user will be able to set their own app username. |
appauthenabled | Boolean | Enables or disables passcode or TouchID requirement for app authentication. Enter value of either true or false. In order to fully encrypt captured video, enter value of true. | false |
| defaultcapturemode | String | 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 | Boolean | Disables the Photo capture mode and removes the option from the application. Value entered should be either true or false. | false |
| disablecapturemodevideo | Boolean | Disables the Video capture mode and removes the option from the application. Value entered should be either true or false. | false |
| disablecapturemodeaudio | Boolean | Disables the Audio capture mode and removes the option from the application. Value entered should be either true or false. | false |
| disablecapturemodedoc | Boolean | Disables the Document capture mode and removes the option from the application. Value entered should be either true or false. | false |
| disablecapturemodeqr | Boolean | Disables the QR-Code Reader from Photo capture mode. Value entered should be either true or false. | false |
allowemail | Boolean | Enables or disables the use of the native iOS email client. Value entered should be either true or false. If your organization uses any non-native email app, these options should appear in the Open In menu. | true |
| allowspeechrecognition | Boolean | If enabled, audio and video recordings will go through a speech recognition process (typically conducted on the device but may also use external Apple servers) so that content is searchable by speech detected in the recordings. To enable, enter value "True" | false |
| videotimelimit | Number | Used to limit the maximum length of a recorded video. Enter a whole number 1 - 999 representing the maximum length a video can be recorded in seconds. | 999 |
allowimport | Boolean | Enables or disables the ability to import media into CAPTOR. Value entered should be either true or false. | true |
emptytrash | Number | 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. | 30 |
filenamebase | String | Sets a base name for captured media. The nomenclature system appends the base with the date and time. Value can be an alpha-numeric string 1-20 characters with no spaces, or enter {OrganizationGroup} or a wildcard value for UserID. | CAPTOR, which will be editable by users. |
localization | String | Sets the language to be one of the six supported currently by CAPTOR. Enter the two character abbreviation for the string. Current options include: en = English es = Spanish fr = French de = German it = Italian nl = Dutch *This is only necessary if CAPTOR does not support the device language setting and the user prefers one of the supported languages over English. | will match user’s device setting if avail. |
showcaption | Boolean | 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. | true, and users will be able to change in Settings. |
browserscheme | String | Sets the default web browser for the app. Value entered may be one of the following (only enter the bold text): mibrowser:// (Web@Work HTTP) mibrowsers:// (Web@Work HTTPS) googlechrome:// (Google Chrome) awb:// (AirWatch Browser HTTP) awbs:// (AirWatch Browser HTTPS) Please note: If the selected browser is not present on the device, Safari will be allowed. | Safari |
String | Entering this key auto-completes the user-registration form presented to user at first launch. Value to enter should be {EmailAddress} | User will enter data. | |
organization | String | Entering this key auto-completes the user-registration form presented to user at first launch. Value to enter should be {OrganizationGroup} | User will enter data. |
firstname | String | Entering this key auto-completes the user-registration form presented to user at first launch. Value to enter should be {FirstName} | User will enter data. |
lastname | String | Entering this key auto-completes the user-registration form presented to user at first launch. Value to enter should be {LastName} | User will enter data. |
pdfversion | String | 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 | 1.3, and user can set to any other value. |
allowlocation | String | 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) | User can decide when prompted. |
filesizelimit | S | Sets the maximum size of a shared file (in MB). Value entered may be 1 - 30. | Unlimited |
watermark | String | Adds a semi-transparent alpha/numeric string (up to 50 characters) across photos and pages of document. | “Captured by CAPTOR” |
| watermarktimedate | String | Adds time and date of content capture to the watermark. To enable this feature, enter value True | False |
| disableappanalytics | String | Turns off the app's anonymous events reporting service. Inkscreen uses this data to understand the general popularity of certain features. The data collected contains no identifiable information, is only viewed in bulk aggregate form, and is only retained for 90 days. To disable this feature, enter value True. | Events will be logged. |
| disablecrashreporting | String | Turns off the app's crash reporting service. Inkscreen uses this data to improve the stability of the application. Crash reports do not contain identifying information. A crash report would typically include the device model, version of CAPTOR, and the line of code where the event occurred. To disable this feature, enter value True. | Crashes will be reported. |
| disableimagerecognition | String | Turns off the image recognition and labeling feature. Labels can be found in the Photo Info screen and are searchable. | Feature will be enabled |
CAPTOR Compliance
First available with v3.5.2, CAPTOR Compliance is a system intended to log potential container violations and report them to a company contact. The goal is to provide awareness of end user actions that may result in data leakage or attempted data leakage (Insider Threats). The end user will not be aware of this service, and enabling Compliance will not alter the existing container policy (Open In, Copy/Paste, etc).
The initial release will include alerts for the following events:
- Screenshot - end user takes a screenshot while CAPTOR is in use.
- Import - end user attempts to import content into CAPTOR when “allowimport” is set to “False” or not configured.
- Open In - end user attempts to share (via Open In function) content to an unauthorized app. Also includes AirDrop and other native sharing options.
- Screen Recording/Mirroring - end user conducts a screen recording or screen mirroring session that includes CAPTOR.
*Future releases will add detection of additional events.
To enable CAPTOR Compliance, please follow these two steps:
FIRST: Add the key “compliance” with value “True” in the CAPTOR Configuration.
SECOND: Contact Inkscreen to request the reporting service to be enabled. Send an email to support@inkscreen.com and include the full name and email address where the reports should be sent. Also please indicate the frequency of the report. Reporting intervals can be immediate (an email will be generated each time an event is logged), daily, weekly, or monthly.
Secure Content Copy Backup Service
New in February 2019 is an optional service enabling the backup of CAPTOR content to a network drive.
Before setting up the service, you must establish a server on your network to receive the content. Additionally, the server must be configured to include folders for each CAPTOR user which can be mapped to. If you utilize the key “captoruser” with value {UserID} for example, the folders on your backup server should be named the same way.
Here is an overview of the process to set up the backup service:
- Select the best data transfer protocol. CAPTOR currently supports SMB2, SMB3, SFTP, Microsoft OneDrive and WebDAV. **The SMB protocol requires the use of a VPN.
- Establish a server on your network to receive the content. Create folders for each user, named to match the CAPTOR usernames.
- Establish the key/value pairs in your EMM system to enable and configure the service.
- Launch CAPTOR on a test device and review the configuration by going to Settings>Backup Config. Depending on your configuration you may have to complete the settings for the selected transfer protocol and/or Advanced Config options. There is a Test Configuration button in the app settings.
The following key/value pairs can be added to the App Configuration.
Key | Type | Description | Default if not configured |
enablebackup | String | 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 | If key pair is not configured, the end user will be able to set up their own backup system. To disallow this practice, enter value ‘sftp’ and also enter key ‘sftphost’ with value ‘disabled’ |
backupmethod | String | 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 | Number | 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. Values entered may be 0-30. | If key pair is not configured and backupmethod is set to “auto”, the default will be 1. |
deletebackedupafter | Number | 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 | String | Sets the quality of the content that is backed up. The system uses the same quality standards as the normal sharing options . Values entered may be: low med high | If key pair is not configured, the default is high. |
| backuppdfpagesize | String | Sets PDF page aspect ratio for backed-up documents. Enter value us for US-based legal and letter standards, or eu for European-based A4 and A5 standards. | If key pair is not configured, the system will not apply a standard aspect ratio to backed-up documents. |
| backupshowcaption | Boolean | 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. |
Backup Protocol Key/Value Pairs
The next step is to set the key pairs related to the backup transfer protocol that you selected. You may only use one protocol for any specific label. Please select one protocol (WebDAV, SMB, or SFTP) and then enter the corresponding key/value pairs into the configuration.
WebDAV
Key | Type | Description | Default if not configured |
webdavuser | String | Assigns the username for authentication of backup server. For most customers the value entered will match the captoruser value. | If key pair is not configured, the user will be allowed to set the username within the app. |
webdavpassword | String | Assigns the password for authentication of backup server. | If key pair is not configured, the user will be allowed to set the password within the app. |
webdavurl | String | 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 the app. |
webdavpath | String | 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 example, you might enter: /{UserID}/ | If key pair is not configured, the user will be allowed to set the path within the app. |
SMB
**SMB requires a VPN for all situations except transferring files over a local network. Supports SMB2 and SMB3 ***For more detailed instructions on setting up SMB backups please visit the following knowledge base article: https://inkscreen.freshdesk.com/support/solutions/articles/1000316184-captor-smb-backup-configuration-guide | |||
Key | Type | Description | Default if not configured |
smbhost | String | 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 the app. |
smbuser | String | Assigns the username for authentication of backup server. For most customers the value entered will match the value for captoruser. | If key pair is not configured, the user will be allowed to set the username within the app. |
smbpassword | String | Assigns the password for authentication of backup server. | If key pair is not configured, the user will be allowed to set the password within the app. |
smbshare | String | 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 the app. |
smbpath | String | 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 example you might enter {UserID} *The path cannot be empty or consist of only a slash (/). | If key pair is not configured, the user will be allowed to set the path within the app. |
SFTP
Key | Type | Description | Default if not configured |
sftphost | String | 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 the app. |
sftpuser | String | Assigns the username for authentication of backup server. For most customers the value entered will match the value used for captoruser. | If key pair is not configured, the user will be allowed to set the username within the app. |
sftppassword | String | Assigns the password for authentication of backup server. | If key pair is not configured, the user will be allowed to set the password within the app. |
sftpport | String | 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 the app. |
sftpsshpassphrase | String | Only for 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 the app. |
sftpsshkey | String | Only for 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. Ensure line breaks are preserved. | If key pair is not configured, the user will be allowed to enter the value within the app. |
sftppath | String | 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. | If key pair is not configured, the user will be allowed to set the path within the app. |
Microsoft OneDrive
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. |
NOTE on Wildcard/Lookup/Placeholder Variables:
Each EMM platform has its own unique set of wildcard (or lookup) variables. Inkscreen strives to support as many of these variables as possible however we cannot support all options for all platforms. If you encounter a wildcard variable that we do not support and feel it would improve your CAPTOR experience please send details to support@inkscreen.com and we will do our best to engineer support.