API Processor Specifications
Alfresco Job Run History Nodes
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
Alfresco Property Mapping Nodes
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
jsonObjectField | Properties Query JSON Object | String |
authConnField | Alfresco Auth Connector | String |
failMultiOrEmptyField | Fail on Multiple or Empty Return? | String |
Attach Content - S3
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
auth_con_field | Select an Authentication Connector | String |
ac_aws_base_path | Base folder path: | String |
ac_aws_bucket_name | S3 Bucket: | String |
ac_sim_key_field | Key Field: | String |
Attach Content - File System
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
binary_path | Document field or expression for absolute path to binaries: | String |
Attach Content - External Repositories
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
metadataStoreConnId | Content Service Connection | String |
metadataObjectIdFieldName | Field Name That References Object Id | String |
metadataInclude | Include MetaData | Boolean |
action | Action | String |
Attach Content - FTP
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
ftp_user_name | User Name: | String |
ftp_password | Password: | String |
ftp_host | Host: | String |
ftp_port | Server Port: | LONG |
ftp_path_expression | Path Expression: | String |
ftp_use_ftps | Use FTPS: | Boolean |
ftp_is_implicit | Is Implicit: | Boolean |
ftp_encrypt_data | Encrypt Data: | Boolean |
ftp_eps_with_ipv4 | EPSV With IPV4: | Boolean |
ftp_trace_logging | Log FTP Calls: | Boolean |
AWS Image Rekognition
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
threshold_field | Minimum Threshold | DOUBLE |
auth_con_field | Select an Authentication Connector | String |
number_labels_field | Max number of labels | INTEGER |
AWS Textract
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
auth_con_field | Select an Authentication Connector | String |
Basic JDBC Job
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
username | User Name: | String |
password | Password: | String |
jdbc_driver | Database Driver Class | String |
jdbc_jdbc_url | JDBC Url | String |
jdbc_id_field | ID Field | String |
jdbc_query | Query | String |
Buffer Content to File System
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
timeout | File staging timeout in milliseconds | LONG |
CMIS ACL Modification
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
user | User Name: | String |
pass | Password: | String |
url | Connection URL: | String |
repository | Repository ID: | String |
ignore_names | Pipe (|) delimited list of principals to ignore from each document | String |
remove_names | Pipe (|) delimited list of principals to remove from each document | String |
Add_names | Comma delimited list of principals to add to each document | String |
add_perm | Permission to add to principals | String |
Convert Array Value To String
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
delimiter | Delimiter | String |
property | Property Name | String |
Convert String to Boolean
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
documentField | Document Field | String |
fieldValue | Expected Value | String |
caseSensitive | Case Sensitive | String |
Convert To UTC
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
utc_fields | Date Fields to Convert | String |
tz_offset | TimeZone Offset Integer (ie -5 for GMT -05:00). | String |
definedtf | Define Date Time Format | Boolean |
date_time_format | Date Time Format | String |
Date-Based Folder Path
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
jt_field | Repository Document Field | String |
jt_datefolderpath_pattern | Pattern | String |
Duplicate Detection
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
field_to_compare | Field to Compare | String |
scope | Duplication Check Scope | String |
action | Action | String |
Generic ACL Mapper
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
ACLMapperTask_process_files | Process Files | Boolean |
ACLMapperTask_process_folders | Process Folders | Boolean |
ACLMapperTask_rules_field | Mappings Rules | String |
ACLMapperTask_auhtority_cleanup | Authority Cleanup (removes the configured comma delimited strings from authorities) | String |
ACLMapperJobTask_extra_perms | Enable parsing for multiple permissions to be assigned to an authority after mapping? (Surround target perm with brackets []) | Boolean |
Field Lookup
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
jt_delimiter | Delimiter | String |
jt_property | Property Field | String |
jt_other_name | Property Name | String |
jt_folderpath_pattern | Values | String |
jt_exact_match | Look for an exact match | String |
jt_new_field | Add/Override Different/New Field instead? | String |
jt_new_field_name | New Field Name | String |
Filesystem ACL Extraction
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
fsacl_os | File System Operating System | String |
fsacl_ad | Append _DENY to Deny ACL Type Permissions? | Boolean |
Filename Cleanse
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
fcjt_regex | Regex to Match | String |
fcjt_replace | Replacement Text | String |
FileNet ACL Modification
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
auth_conn_id | Authentication Connector ID | String |
ignore_names | Pipe (|) delimited list of principals to change from each document | String |
add_perm | Permission to change on principals listed | String |
Add_names | Pipe (|) delimited list of principals to add to each document | String |
add_perm | Permission to add to new principals | String |
remove_names | Pipe (|) delimited list of principals to remove from each document | String |
Filter Expression
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
filterExpression | Filter Expression | String |
Folder Path Cleanse
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
fpcjt_regex | Regex to Match | String |
fpcjt_replace | Replacement Text | String |
Generate Thumbnail
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
tn_resize_width | Resize Width | String |
tn_failure_action | Action | String |
tn_file_types | Types of Thumbnail | String |
Google Vision Image Labels
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
auth_con_field | Select an Authentication Connector | String |
number_labels_field | Max number of labels | INTEGER |
Google Vision Text Extraction
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
auth_con_field | Select an Authentication Connector | String |
HMAC-256 Generator
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
hmacKey | Key | String |
hmacMessage | Message | String |
hmacResult | Result field | String |
Hash Value Generator
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
hash_algorithm | Algorithm | String |
file_limit | File Size Limit for Hash Generation | Boolean |
file_size | Do not generate hash for file size exceeding this size limit (megabyte) | INTEGER |
action | Action | String |
HTML to PDF
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
htpjt_xhtml_xsl | XHTML Stylesheet | String |
HTTP
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
username | User Name: | String |
password | Password: | String |
action_url_field | Action URL | String |
action_type_field | POST or GET | String |
requestParams | Request parameters in the form key1=value1&key2=value2. Values can be expression language | String |
sendBody | Send body with request | Boolean |
post_field | Request Body in JSON format. Can include expression language values. | String |
failAction | Action to take if document doesn't return success status codes (OK) | String |
timeout | Client timeout in milliseconds | LONG |
IBM Watson Natural Language Classification
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
iamkey | The IAM API Key for IBM Cloud. | String |
classifier | The classifier id. | String |
procfield | Field to process. If left blank, the task will search for the field 'content' | String |
addfield | Field to store the Watson response. If left blank, the default name will be 'nlc'. | String |
extprocess | Comma delimited list of file extensions to process or leave blank to process all. | String |
Index User Groups
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
user_groups | Select User Groups to index | String |
users | Select Users to Index | String |
JavaScript Processing
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
field_javascript | JavaScript Code | String |
Join Mongo Document Metadata
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
document_field | The fields you're checking for on the mongo document (comma separated) | String |
repo_field | The fields you're checking for on the repository document | String |
add_fields | Comma delimited list of fields to add to the repository documents, should the fields match | String |
sort_field | Mongo field to be used for sorting followed bya comma and sort order | String |
mongo_url | The MongoDB Url | String |
mongo_port | The Mongo Port | String |
mongo_database | The mongo database to query | String |
mongo_collection | The mongo collection to query | String |
mongo_user | The mongo user, leave blank if no authentication is set | String |
mongo_pass | The mongo password, leave blank if no authentication is set | String |
Lookup Destination Id From Job Run History
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
Metadata Extraction - EML
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
Metadata Extraction - Path
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
path_field | Path Field | String |
path_rules | Path Rules | String |
Metadata from Properties File - Filesystem
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
property_file_name | Properties File Name | String |
skip_no_property_file | Skip files with no properties file found in hierarchy | Boolean |
Output Metadata As JSON
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
output_field | Output Path | String |
Obsolete Detection
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
beforeWhen | Filter on which date field? | String |
before | Before | String |
customDate | Custom Date | String |
action | Action | String |
OpenAI Chat Completion
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
open_ai_server | Server | String |
open_ai_api_key | API Key | String |
open_ai_model | Model | String |
open_ai_system | System Prompt | String |
open_ai_user | User Prompt | String |
open_ai_json | JSON Format | Boolean |
open_ai_timeout | Timeout | INTEGER |
open_ai_result | Result Field | String |
OpenAI Embedding
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
open_ai_server | Server | String |
open_ai_api_key | API Key | String |
open_ai_model | Model | String |
open_ai_timeout | Timeout | INTEGER |
open_ai_input | Input | String |
open_ai_result | Result Field | String |
Override Filename
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
jt_filename_pattern | Pattern | String |
jt_deep_change | Deep Change | Boolean |
Override Folder Path
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
jt_folderpath_pattern | Pattern | String |
Pause
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
pause_task | Pause in seconds | INTEGER |
PII Detection
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
pii_field_to_mark | Field to Mark | String |
breakup_list | Break up PII data into individual fields with a prefix. (Ex. prefix_CreditCard) | Boolean |
field_prefix | Prefix for pii fields. | String |
pii_what_to_check | Fields to Check | String |
attach_content | Attach extracted text as metadata. | Boolean |
content_field_name | Field name for extracted text content | String |
Property XML Parser
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
field_to_parse | Field to Parse (Enter BINARY for content field) | String |
Remove Empty Fields
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
Remove Mappings
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
source_fields | Source Fields | String |
Remove Renditions Matching Binary Mime Types
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
removeRenditionsMimeTypeTask | READONLY |
Rename File On Duplicate File Path
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
scope | Duplication Check Scope | String |
case | Case Sensitive? | String |
e_field | Equal Fields | String |
ne_field | Not-Equal Fields | String |
jt_filename_rename_pattern | Pattern | String |
Replace Metadata
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
mrjt_field | Source Metadata Field | String |
mrjt_regex | Regex to Match | String |
mrjt_replace | Replacement Text | String |
Skip On Empty Field
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
source_fields | Source Fields | String |
Skip Blank Filename
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
Tesseract Text Extraction
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
tesseract_field | Metadata field for extracted text | String |
tesseract_engine_mode | Engine Mode | String |
tesseract_page_seg_mode | Page Segmentation Mode | String |
tesseract_lang | Tesseract Language Code (ISO 639-1/T) | String |
tesseract_use_hocr | Use HOCR? | Boolean |
Text Cleanup
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
input_field | Input Field | String |
output_field | Output field | String |
replace_latin_closest | Replace with closest Latin character | Boolean |
replace_filename_incompatible | Replace filename incompatible characters | Boolean |
filename_incompatible_replacement_text | Replace filename incompatible characters with | String |
replace_whitespace | Replace whitespace characters | Boolean |
whitespace_replacement_text | Replace whitespace characters with | String |
replace_non_printable | Replace non-printable characters | Boolean |
non_printable_replacement_text | Replace non-printable characters with | String |
Text/HTML to EML
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
tofield | The field that contains the 'To' line | String |
fromfield | The field that contains the 'From' line | String |
subfield | The field that contains the 'Subject' line | String |
dontusecreate | Do not use created date as 'Sent' date | Boolean |
sentfield | The field that contains the 'Sent' date | String |
allfields | Adds all metadata fields as headers | Boolean |
extras | If not adding all fields, list any extra fields you would like to add as headers | String |
Text to PDF
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
Tika Text Extraction
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
tejt_field_to_mark | Tika Content Field | String |
tejt_max_length | Max Content length (B) | LONG |
tejt_etp | File Extensions to Extract | String |
tejt_fail_on_error | Fail Document on Extraction Error | Boolean |
tejt_rm_bin | Remove content after extraction | Boolean |
Trivial Detection
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
checkBelow | Filter on document's below a specified size | Boolean |
below | Filter files below size (Bytes) | INTEGER |
checkAbove | Filter on document's above a specified size | Boolean |
above | Filter files above size (Bytes) | INTEGER |
checkExt | Filter on file extension | Boolean |
exts | List extensions (comma separated) that you would like ignored (sqlite,dmg,bak,exe) | String |
checkType | Filter on document type | Boolean |
types | List document types (comma separated) that you would like ignored (doctype1,doctype2) | String |
action | Action | String |
Two Way Sync
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
two_way_ismaster | Check Last Run | Boolean |
two_way_compare_hashes | Compare MD5 Checksums | Boolean |
two_way_other_jobid | Job Id of Other Job | String |
URL Decoder
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
input_field | Input Field | String |
output_field | Output field | String |
process_plus | Replace '+' with '%20' | Boolean |
URL Encoder
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
input_field | Input Field | String |
output_field | Output field | String |
process_plus | Replace '+' with '%20' | Boolean |
Unzip
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
staging_location | File staging location. If blank java.io.tmpdir will be used | String |
skipZip | Skip the zip file after unzip. | Boolean |
Watson Image Analysis
Key |
Display Name |
Type |
---|---|---|
use_condition | Check a condition before executing this task. | Boolean |
task_condition | Condition | String |
task_stop_proc | Stop Processing | Boolean |
iamkey | The IAM API Key for IBM Cloud. | String |
collectionId | Collection Id. If left blank, 3Sixty will create one. | String |
collectionName | Collection Name. Name of the collection to create. If left blank, will be new-training-collection with the date. | String |
trainingMode | task.watsonTain | Boolean |
trainingJson | The training json in the format {"dog":[25,35,105,215]}. Array order is top, left, width, height with object type as the key. | String |
urlField | Field that contains the image urls. If left blank the content will be used. | String |
addfield | Field to store the Watson response. If left blank, the default name will be 'nlc'. | String |