The appSettings section specifies the configuration options for the Titan application. The subsections are described below.
general
The general section specifies the general configuration settings for Titan.
Options
| Attribute | Description |
|---|---|
| pathDelimiter | Specifies the character used to separate values in the path that displays the folder location. |
Example
"general": {
"pathDelimiter": "\\"
}
integrationServer
The integrationServer section specifies the configuration options for Integration Server.
Options
| Attribute | Description |
|---|---|
| url | Specifies the URL for Integration Server. |
| applicationId | Specifies the application ID that Titan uses for the Hyland Preferences Service. |
| bearerLoginProfileName | Specifies the bearer token login profile name. |
Example
"integrationServer": {
"url": "https://<is-host>/integrationserver",
"applicationId": "titan",
"bearerLoginProfileName": ""
},
pageViewer
The pageViewer section specifies which audio and video file types are supported by Titan. If this section is not configured, Titan cannot play audio or video files.
Options
| Attribute | Description |
|---|---|
| supportedAudioFileTypes | Specifies an array that maps audio file extensions to the corresponding mimeType. |
| supportedVideoFileTypes | Specifies an array that maps video file extensions to the corresponding mimeType. |
Example
"pageViewer": {
"supportedAudioFileTypes": [
{ "extension": "mp3", "mimeType": "audio/mp3" },
{ "extension": "wav", "mimeType": "audio/wav" }
],
"supportedVideoFileTypes": [
{ "extension": "mp4", "mimeType": "video/mp4" },
{ "extension": "webm", "mimeType": "video/webm" },
{ "extension": "qt", "mimeType": "video/quicktime" },
{ "extension": "mov", "mimeType": "video/quicktime" }
]
}
documentViewer
The documentViewer section specifies the configuration options for the Document Viewer in Titan.
Options
| Attribute | Description |
|---|---|
| removeFormsPane | Removes the Forms pane from the viewer. |
| removePropertiesPane | Removes the Properties pane from the viewer. |
| useNativePdfViewer | Specifies whether to use your system's native PDF viewer to view PDF documents. |
Example
"documentViewer": {
"removeFormsPane": false,
"removePropertiesPane": false,
"useNativePdfViewer": false
}
folderViewer
The folderViewer section specifies the configuration options for the Folder Viewer in Titan.
Options
| Attribute | Description |
|---|---|
| removeFormsPane | Removes the Forms pane from the viewer. |
| removePropertiesPane | Removes the Properties pane from the viewer. |
| removeRelatedFoldersPane | Removes the Related Folders pane from the viewer. |
| removeRelatedTasksPane | Removes the Related Tasks pane from the viewer. |
| canEditPageLabel | Specifies whether the user can edit a page label. |
Example
"folderViewer": {
"removeFormsPane": false,
"removePropertiesPane": false,
"removeRelatedFoldersPane": false,
"removeRelatedTasksPane": false,
"canEditPageLabel": true
}
formViewer
The formViewer section specifies the configuration options for the Forms Viewer in Titan.
Options
| Attribute | Description |
|---|---|
| autoloadFirstForm | Specifies whether the first form in the list displays by default when viewing the Forms pane. |
Example
"formViewer": {
"autoloadFirstForm": false
}
propertiesPane
The propertiesPane section specifies the configuration options for the Properties pane in Titan.
options
| Attribute | Description |
|---|---|
| name | Specifies the display of the Name field in the Properties panes. |
| location | Specifies the display of the Drawer or Path field in the Properties panes. |
| keys | Specifies the display of the Field1 through Field5 fields in the Properties pane. |
| type | Specifies the display of the Type field in the Properties panes. |
| notes | Specifies the display of the Notes pane in the user interface. |
| customProperties | Specifies the display of the Custom Properties pane in the user interface. |
| pageLabel | Specifies the display of the page label in the user interface. |
| additionalPageMetadata | Specifies the display of additional page metadata under Page Properties on the Properties pane in the user interface. |
Example
"propertiesPane": {
"displaySettings": {
"document": {
"name": "enabled",
"location": "enabled",
"keys": "enabled",
"type": "enabled",
"notes": "enabled",
"customProperties": "enabled",
"pageProperties": "disabled",
"pageLabel": "disabled",
"additionalPageMetadata": "disabled"
}
}
}
typeLabel
The typeLabel section specifies the defined custom text associated with the label displayed in the property pane. This is an optional section..
Options
| Attribute | Description |
|---|---|
| typeLabel | Specifies the custom text for the Document Type label displayed in the property pane. |
Example
"appSettings":
"propertiesPane": {
"typeLabel" : "Form Type"
…
}
}
search
The search section specifies the configuration options for the search functionality in Titan.
options
| Attribute | Description |
|---|---|
| enableFullTextSearch | Specifies whether Full-text search is enabled for Titan. |
| vslExtendedOperatorsEnabled | Specifies whether Titan adds the "contains" and "ends with" operators in the list of search operators. |
| vslAnyKeyConditionEnabled | Specifies whether Titan includes the Any Document Key condition in the list of search conditions. |
| fullTextSearchHighlightTag | Specifies how Titan identifies the highlighted keyword in the search result. The default OpenSearch highlight tags are <em> and </em>. The value em must be retained unless changed at the server. |
| fullTextSearchHighlightFillColor | Specifies the color of the highlighted keyword for raster pages such as TIF files. The existing color cannot be changed for text files. |
| excludeSearchFields | Specifies what search properties Titan excludes from the list of search conditions. If empty, all search properties are displayed. Only values included in the list are excluded. |
| includedCustomPropertySearchFields | Specifies what custom properties Titan includes in the list of search conditions. If undefined, all are included. If defined with an empty list, none are included. |
Example
"search": {
"enableFullTextSearch": true,
"vslExtendedOperatorsEnabled": true,
"vslAnyKeyConditionEnabled": true,
"fullTextSearchHighlightTag": "em",
"fullTextSearchHighlightFillColor": "#3288DE33",
"document": {
"excludeSearchFields": ["[drawer]", "[field2]"],
"includedCustomPropertySearchFields": ["Prop1", "Prop2"]
},
"folder": {
"excludeSearchFields": ["[drawer]"],
"includedCustomPropertySearchFields": ["Prop1"]
},
"folderContent": {
"excludeSearchFields": ["[drawer]"],
"includedCustomPropertySearchFields": ["Prop1"]
},
"task": {
"excludeSearchFields": ["[drawer]"],
"includedCustomPropertySearchFields": ["Prop1"]
},
"workflow": {
"excludeSearchFields": ["[drawer]"],
"includedCustomPropertySearchFields": ["Prop1"]
},
"captureIndexing": {
"excludeSearchFields": ["[drawer]", "[field2]"],
"includedCustomPropertySearchFields": ["Prop1", "Prop2"]
}
}
documentPrinter
The documentPrinter section specifies the configuration options for the printer settings in Titan.
Options
| Attribute | Description |
|---|---|
| pageSize | Specifies the paper size printed. |
| enableCoverPage | Specifies if the cover page of a document is to be printed. |
| enableAnnotations | Specifies if the annotations are printed. |
Example
"documentPrinter": {
"pageSize": "Letter",
"enableCoverPage": true,
"enableAnnotations": true
}
exportEmail
The exportEmail section specifies whether the user can email links to a document and what values are included in the email template.
Options
| Attribute | Description |
|---|---|
| to | Specifies the email address of the recipient. |
| cc | Specifies a carbon copy of an email when the user wants to include someone other than the direct recipient. |
| bcc | Specifies a blind carbon copy of an email when the user does not want the other recipients to see who else is included in the email. |
| subject | Specifies a subject of an email where the user can add a short description of the main content. |
| preBody | Specifies the section where the user can add any content before a document or a workflow item link. |
| postBody | Specifies the section on complimentary closure, such as "Thanks" or "Regards". |
Example
"exportEmail": {
"document": {
"to": "to_recipient@domain.com",
"cc": "cc_recipient@domain.com",
"bcc": "bcc_recipient@domain.com",
"subject": "Perceptive Content Document",
"preBody": "Below are links to the documents:",
"postBody": "Regards,"
},
"workflow": {
"to": "to_recipient@domain.com",
"cc": "cc_recipient@domain.com",
"bcc": "bcc_recipient@domain.com",
"subject": "Perceptive Content Workflow Item",
"preBody": "Below are links to the workflow items:",
"postBody": "Regards,"
}
}
capture
The capture section specifies the settings for the Titan capture module.
Options
| Attribute | Description |
|---|---|
| fileMaxFileSize | Specifies the maximum file size, in MB, that you can upload when capturing a document. If the value is left blank then there is no maximum size limit. |
| toolkitDowloadLocation | Specifies the URL of where to download the Perceptive Web Scan Toolkit installer if the toolkit is not detected. |
| postSaveScriptName | Specifies the post-save iScript file. |
| profileNamesToSourceMapping | Specifies mapping between a capture profile name and capture source identifier. |
| barcodeSeparatorMapping | Specifies one or more regular expression patterns for identifying separator pages. If any barcode on the page matches one of the patterns, the page is flagged as a separator sheet and not saved. A new group is created and any application plan document keys (field1–field5) set to Barcode are cleared. The groupSeparation setting must be configured. |
| barcodeDocSplitMode | Creates new group and clears any application plan document keys (field1–field5) that are set to Barcode when the page has no barcodes, and a previous page had a barcode. The groupSeparation setting must be configured. |
| groupSeparation | Specifies group separation options.
|
Example
"capture": {
"fileMaxFileSize": "5",
"toolkitDownloadLocation": "http://127.0,0,1:8090/cloud/PerceptiveWebCapture.zip",
"postSaveScriptName": "post-save-actions.js",
"profileNamesToSourceMapping": [
"/scan/i:scanner-source",
"/file/i:file-source"
],
"barcodeSeparatorMapping": [
"^T$|^3$|^HEADER.*"
],
"barcodeDocSplitMode": false,
"groupSeparation": {
"blankPage": true,
"eachScan": true,
"eachPage": false
}
}
outOfOffice
The outOfOffice section specifies whether to display the delegate user list in the Out of Office pane to the logged-on user when an out of the office event is being enabled.
| Attribute | Description |
|---|---|
| enableDelegate | Specifies whether to display the delegate user list. |
Example
"outOfOffice": {
"enableDelegate": true
}
captureIndexing
The captureIndexing section specifies the settings for the Capture and Indexing module.
defaultDocumentType
The defaultDocumentType section specifies the default document type to use when indexing if the document type is cleared.
Example
"defaultDocumentType": "Unindexed Document Type"
barcodeSeparatorMapping
The barcodeSeparatorMapping section specifies one or more regular expression patterns for identifying separator pages during batch capture. If any barcode on a page matches one of these patterns, the page is flagged as a separator sheet and not saved.
Example
"barcodeSeparatorMapping": [
"^T$|^3$|^HEADER.*"
]
dateFormat
The dateFormat property defines the default date format for the module. The value can be a raw Unicode pattern string or a JSON object that describes formatting options. The default is "MM/dd/yyyy".
String Value
When dateFormat is a string, it is passed as a raw Unicode pattern directly to the formatter. Patterns follow the Unicode CLDR standard and are case-sensitive, for example, M = month, m = minute; d = day of month, D = day of year. If dateFormat is not specified at all, the default format is "MM/dd/yyyy".
Example Pattern Strings
| Pattern | Example Output |
|---|---|
| "MM/dd/yyyy" | 07/04/2021 |
| "yyyy-M-d" | 2021-7-4 |
| "M/d/yyyy" | 7/4/2021 |
| "dd-MM-yyyy" | 04-07-2021 |
| "MM/dd/yyyy HH:mm" | 07/04/2021 13:21 |
| "yyyy-MM-dd'T'HH:mm:ss" | 2021-07-04T13:21:00 |
Example
"dateFormat": "MM/dd/yyyy HH:mm"
Object Value
When dateFormat is a JSON object, the following properties are available.
Options
| Attribute | Description |
|---|---|
| pattern | Specifies a custom Unicode date pattern string (same syntax as the string form above). Takes precedence over datePattern. |
| datePattern | Specifies a named date skeleton. Ignored if pattern is set. The default is "yMd".
The following lists the named datePattern values and an example en-US output:
|
| includeTime | Specifies whether to append a short time format, for example, 13:21, after the date. The default is false. |
Examples
Short date format (07/04/15):
"dateFormat": { "datePattern": "short" }
Medium date with time (Jul 4, 2015 13:21):
"dateFormat": { "datePattern": "medium", "includeTime": true }
Custom pattern with time (2015-07-04 13:21):
"dateFormat": { "pattern": "yyyy-MM-dd", "includeTime": true }
lookups
The lookups section specifies named lookup configurations referenced by other settings. Each key is a lookup name and each value is either an HTTP or iScript lookup, distinguished by the type field.
Common Base properties - Options
| Attribute | Description |
|---|---|
| type | Specifies the lookup type. Value is HTTP or SCRIPT. This value is required. |
| response | Specifies how to map the response. This value is required. See response. |
| timeout | Specifies the request timeout in milliseconds. |
| retryPolicy.maxRetries | Specifies the maximum number of retry attempts. |
| retryPolicy.delayMs | Specifies the delay between retries in milliseconds. |
| cacheTTL | Specifies the cache time-to-live in milliseconds. |
HTTP (type: "HTTP") - Options
| Attribute | Description |
|---|---|
| method | Specifies the HTTP method. Value is GET or POST. This value is required. |
| url | Specifies the URL template with {param} placeholders. This value is required. |
| authentication | Specifies whether to include OIDC authentication in the request. Value is true,
false, or omitted. When true or omitted, an Authorization:
Bearer header is sent using the current OIDC access token. When
false, no authorization header is sent. Defaults to true when
not specified. Note: Do not set to false
in production systems.
|
| urlParameters | Specifies URL path parameters, keyed by parameter name. See lookupParameter. |
| queryParameters | Specifies query string parameters, keyed by parameter name. See lookupParameter. |
| bodyParameters | Specifies request body parameters, keyed by parameter name. See lookupParameter. |
| headers | Specifies custom HTTP headers, keyed by header name. Values are strings. |
Example
"lookupOrderByOrderNumber": {
"type": "HTTP",
"url": "https://example.com/rs/hdb/orders/{orderNumber}",
"method": "GET",
"authentication": true,
"timeout": 5000,
"retryPolicy": {
"maxRetries": 2,
"delayMs": 1000
},
"cacheTTL": 60000,
"urlParameters": {
"orderNumber": {
"source": "orderNumber",
"type": "STRING"
}
},
"response": {
"recordStructure": {
"mrn": {
"path": "encounter.patient.mrn",
"type": "STRING"
},
"orderDate": {
"path": "orderDate",
"type": "DATE",
"format": "yyyy-MM-dd"
}
}
}
}
iScript (type: "SCRIPT") - Options
| Attribute | Description |
|---|---|
| scriptName | Specifies the iScript file path. For example, VendorLookup.js. This value is required. |
| inputParameters | Specifies input parameters, keyed by parameter name. Required. See lookupParameter. |
Example
"getVendorSearch": {
"type": "SCRIPT",
"scriptName": "VendorLookup.js",
"inputParameters": {
"lookupType": {
"source": "VendorSearch",
"type": "LITERAL"
},
"vendorName": {
"source": "vendorName",
"type": "STRING"
}
},
"response": {
"dataRoot": "results",
"recordStructure": {
"vendorName": {
"path": "vendorName",
"type": "STRING"
},
"creationDate": {
"path": "created",
"type": "DATE",
"format": "MM-dd-yyyy"
}
}
}
}
lookupParameter - Options
| Attribute | Description |
|---|---|
| source | Specifies the source field name or literal value. This value is required. |
| type | Specifies the parameter type. Value is STRING, NUMBER, DATE, BOOLEAN, or LITERAL. This value is required. |
| format | Specifies the date format string. Applicable for DATE type only. |
| isRequired | Specifies whether the parameter value must be present before the lookup executes. |
response - Options
| Attribute | Description |
|---|---|
| dataRoot | Specifies the root path to the data array in the response. For example, results. |
| recordStructure | Specifies field mapping from response to output, keyed by output field name. This value is required. See recordStructure. |
recordStructure - Options
| Attribute | Description |
|---|---|
| path | Specifies the path to the field in the response. This value is required. |
| type | Specifies the data type. value is STRING, NUMBER, DATE, or BOOLEAN. This value is required. |
| format | Specifies the date format string. Applicable for DATE type only. |
dependentPropertyUpdates
The dependentPropertyUpdates section specifies lookups triggered outside of application plans. The outer key is the trigger ("*" = on load or document type change, or a field name = on that field's change). The inner key is the target field. Each target supports two actions: setEditable and setListValues.
setEditable - Options
Runs a lookup; if the response at a given path matches a value, makes the target field editable.
| Attribute | Description |
|---|---|
| lookup | Specifies the lookup name (from top-level lookups). |
| parameters | Specifies optional parameter overrides. |
| responsePath | Specifies the path in the response to check. |
| valueMatch | Specifies the value to compare against. |
setListValues - Options
Runs a lookup; extracts values from the response for an autocomplete list.
| Attribute | Description |
|---|---|
| lookup | Specifies the lookup name (from top-level lookups). |
| parameters | Specifies optional parameter overrides. |
| responseMapping.value | Specifies the path to the raw value in the response. |
| responseMapping.name | Specifies the path to the display text. Defaults to the value path. |
Example
"dependentPropertyUpdates": {
"*": {
"field2": {
"setEditable": {
"lookup": "checkFieldEditable",
"responsePath": "isEditable",
"valueMatch": true
}
}
},
"field1": {
"field3": {
"setListValues": {
"lookup": "getDepartmentList",
"responseMapping": {
"value": "departmentId",
"name": "departmentName"
}
}
}
}
}
workflow
The workflow section specifies the options used in the workflow process.
Options
| Attribute | Description |
|---|---|
| openNextItem | Specifies the next action after submitting or routing a batch. If set to true, the next available batch in the queue is fetched automatically and opened for indexing. If not set or set to false, the current queue is displayed. The default is false. |
Example
"workflow": {
"openNextItem": true
}
workflowProcess
The workflowProcess section specifies a set of configurations for each workflow process that should appear in the Capture and Indexing module. Each entry is keyed by process name. Only processes configured in this section are displayed in the Capture and Indexing module.
Options
| Attribute | Description |
|---|---|
| enableValidation | Specifies whether to validate all documents when a batch loads. The default is true. |
| properties | Specifies the map of properties to display setting strings. See properties. |
| batchHeader | Specifies the batch header layout configuration. See batchHeader. |
Example
"workflowProcess": {
"CnI WF": {
"enableValidation": false,
"properties": {
"field1": "disabledAllowLookups",
"field5": "disabled"
},
"batchHeader": {
"batchNameLabel": "Order Batch",
"columnsPerRow": 4,
"propertyFields": [
{ "id": "workflowQueueName", "label": "Batch Step" },
{ "id": "batchContent", "label": "Batch Content" },
{ "id": "priority", "label": "Priority" },
{
"customPropertyName": "Batch Capture - Description",
"label": "Batch Description",
"isEditable": true
}
]
}
}
}
batchHeader
The batchHeader section configures the batch header area shown in the viewer. This functionality provides flexibility in defining the layout, content, and appearance of batch headers.
Options
| Attribute | Description |
|---|---|
| batchNameLabel | Specifies the label displayed for the batch name. The default is Batch Name. |
| columnsPerRow | Specifies the number of columns in the batch header grid. When more than six fields are configured in each row, fields are split to the next row. The default is 3. |
| propertyFields |
Specifies an array of fields displayed in the header. Each object is either a system property field or a custom property field. Default:
|
System Property Field
| Attribute | Description |
|---|---|
| id | Specifies the system field identifier. Valid id values:
|
| label | Specifies the display label. |
Custom Property Field
Custom Properties can be displayed in the batch header except Array and Composite. The editable fields are displayed based on the user permissions, ensuring secure and role-based access.
| Attribute | Description |
|---|---|
| customPropertyName | Specifies the name of the custom property. |
| label | Specifies the display label. |
| isEditable | Specifies whether the field is editable. |
workflowQueue
The workflowQueue section specifies queue-level configuration overrides, keyed by queue name. Can be specified at both super-queue and sub-queue levels. Configuration is applied based on the queue from which the batch is opened.
Options| Attribute | Description |
|---|---|
| enableValidation | Specifies if validation should be enabled. |
| properties | Specifies the map of properties to strings. |
Example
"workflowQueue": {
"1 QA": {
"enableValidation": true,
"properties": {
"field1": "enabled",
"field2": "disabled",
"field3": "hidden",
"field4": "disabledAllowLookups",
"type": "enabled",
"notes": "disabled",
"customProperties": {
"Date": "disabled",
"Flag": "enabled"
}
}
}
}
properties
The properties section controls visibility and editability of document property fields in the properties pane.
Options| Attribute | Description |
|---|---|
| field1 through field5 | Specifies the display setting for the document key. |
| type | Specifies the display setting for the document type field. |
| notes | Specifies the display setting for the notes field. |
| customProperties | Specifies a map of custom property names to display setting strings. |
All property values accept the following display settings:
| Value | Description |
|---|---|
| enabled | Field is visible and editable. |
| disabled | Field is visible but read-only. |
| hidden | Field is not shown. |
| disabledAllowLookups | Field is read-only but can be updated by lookup results. |
documentTypeList
The documentTypeList object contains one or more document type list objects. Each document type list object is keyed by the document type list name in Perceptive Content. In Capture and Indexing application, indexing rules can be defined for each document type via a document type list. For each class of document type, you can define an indexing application plan, database mappings, and one or more contexts. These contexts provide additional contextual metadata for aiding the user with indexing and validation.
Options
| Attribute | Description |
|---|---|
| applicationPlan | Specifies the manual application plan name that defines indexing scheme for a document type. |
Example
"documentTypeList": {
"Unindexed Documents": {
"applicationPlan": ""
},
"Manager Review Documents": {
"applicationPlan": "Manager Review"
}
}
originMapping
The originMapping section specifies regular expression filter rules matched to origin names. Only matching origins are displayed. If multiple regular expressions are defined, an origin displays when its name matches any of the regular expressions.
Example
"originMapping": ["^IC"]
captureProfileMapping
The captureProfileMapping section specifies regular expression rules for filtering capture profiles. Only capture profile names matching one of the regular expressions will be displayed in the application. Multiple regular expressions can be defined; a capture profile displays when its name matches any of the regular expressions.
Example
"captureProfileMapping": [ "/^CI.*/", "HIM" ]
originDrawerMapping
The originDrawerMapping section specifies global mappings for origin to drawer. It allows capturing to a specific drawer based on the selected origin. Each key is an origin name and each value is a drawer name string. The system uses this mapping if a match is not found under the application plan's originDrawerMapping. The origin can be a partial match.
Example
"originDrawerMapping": {
"North": "NorthDrawer",
"South": "SouthDrawer"
}
routeBatch
The routeBatch section defines the name of the iScript to route a batch after the capture process. The iScript expects the batchFolderId single input parameter and will then return four output parameters.
Options
| Attribute | Description |
|---|---|
| serverAction | Specifies the name of the iScript file to run. For example, CI_RouteBatchFolder.js. |
iScript Parameters
The following table describes the input and output parameters of the iScript.
| Parameter Name | Parameter Type |
|---|---|
| batchFolderId | Input |
| SUCCESS: <success message" or ERROR: <error message> | Output |
| workflowItemId | Output |
| workflowQueueId | Output |
| workflowQueueName | Output |
If routeBatch is not configured, batch capture will skip the route step and log an error.
Example
"routeBatch": {
"serverAction": "CI_RouteBatchFolder.js"
}
submitBatch
The submitBatch section specifies the iScript to be invoked after the batch is completely indexed and submitted for processing. The iScript expects three input parameters and returns two output parameters.
Options
| Attribute | Description |
|---|---|
| serverAction | Specifies the name of the iScript file to run. For example, CI_SubmitBatch.js. |
iScript Parameters
The following table describes the input and output parameters of the iScript.
| Parameter Name | Parameter Type |
|---|---|
| workflowItemId | Input |
| batchFolderId | Input |
| username | Input |
| status: SUCCESS or FAILURE | Output |
| error message | Output |
Example
"submitBatch": {
"serverAction": "CI_SubmitBatch.js"
}
batch
The batch section specifies options used in batch indexing.
| Attribute | Description |
|---|---|
| confirmPageDeletion | Specifies whether users should be prompted for confirmation when deleting a page. The default is false. |
Example
"batch": {
"confirmPageDeletion": true
}
applicationPlan
The applicationPlan section specifies per-application-plan overrides.
Options
| Attribute | Description |
|---|---|
| originDrawerMapping | Specifies plan-specific origin-to-drawer mapping. Each key is an origin name and each value is a drawer name string. |
| lookups | Specifies an array of lookups executed during batch capture. See captureLookup. |
| barcodeDocSplitMode | Specifies whether a page with no barcodes following a page with barcodes triggers a new document split. |
indexing
Under applicationPlan.indexing, keyed by application plan name, then by field ID. Each field maps to a fieldIndexingLookup.
Example
"applicationPlan": {
"capture": {
"HC Scan": {
"originDrawerMapping": {
"Medical Records": "HC Drawer",
"Lab Results": "Lab Drawer"
},
"barcodeDocSplitMode": true,
"lookups": [
{
"name": "lookupPatientByMRN",
"parameters": {
"mrn": {
"path": "field2",
"isRequired": true,
"type": "STRING"
}
},
"columns": [
{ "source": "patientName", "label": "Patient Name" },
{ "source": "dob", "label": "Date of Birth", "format": { "datePattern": "short" } }
],
"updates": {
"field3": {
"sourceType": "RECORD",
"source": "patientName"
},
"field4": {
"sourceType": "LITERAL",
"source": "Reviewed",
"default": "Pending"
}
}
}
]
}
},
"indexing": {
"Order Level Indexing": {
"field4": {
"lookup": "lookupOrderByOrderNumber",
"parameters": {
"orderNumber": {
"path": "field4",
"isRequired": true,
"type": "STRING"
}
},
"columns": [
{ "source": "orderNumber", "label": "Order #" },
{ "source": "customerName", "label": "Customer" },
{ "source": "amount", "label": "Amount", "format": { "minimumFractionDigits": 2, "maximumFractionDigits": 2 } }
],
"updates": {
"field1": {
"sourceType": "RECORD",
"source": "customerName"
},
"field5": {
"sourceType": "RECORD",
"source": "orderDate",
"format": "yyyy-MM-dd"
}
},
"advancedSearch": {
"searchByCustomer": {
"name": "Search by Customer",
"lookup": "lookupOrderByCustomer",
"searchParameters": [
{ "id": "customerName", "name": "Customer Name", "type": "STRING", "isRequired": true }
],
"columns": [
{ "source": "orderNumber", "label": "Order #" },
{ "source": "customerName", "label": "Customer" }
],
"updates": {
"field1": { "sourceType": "RECORD", "source": "customerName" },
"field4": { "sourceType": "RECORD", "source": "orderNumber" }
}
}
}
}
}
}
}
fieldIndexingLookup
Configures auto-lookups and advanced search for a specific field.
Options
| Attribute | Description |
|---|---|
| lookup | Specifies the auto-lookup name triggered on field value change. References a top-level lookups entry. This value is required. |
| columns | Specifies an array of column definitions for the results grid. See columns. |
| updates | Specifies field update mappings when a result is selected, keyed by field name. See updates. |
| parameters | Specifies parameters for the auto-lookup, keyed by parameter name. See captureLookupParameter. |
| advancedSearch | Specifies advanced search options, keyed by search name. See advancedSearch. |
captureLookup
Used within applicationPlan.capture.[planName].lookups.
Options
| Attribute | Description |
|---|---|
| name | Specifies the lookup name. References a top-level lookups entry. This value is required. |
| parameters | Specifies lookup parameters, keyed by parameter name. See captureLookupParameter. |
| columns | Specifies an array of result columns. See columns. |
| updates | Specifies field update mappings, keyed by field name. See updates. |
captureLookupParameter
The captureLookupParameter section defines parameters passed to a lookup, specifying which field provides the value and whether it is required for the lookup to execute.
Options
| Attribute | Description |
|---|---|
| path | Specifies the source field path. This value is required. |
| isRequired | Specifies whether the parameter is required. |
| type | Specifies the data type hint. |
columns
The columns section specifies the column definitions displayed in the lookup results grid. Each entry maps a field from the lookup response to a labeled column, with optional formatting.
Options
| Attribute | Description |
|---|---|
| source | Specifies the source field in the lookup result. This value is required. |
| label | Specifies the column header label. This value is required. |
| format | Specifies the format configuration (number, date, or boolean). See format. |
| width | Specifies the column width. |
updates
The updates section specifies how document fields are populated when a lookup result is selected. Each entry maps a target field to either a value from the result record or a static literal value.
Options
| Attribute | Description |
|---|---|
| sourceType | Specifies the source type. Required. Value is RECORD (field from the result record) or LITERAL (static value). |
| source | Specifies the field name (when RECORD) or static value (when LITERAL). This value is required. |
| default | Specifies the default value when the source is empty. |
| format | Specifies an optional format override, either a date pattern string or a format config object. |
advancedSearch
Within advancedSearch on a field indexing lookup, keyed by search name.
Options
| Attribute | Description |
|---|---|
| name | Specifies the dropdown display name. This value is required. |
| lookup | Specifies the lookup to execute. References a top-level lookups entry. Defaults to the key name in the map. |
| columns | Specifies an array of result grid columns. See columns. |
| updates | Specifies field updates on selection, keyed by field name. See updates. |
| parameters | Specifies auto-lookup parameters, keyed by parameter name. See captureLookupParameter. |
| searchParameters | Specifies an array of dynamic user-editable parameters. See searchParameters. |
searchParameters
The searchParameters section specifies the user-editable input fields displayed in the advanced search dialog. Each parameter maps to a lookup parameter and can optionally be pre-populated from a document field.
Options
| Attribute | Description |
|---|---|
| id | Specifies the parameter name that maps to the lookup parameter. This value is required. |
| name | Specifies the display name in the UI. This value is required. |
| type | Specifies the data type. Value is DATE, NUMBER, or STRING. This value is required. |
| source | Specifies the field path to pre-populate the value from. |
| isRequired | Specifies whether the parameter is required to execute the lookup. |
format
Number Format
The number format configuration controls how numeric values are displayed in lookup result columns.
Options
| Attribute | Description |
|---|---|
| style | Specifies the number style. Value is decimal or percentage. The default is decimal. |
| minimumIntegerDigits | Specifies the minimum number of integer digits. The default is 1. |
| minimumFractionDigits | Specifies the minimum number of fraction digits. The default is 0. |
| maximumFractionDigits | Specifies the maximum number of fraction digits. The default is 3 or the value of minimumFractionDigits, whichever is greater. |
| minimumSignificantDigits | Specifies the minimum number of significant digits. Overrides integer/fraction settings when both min and max are set. |
| maximumSignificantDigits | Specifies the maximum number of significant digits. |
| round | Specifies the rounding strategy. Value is ceil, floor, round, or truncate. |
| useGrouping | Specifies whether to include digit grouping separators. For example, commas. The default is false. |
Date Format
The date format configuration controls how date values are displayed in lookup result columns.
Options
| Attribute | Description |
|---|---|
| pattern | Specifies a custom Unicode date pattern string. |
| datePattern | Specifies a named date skeleton. Value is short, medium, long, full, or yMd. The default is yMd. |
| includeTime | Specifies whether to append a short time format to the date. The default is false. |
Boolean Format
The boolean format configuration controls how boolean values are displayed in lookup result columns.
Options
| Attribute | Description |
|---|---|
| trueValue | Specifies the display text for true values. The default is Yes. |
| falseValue | Specifies the display text for false values. The default is No. |