Process

projectId Project objectid

The objectid of the project that owns the process.

accountId Account objectid

The objectid of the account that owns the process.

description Description string

Short text that briefly explains what the process is doing. The description is generated automatically.

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

secondaryAction Secondary Action options

DEPRECATED. Will remove from documentation.

Requires a Non-Null Value	Yes
Allowed Values	, DATA_CONDITION, PRINT
Default Value

flowPath Flow Path string

DEPRECATED. A materialized index of the data flow.

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

actionPath Action Path string

DEPRECATED.

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

parentProcess Parent Process objectid

The process that preceeds the current process in the data flow.

setChildProcess Set Child Process objectid

listingPriority Listing Priority float

A numeric value generated by the application that determines the order in which operations are executed. Generally, IF runs first, then THEN operators, then ELSE operators and lastly FINALLY operators.

Requires a Non-Null Value	Yes
Default Value	0

ignoreWarnings Ignore System Warnings boolean

Requires a Non-Null Value	Yes
Default Value	No

listen_documentation Documentation HTML string

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	Yes
Converts to Lowercase	No
Converts to Uppercase	No

listen_UrlKey guid

Random guid generated by the system used to help identify requests in system logs

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No
GUID Pattern	xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx

listen_IpWhitelist string

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

listen_method Method options

The http request method for which the listening endpoint will accept requests.

GET	Commonly used when retrieving information.
POST	Commonly used when sending data to the server.
PUT	Commonly used to completely replace an existing record.
PATCH	Commonly used to partially replace an existing record.
DELETE	Commonly used to delete an existing record.
COPY	Commonly used to create duplicate of an existing record
HEAD	Similar to a GET request, but the response only contains a header.
OPTIONS	Commonly used when describing the communication options of the endpoint.
LINK	Commonly used to establish a data reference between records.
UNLINK	Commonly used to remove a data reference between records.
PURGE	Commonly used to delete cached resources.
LOCK	Commonly used to restrict access to a specified record.
UNLOCK	Commonly used unrestrict access to a specified record.
PROPFIND	Commonly used when retrieving properties from a web resource.
VIEW

The reference to the authentication protocol used to restrict access to the listener to only those who provide the required credentials. Add authorization records to your project. Please see Project Authorizations for more info.

GET

listen_auth Primary Authentication objectid

Requires a Non-Null Value

listen_customPath Endpoint URL Path string

The url path where your endpoint is listening on your Instalink account.

Requires a Non-Null Value	No
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

listen_customPathUnique string

An index that ensures that every path is unique on your account. Automatically set.

Requires a Non-Null Value	No
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

listen_acceptFiles Accept Files boolean

When enabled, the endpoint will accept file uploads.

Requires a Non-Null Value	Yes
Default Value	No

listen_recordIdentifierTemplate Record Identifier Template string

A searchable index of your incoming requests to the endpoint. This is important to set to make it easier to read your service logs. Accepts the templating syntax.

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

listen_useNamespace Use Namespace for Input boolean

When enabled, all data sent to the listener will be assigned to the key as defined in listen_namespace. By default the data is added to the root process data and is accessible by whatever keys may be provided in the request body. You should enable this if the request body is not expected to be an object with keys.

Requires a Non-Null Value	Yes
Default Value	No

listen_namespace Input Namespace string

The key that will contain the data of the inbound request body.

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

listen_countRecordsPath Count Items Path string

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

listen_indexKeysPath Collect Index Keys Path string

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

listen_enableCors Enable CORS boolean

Requires a Non-Null Value	Yes
Default Value	No

listen_corsAllowOrigin CORS Allow Origin string

Requires a Non-Null Value	Yes
Default Value	"*"
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

listen_corsAllowMethods CORS Allow Methods string

Requires a Non-Null Value	Yes
Default Value	"*"
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

listen_corsAllowHeaders CORS Allow Headers string

Requires a Non-Null Value	Yes
Default Value	"*"
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

listen_corsExposeHeaders CORS Expose Headers string

Requires a Non-Null Value	Yes
Default Value	"*"
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

listen_corsMaxAge CORS Max Age Seconds integer

Requires a Non-Null Value	Yes
Default Value	5

listen_corsAllowCredentials CORS Allow Credentials boolean

Requires a Non-Null Value	Yes
Default Value	No

schedule_type Schedule Type options

When to run the scheduled process.

FROM_NOW	The action will run after a specified delay from the current time.
SPECIFIC_TIME	The action will run at the absolute time and date specified.

FROM_NOW

schedule_at Scheduled Time datetime

The specific time and date to run the subsequent actions.

Requires a Non-Null Value	Yes
Default Value	__auto__

schedule_delayQty Delay Quantity integer

The amount of time to wait to run the subsequent actions. Factored by the delay units.

Requires a Non-Null Value	Yes
Default Value	0

schedule_delayUnits Delay Units options

The time units by which the delay quantity is factored.

s	Delay by seconds.
m	Delay by minutes.
h	Delay by hours.
d	Delay by days.

schedule_cancellable Scheduled Process Is Cancellable boolean

When enabled, any scheduled previously scheduled action that has been previously scheduled may be cancelled by a Cancel Scheduled Action process that has a matching cancellation key.

Requires a Non-Null Value	Yes
Default Value	No

schedule_cancellationKey Cancellation Key Template string

The key used to identify previously scheduled processes so that they may be cancelled. Accepts template syntax.

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

schedule_identifier Identifier Template string

Template used to help identify the scheduled process in the event logs. Please set this to make your logs easier to interpret.

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

unschedule_cancellationKey Cancellation Key Template string

Will cancel all pending scheduled actions that have a matching cancellation key. Accepts template syntax.

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

response_successCode Code string

Response code used when successfully responding to inbound requests

Requires a Non-Null Value	Yes
Default Value	"200"
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

response_successMessage Log Identifier string

Message sent to clients when responding that the action was successful. Also used as the identifier when recording the success log. Accepts template syntax. Success logs are searchable by this value. Please set this to make your success logs easier to interpret.

Requires a Non-Null Value	Yes
Default Value	"Transaction Success"
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

response_successFormat Format options

The syntax used to format your response body.

application/json	JSON (Javascript Object Notation). Common format for communication between computer systems.
text/plain	The raw unparsed data in a text document
text/xml	Uses XML syntax and structure. Common format for communication between computer systems.
text/html	Response is in HTML and is designed to be interpreted by a person viewing the results in a webpage
text/csv	Comma delimited flat file. Use this when importing the data into spreadsheet software.

application/json

response_errorCode Code string

Response code used when an error was encountered while processing an inbound requests

Requires a Non-Null Value	Yes
Default Value	"400"
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

response_errorMessage Log Identifier string

Message sent to clients when responding that an error was encountered. Also used as the identifier when recording the error log. Accepts template syntax. Error logs are searchable by this value. Please set this to make your error logs easier to interpret.

Requires a Non-Null Value	Yes
Default Value	"Transaction Failed"
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

response_errorFormat Format options

Requires a Non-Null Value	Yes
Allowed Values	application/json, text/plain, text/xml, text/html, text/csv
Default Value	application/json

response_errorSeverity Error Severity options

Sets priority to error logs. Useful for categorizing and triaging error logs. Does not affect the response to the client.

INFO	A common occurrence. Use this for errors that are expected and occur during normal operation and do not usually require further review.
WARNING	Use this for errors that are expected, occur during normal operation, and likely need further review.
ERROR	An error has occurred. Use this for errors that are not expected to occur during normal operation. These should always be reviewed.
CRITICAL	A serious error has occurred. Use this for errors that indicate systemic issues which require immediate intervention. This may include unresponsive remote services or APIs.

ERROR

response_logError Log as System Error boolean

Enable to record the error log so that it may be reviewed in the admin panel.

Requires a Non-Null Value	Yes
Default Value	Yes

response_logSuccess Log as System Success boolean

Enable to record the success log so that it may be reviewed in the admin panel.

Requires a Non-Null Value	Yes
Default Value	Yes

response_errorSendEmail Send Email? boolean

Enable to send an email message to an administrator when the error is encountered. It is recommended that this feature be used only for ERROR or CRITICAL level error messages to ensure that your inbox is not inundated with unnecessary messages.

Requires a Non-Null Value	Yes
Default Value	No

response_errorSendEmailTo Send Email To email

The email address that will receive the error log notification.

Requires a Non-Null Value	No
Default Value
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	Yes
Converts to Uppercase	No

response_errorTopic Error Topic objectid

response_successFormatCollectionKey Output Data Key string

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

response_errorFormatCollectionKey Output Data Key string

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

response_neutralCode Code string

Requires a Non-Null Value	Yes
Default Value	"200"
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

response_neutralMessage Log Identifier string

Requires a Non-Null Value	Yes
Default Value	"Entry"
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

response_neutralFormat Format options

application/json	JSON (Javascript Object Notation). Common format for communication between computer systems.
text/plain	The raw unparsed data in a text document
text/xml	Uses XML syntax and structure. Common format for communication between computer systems.
text/html	Response is in HTML and is designed to be interpreted by a person viewing the results in a webpage
text/csv	Comma delimited flat file. Use this when importing the data into spreadsheet software.

How Google Cloud Print will format the data that is sent to the printer. Generally use "url" to print a webpage directly from the internet, "application/pdf" to print a document, and "image/jpeg" or "image/png" to print an image. Generally "application/pdf" is appropriate for most use cases including line printers such as Zebras. Please see https://developers.google.com/cloud-print/docs/appInterfaces#parameters for more information.

application/json

response_neutralFormatCollectionKey Output Data Key string

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

response_useItemIdentifier Use Item Identifier boolean

Requires a Non-Null Value	Yes
Default Value	No

response_itemIdentifier Item Identifier string

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

response_template Template string

The template used as the response body data. Accepts template syntax.

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	Yes
Converts to Lowercase	No
Converts to Uppercase	No

response_useTemplate Use Template boolean

Enable to use the template as the response data instead of the default preformatted field data.

Requires a Non-Null Value	Yes
Default Value	No

google_refreshToken string

Token used to renew offline access to Google services

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

google_expirationDate datetime

Requires a Non-Null Value	Yes
Default Value	__auto__

google_accessToken string

Token used to provision offline access to Google services.

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

google_printerId string

The printer that this print job will be sent to. Supply the identification guid of a printer that has been registered on your Google Cloud Print account.

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

google_printJobName string

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

google_printContentType string

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

google_printCopies string

The number of copies of the document that will be printed

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

google_transferEncoding string

An optional setting that may be useful in certain situations. For example set this property to "base64" to print base64 encoded images or documents.

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

sendurl_url Send to Endpoint string

The URL that the outbound request will be sent to.

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

sendurl_method Method options

The HTTP header method used in the outbound request

GET	Commonly used when retrieving information.
POST	Commonly used when sending data to the server.
PUT	Commonly used to completely replace an existing record.
PATCH	Commonly used to partially replace an existing record.
DELETE	Commonly used to delete an existing record.
HEAD	Similar to a GET request, but the response only contains a header.
OPTIONS	Commonly used when describing the communication options of the endpoint.

GET

sendurl_format Send Format options

The outbound request record's content type which is to inform the remote service what type of data is being sent.

	No content type header will be set
application/x-www-form-urlencoded	For sending simple form submission data
application/json	Data will be sent using JSON formatting.
text/plain	Text data will be sent as is with no formatting.
text/xml	Data will be sent formatted as an XML document.
text/html	Data will be sent formatted as an HTML document.
text/csv	Data will be sent as a comma delimited flat file.

sendurl_bodyFormat Response Format options

Specifies to the remote service how their response is formatted.

application/json	JSON (Javascript Object Notation). Common format for communication between computer systems.
text/plain	The raw unparsed data in a text document
text/xml	Uses XML syntax and structure. Common format for communication between computer systems.
text/html	Response is in HTML and is designed to be interpreted by a person viewing the results in a webpage
text/csv	Comma delimited flat file. Use this when importing the data into spreadsheet software.

application/json

sendurl_authType Authorization options

The authentication protocol used to access the remote service.

	No formal authentication protocol will be used.
Basic	Will use traditional basic authentication.
OAuth	Will use Oauth 1.0 authentication. Oftened used for intra-network communications.
InstalinkToken	Will use Instalink's built-in authentication method. Useful for authenticating calls between various Instalink hosted endpoints.
AmazonV4	Amazon Signature Version 4 authentication. Used when accessing AWS services.

sendurl_authBasicUsername Username string

The username that is used for basic authentication

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

sendurl_authBasicPassword Password string

The password that is used for basic authentication

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

sendurl_authOauth1ConsumerKey Consumer Key string

The consumer key that the remote service has provided to use when accessing their service.

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

sendurl_authOauth1ConsumerSecret Consumer Secret string

The consumer secret that the remote service has provided to use when accessing their service.

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

sendurl_authOauth1TokenKey Token string

The token key that the remote service has provided to use when accessing their service.

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

sendurl_authOauth1TokenSecret Token Secret string

The token secret that the remote service has provided to use when accessing their service.

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

sendurl_authOauth1SignatureMethod Signature Method options

The hashing algorithm to use to package the authentication request. Consult your remote service provider for information about which signature method(s) they accept.

Requires a Non-Null Value	Yes
Allowed Values	HMAC-SHA1, HMAC-SHA256, PLAINTEXT
Default Value	HMAC-SHA1

sendurl_authOauth1Version OAuth Version string

Requires a Non-Null Value	Yes
Default Value	"1.0"
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

sendurl_authOauth1Realm Realm (optional) string

Optional field. The value of this property may differ depending on how your remote service provider implements Oauth 1.0. Some remote services require this property to be set. Please consult your remote service provider for more information about this property.

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

sendurl_authInstalinkToken Token Value string

The Instalink provisioned token that has been provisioned access to the remote resource.

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

sendurl_authAmz4SecretAccessKey AWS Secret Access Key string

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

sendurl_authAmz4AccessKeyId AWS Access Key Id string

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

sendurl_authAmz4SessionToken AWS Session Token string

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

sendurl_authAmz4Region AWS Region string

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

sendurl_authAmz4Service AWS Service string

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

sendurl_template Template string

The template used to format the data that is to be sent to the remote resource. Accepts template syntax.

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	Yes
Converts to Lowercase	No
Converts to Uppercase	No

sendurl_useTemplate Use Template boolean

When enabled the outbound request data will use the provided template instead of preformatted field values.

Requires a Non-Null Value	Yes
Default Value	No

sendurl_recordIdentifierTemplate Record Identifier Template string

Label that helps to identify outbound call records in the admin panel. Please set this to make your logs easier to navigate and search. Accepts template syntax.

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

sendurl_useNamespace Use Namespace for Output boolean

When enabled, all data recieved from the outbound request will be assigned to the key as defined in sendurl_namespace. By default the data is added to the root process data and is accessible by whatever keys may be provided in the request response. You should enable this if the request response is not expected to be an object with keys.

Requires a Non-Null Value	Yes
Default Value	No

sendurl_namespace Output Namespace string

The key that will contain the data of the outbound request response.

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

sendurl_sendDataInBody Send Data In Body boolean

Force the provided data to be sent in the body instead of the query string in a GET or HEAD HTTP request.

Requires a Non-Null Value	Yes
Default Value	No

sendurl_csvHasHeader Expect a CSV Header? boolean

Requires a Non-Null Value	Yes
Default Value	Yes

sendurl_doTimeout Set Request Timeout boolean

Requires a Non-Null Value	Yes
Default Value	No

sendurl_timeout Timeout Seconds integer

Requires a Non-Null Value	Yes
Default Value	600

sendurl_gzip Enable GZIP Response boolean

Requires a Non-Null Value	Yes
Default Value	No

redirecturl_url Redirect to Endpoint string

URL to redirect an inbound request to. The client will recieve a response from this URL.

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

iterate_key Key to Iterate On string

A reference to the list object in the process data for which subsequent actions will be executed for each record in the list.

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

iterate_setKey Key to Apply Each Value To string

The process data property that will contain the individual record in subsequent actions.

For example, if you had iterate_key pointed to a list named "labels" where the value is ["a", "b", "c"] and the iterate_setKey set to "letter". This would result in the first iteration containing the property letter="a", the second iteration would contain the property letter="b", and the third letter="c".

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

iterate_delay Delay Each By (Seconds) float

Amount of time in seconds to wait after the previous iteration has completed before beginning the next iteration.

Requires a Non-Null Value	Yes
Default Value	0

iterate_isChunked Segment Items? boolean

When enabled the iterator will break the input list object into smaller list of objects of equal length which may be accessed in subsequent actions.

Requires a Non-Null Value	Yes
Default Value	No

iterate_chunkSize Segment Size integer

How many records will be included in each iteration action.

Requires a Non-Null Value	Yes
Default Value	1

iterate_outKey Key for Returned Data string

The property that will contain all logged success records that occurred during the iteration. This property is accessible in the subsequent FINALLY branch.

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

iterate_errorOutKey Key for Returned Errors string

The property that will contain all logged error records that occurred during the iteration. This property is accessible in the subsequent FINALLY branch.

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

cron_timeDef Cron Schedule options

Preselected cron intervals that are available for convenience.

0 * * * * *	Action will run every minute
0 0 * * * *	Action will run every hour
0 0 0 * * *	Action will run every day at midnight UTC
0 0 12 * * *	Action will run every day at Noon UTC
	Use a custom cron pattern.

0 * * * * *

cron_timePattern Cron Pattern string

Enter a unix cron time pattern here. Set the Cron Schedule to custom to use this pattern.

Requires a Non-Null Value	Yes
Default Value	"0 * * * * *"
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

cron_timeZone Cron Timezone options

Requires a Non-Null Value	Yes
Allowed Values	Africa/Abidjan, Africa/Accra, Africa/Addis_Ababa, Africa/Algiers, Africa/Asmara, Africa/Asmera, Africa/Bamako, Africa/Bangui, Africa/Banjul, Africa/Bissau, Africa/Blantyre, Africa/Brazzaville, Africa/Bujumbura, Africa/Cairo, Africa/Casablanca, Africa/Ceuta, Africa/Conakry, Africa/Dakar, Africa/Dar_es_Salaam, Africa/Djibouti, Africa/Douala, Africa/El_Aaiun, Africa/Freetown, Africa/Gaborone, Africa/Harare, Africa/Johannesburg, Africa/Juba, Africa/Kampala, Africa/Khartoum, Africa/Kigali, Africa/Kinshasa, Africa/Lagos, Africa/Libreville, Africa/Lome, Africa/Luanda, Africa/Lubumbashi, Africa/Lusaka, Africa/Malabo, Africa/Maputo, Africa/Maseru, Africa/Mbabane, Africa/Mogadishu, Africa/Monrovia, Africa/Nairobi, Africa/Ndjamena, Africa/Niamey, Africa/Nouakchott, Africa/Ouagadougou, Africa/Porto-Novo, Africa/Sao_Tome, Africa/Timbuktu, Africa/Tripoli, Africa/Tunis, Africa/Windhoek, America/Adak, America/Anchorage, America/Anguilla, America/Antigua, America/Araguaina, America/Argentina/Buenos_Aires, America/Argentina/Catamarca, America/Argentina/ComodRivadavia, America/Argentina/Cordoba, America/Argentina/Jujuy, America/Argentina/La_Rioja, America/Argentina/Mendoza, America/Argentina/Rio_Gallegos, America/Argentina/Salta, America/Argentina/San_Juan, America/Argentina/San_Luis, America/Argentina/Tucuman, America/Argentina/Ushuaia, America/Aruba, America/Asuncion, America/Atikokan, America/Atka, America/Bahia, America/Bahia_Banderas, America/Barbados, America/Belem, America/Belize, America/Blanc-Sablon, America/Boa_Vista, America/Bogota, America/Boise, America/Buenos_Aires, America/Cambridge_Bay, America/Campo_Grande, America/Cancun, America/Caracas, America/Catamarca, America/Cayenne, America/Cayman, America/Chicago, America/Chihuahua, America/Coral_Harbour, America/Cordoba, America/Costa_Rica, America/Creston, America/Cuiaba, America/Curacao, America/Danmarkshavn, America/Dawson, America/Dawson_Creek, America/Denver, America/Detroit, America/Dominica, America/Edmonton, America/Eirunepe, America/El_Salvador, America/Ensenada, America/Fort_Nelson, America/Fort_Wayne, America/Fortaleza, America/Glace_Bay, America/Godthab, America/Goose_Bay, America/Grand_Turk, America/Grenada, America/Guadeloupe, America/Guatemala, America/Guayaquil, America/Guyana, America/Halifax, America/Havana, America/Hermosillo, America/Indiana/Indianapolis, America/Indiana/Knox, America/Indiana/Marengo, America/Indiana/Petersburg, America/Indiana/Tell_City, America/Indiana/Vevay, America/Indiana/Vincennes, America/Indiana/Winamac, America/Indianapolis, America/Inuvik, America/Iqaluit, America/Jamaica, America/Jujuy, America/Juneau, America/Kentucky/Louisville, America/Kentucky/Monticello, America/Knox_IN, America/Kralendijk, America/La_Paz, America/Lima, America/Los_Angeles, America/Louisville, America/Lower_Princes, America/Maceio, America/Managua, America/Manaus, America/Marigot, America/Martinique, America/Matamoros, America/Mazatlan, America/Mendoza, America/Menominee, America/Merida, America/Metlakatla, America/Mexico_City, America/Miquelon, America/Moncton, America/Monterrey, America/Montevideo, America/Montreal, America/Montserrat, America/Nassau, America/New_York, America/Nipigon, America/Nome, America/Noronha, America/North_Dakota/Beulah, America/North_Dakota/Center, America/North_Dakota/New_Salem, America/Ojinaga, America/Panama, America/Pangnirtung, America/Paramaribo, America/Phoenix, America/Port-au-Prince, America/Port_of_Spain, America/Porto_Acre, America/Porto_Velho, America/Puerto_Rico, America/Punta_Arenas, America/Rainy_River, America/Rankin_Inlet, America/Recife, America/Regina, America/Resolute, America/Rio_Branco, America/Rosario, America/Santa_Isabel, America/Santarem, America/Santiago, America/Santo_Domingo, America/Sao_Paulo, America/Scoresbysund, America/Shiprock, America/Sitka, America/St_Barthelemy, America/St_Johns, America/St_Kitts, America/St_Lucia, America/St_Thomas, America/St_Vincent, America/Swift_Current, America/Tegucigalpa, America/Thule, America/Thunder_Bay, America/Tijuana, America/Toronto, America/Tortola, America/Vancouver, America/Virgin, America/Whitehorse, America/Winnipeg, America/Yakutat, America/Yellowknife, Antarctica/Casey, Antarctica/Davis, Antarctica/DumontDUrville, Antarctica/Macquarie, Antarctica/Mawson, Antarctica/McMurdo, Antarctica/Palmer, Antarctica/Rothera, Antarctica/South_Pole, Antarctica/Syowa, Antarctica/Troll, Antarctica/Vostok, Arctic/Longyearbyen, Asia/Aden, Asia/Almaty, Asia/Amman, Asia/Anadyr, Asia/Aqtau, Asia/Aqtobe, Asia/Ashgabat, Asia/Ashkhabad, Asia/Atyrau, Asia/Baghdad, Asia/Bahrain, Asia/Baku, Asia/Bangkok, Asia/Barnaul, Asia/Beirut, Asia/Bishkek, Asia/Brunei, Asia/Calcutta, Asia/Chita, Asia/Choibalsan, Asia/Chongqing, Asia/Chungking, Asia/Colombo, Asia/Dacca, Asia/Damascus, Asia/Dhaka, Asia/Dili, Asia/Dubai, Asia/Dushanbe, Asia/Famagusta, Asia/Gaza, Asia/Harbin, Asia/Hebron, Asia/Ho_Chi_Minh, Asia/Hong_Kong, Asia/Hovd, Asia/Irkutsk, Asia/Istanbul, Asia/Jakarta, Asia/Jayapura, Asia/Jerusalem, Asia/Kabul, Asia/Kamchatka, Asia/Karachi, Asia/Kashgar, Asia/Kathmandu, Asia/Katmandu, Asia/Khandyga, Asia/Kolkata, Asia/Krasnoyarsk, Asia/Kuala_Lumpur, Asia/Kuching, Asia/Kuwait, Asia/Macao, Asia/Macau, Asia/Magadan, Asia/Makassar, Asia/Manila, Asia/Muscat, Asia/Nicosia, Asia/Novokuznetsk, Asia/Novosibirsk, Asia/Omsk, Asia/Oral, Asia/Phnom_Penh, Asia/Pontianak, Asia/Pyongyang, Asia/Qatar, Asia/Qostanay, Asia/Qyzylorda, Asia/Rangoon, Asia/Riyadh, Asia/Saigon, Asia/Sakhalin, Asia/Samarkand, Asia/Seoul, Asia/Shanghai, Asia/Singapore, Asia/Srednekolymsk, Asia/Taipei, Asia/Tashkent, Asia/Tbilisi, Asia/Tehran, Asia/Tel_Aviv, Asia/Thimbu, Asia/Thimphu, Asia/Tokyo, Asia/Tomsk, Asia/Ujung_Pandang, Asia/Ulaanbaatar, Asia/Ulan_Bator, Asia/Urumqi, Asia/Ust-Nera, Asia/Vientiane, Asia/Vladivostok, Asia/Yakutsk, Asia/Yangon, Asia/Yekaterinburg, Asia/Yerevan, Atlantic/Azores, Atlantic/Bermuda, Atlantic/Canary, Atlantic/Cape_Verde, Atlantic/Faeroe, Atlantic/Faroe, Atlantic/Jan_Mayen, Atlantic/Madeira, Atlantic/Reykjavik, Atlantic/South_Georgia, Atlantic/St_Helena, Atlantic/Stanley, Australia/ACT, Australia/Adelaide, Australia/Brisbane, Australia/Broken_Hill, Australia/Canberra, Australia/Currie, Australia/Darwin, Australia/Eucla, Australia/Hobart, Australia/LHI, Australia/Lindeman, Australia/Lord_Howe, Australia/Melbourne, Australia/NSW, Australia/North, Australia/Perth, Australia/Queensland, Australia/South, Australia/Sydney, Australia/Tasmania, Australia/Victoria, Australia/West, Australia/Yancowinna, Brazil/Acre, Brazil/DeNoronha, Brazil/East, Brazil/West, CET, CST6CDT, Canada/Atlantic, Canada/Central, Canada/Eastern, Canada/Mountain, Canada/Newfoundland, Canada/Pacific, Canada/Saskatchewan, Canada/Yukon, Chile/Continental, Chile/EasterIsland, Cuba, EET, EST, EST5EDT, Egypt, Eire, Etc/GMT, Etc/GMT+0, Etc/GMT+1, Etc/GMT+10, Etc/GMT+11, Etc/GMT+12, Etc/GMT+2, Etc/GMT+3, Etc/GMT+4, Etc/GMT+5, Etc/GMT+6, Etc/GMT+7, Etc/GMT+8, Etc/GMT+9, Etc/GMT-0, Etc/GMT-1, Etc/GMT-10, Etc/GMT-11, Etc/GMT-12, Etc/GMT-13, Etc/GMT-14, Etc/GMT-2, Etc/GMT-3, Etc/GMT-4, Etc/GMT-5, Etc/GMT-6, Etc/GMT-7, Etc/GMT-8, Etc/GMT-9, Etc/GMT0, Etc/Greenwich, Etc/UCT, Etc/UTC, Etc/Universal, Etc/Zulu, Europe/Amsterdam, Europe/Andorra, Europe/Astrakhan, Europe/Athens, Europe/Belfast, Europe/Belgrade, Europe/Berlin, Europe/Bratislava, Europe/Brussels, Europe/Bucharest, Europe/Budapest, Europe/Busingen, Europe/Chisinau, Europe/Copenhagen, Europe/Dublin, Europe/Gibraltar, Europe/Guernsey, Europe/Helsinki, Europe/Isle_of_Man, Europe/Istanbul, Europe/Jersey, Europe/Kaliningrad, Europe/Kiev, Europe/Kirov, Europe/Lisbon, Europe/Ljubljana, Europe/London, Europe/Luxembourg, Europe/Madrid, Europe/Malta, Europe/Mariehamn, Europe/Minsk, Europe/Monaco, Europe/Moscow, Europe/Nicosia, Europe/Oslo, Europe/Paris, Europe/Podgorica, Europe/Prague, Europe/Riga, Europe/Rome, Europe/Samara, Europe/San_Marino, Europe/Sarajevo, Europe/Saratov, Europe/Simferopol, Europe/Skopje, Europe/Sofia, Europe/Stockholm, Europe/Tallinn, Europe/Tirane, Europe/Tiraspol, Europe/Ulyanovsk, Europe/Uzhgorod, Europe/Vaduz, Europe/Vatican, Europe/Vienna, Europe/Vilnius, Europe/Volgograd, Europe/Warsaw, Europe/Zagreb, Europe/Zaporozhye, Europe/Zurich, GB, GB-Eire, GMT, GMT+0, GMT-0, GMT0, Greenwich, HST, Hongkong, Iceland, Indian/Antananarivo, Indian/Chagos, Indian/Christmas, Indian/Cocos, Indian/Comoro, Indian/Kerguelen, Indian/Mahe, Indian/Maldives, Indian/Mauritius, Indian/Mayotte, Indian/Reunion, Iran, Israel, Jamaica, Japan, Kwajalein, Libya, MET, MST, MST7MDT, Mexico/BajaNorte, Mexico/BajaSur, Mexico/General, NZ, NZ-CHAT, Navajo, PRC, PST8PDT, Pacific/Apia, Pacific/Auckland, Pacific/Bougainville, Pacific/Chatham, Pacific/Chuuk, Pacific/Easter, Pacific/Efate, Pacific/Enderbury, Pacific/Fakaofo, Pacific/Fiji, Pacific/Funafuti, Pacific/Galapagos, Pacific/Gambier, Pacific/Guadalcanal, Pacific/Guam, Pacific/Honolulu, Pacific/Johnston, Pacific/Kiritimati, Pacific/Kosrae, Pacific/Kwajalein, Pacific/Majuro, Pacific/Marquesas, Pacific/Midway, Pacific/Nauru, Pacific/Niue, Pacific/Norfolk, Pacific/Noumea, Pacific/Pago_Pago, Pacific/Palau, Pacific/Pitcairn, Pacific/Pohnpei, Pacific/Ponape, Pacific/Port_Moresby, Pacific/Rarotonga, Pacific/Saipan, Pacific/Samoa, Pacific/Tahiti, Pacific/Tarawa, Pacific/Tongatapu, Pacific/Truk, Pacific/Wake, Pacific/Wallis, Pacific/Yap, Poland, Portugal, ROC, ROK, Singapore, Turkey, UCT, US/Alaska, US/Aleutian, US/Arizona, US/Central, US/East-Indiana, US/Eastern, US/Hawaii, US/Indiana-Starke, US/Michigan, US/Mountain, US/Pacific, US/Pacific-New, US/Samoa, UTC, Universal, W-SU, WET, Zulu
Default Value	UTC

cron_recordIdentifierTemplate Record Identifier Template string

The label that is used to indentify the scheduled repeated action in Inbound Request Logs. Accepts template syntax.

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

cron_waitUntilPreviousFinished Wait Until Previous Cron Finishes boolean

Requires a Non-Null Value	Yes
Default Value	No

dbwrite_connection Database Connection objectid

A reference to the database connection record that contains the details on how to connect to the remote database service.

dbwrite_collection Collection / Table name string

The database table or collection that the action will access once connected to the database.

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

dbwrite_outkey Out Key string

The namespace where the results of an insert action will be stored.

Requires a Non-Null Value	Yes
Minimum Characters	1
Default Value	"writeResult"
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

dbwrite_recordIdentifierTemplate Record Identifier Template string

The label that is used to identify database write logs in the Outbound Record Logs.

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

dbread_connection Database Connection objectid

dbread_collection Collection / Table name string

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

dbread_sortKey Sort Key string

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

dbread_sortDir Sort Direction options

Requires a Non-Null Value	Yes
Allowed Values	DESC, ASC
Default Value	DESC

dbread_pageSize Page Size integer

Requires a Non-Null Value	Yes
Default Value	50

dbread_pageNumber Page Number integer

Requires a Non-Null Value	Yes
Default Value	1

dbread_outkey Out Key string

Requires a Non-Null Value	Yes
Minimum Characters	1
Default Value	"readResult"
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

dbread_doRawQuery Do Raw Query? boolean

Requires a Non-Null Value	Yes
Default Value	No

dbread_allowListParsing Parse List Values (MSSQL) boolean

Requires a Non-Null Value	Yes
Default Value	No

dbread_rawQuery Raw Query Value string

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	Yes
Converts to Lowercase	No
Converts to Uppercase	No

dbread_recordIdentifierTemplate Record Identifier Template string

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

ftp_connectionUrl Connection URL string

The url address where the remote FTP service is hosted.

Requires a Non-Null Value	Yes
Default Value	"ftps://"
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

ftp_path Directory or File Path string

The relative location of the file or directory on the FTP server

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	Yes
Converts to Lowercase	No
Converts to Uppercase	No

ftp_movePath Move File to Directory string

The relative location where the file or directory will be moved to.

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	Yes
Converts to Lowercase	No
Converts to Uppercase	No

ftp_action Command options

The FTP command to run on the remote FTP server.

DOWNLOAD	Download the file resource located at the supplied path and named by ftp_fileName.
UPLOAD	Upload a document to the FTP server where it will be placed at the supplied path and will be named as declared by ftp_fileName.
LIST	List all the files in the directory at the supplied path
MOVE	Move or rename a file at the supplied path to the ftp_movePath value. If the paths are in the same directory, the file will effectively be renamed to the value supplied in ftp_moveFileName instead of moved.
DELETE	Delete the file or directory at the supplied path. This action cannot be undone.

DOWNLOAD

ftp_fileName Remote File Name string

The name of the file resource to act upon.

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

ftp_moveFileName New File Name string

The new name of the file. Used with MOVE action.

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

ftp_uploadTemplate File Contents string

The file contents that will be uploaded to the remote FTP server. Accepts template syntax.

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

ftp_downloadNamespace Results Namespace string

The key that will contain the data of the file contents that were downloaded from the remote FTP server.

Requires a Non-Null Value	Yes
Default Value	"ftpsResults"
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

ftp_identifier Record Identifier Template string

Searchable template used to help identify the FTP action in the outbound call logs. Please set this to make your logs easier to interpret.

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

ftp_useCertificate Use SSH Certificate boolean

Requires a Non-Null Value	Yes
Default Value	No

ftp_projectSecretId SSH Private Key objectid

ftp_acceptCertificate Skip Certificate Validation boolean

Requires a Non-Null Value	Yes
Default Value	No

gettmprecord_key Record Key string

DEPRECATED. Will be removed in a future release. Please use the Session Storage action.

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

settmprecord_key Record Key string

DEPRECATED. Will be removed in a future release. Please use the Session Storage action.

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

transform_title Description string

A label used to help identify your transformation action in the process flow editor.

Requires a Non-Null Value	Yes
Default Value	"Transform Data"
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

runaction_connectorId Connector objectid

The connector that will be used when using the RUN_ACTION action.

runaction_actionName Action Name string

The connector action that will be executed when using the RUN_ACTION action.

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

handleactioncb_eventKey Event Key string

Connector actions may have multiple callback triggers. This is the trigger that the ACTION_HANDLER will wait for when waiting to execute.

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

handleactioncb_outKey Output Key string

When using the ACTION_HANDLER process action the data that the connector returns will be set to this key in subsequent actions in the data flow.

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

actioncb_eventKey Event Key string

Connector actions may have multiple callback triggers. This is the identifier that the ACTION_CALLBACK process action will send to waiting ACTION_HANDLER processes to trigger their execution.

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

defineaction_actionName Action Name string

Connectors may have multiple defined actions available to consumers of the connector. This property identifies the action so that it may be easily referenced by consumers of the connector.

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

defineaction_hasFields Define Action Keys boolean

Requires a Non-Null Value	Yes
Default Value	No

sessionstore_namespace Key Namespace string

When saving data to the session this field identifies the stored data to enable it to be referenced upon retrieval.

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

sessionstore_ttl Key Timeout string

The time used for the expiration of the data stored in the session. The maximum time allowed to store session data is one week. Enter a number followed by a letter to define the time.

For example "1d" would expire the data stored in the session one day from the time it was inserted.

The valid time definitions are:

"ms" = microseconds
"s" = seconds
"m" = minutes
"h" = hours
"d" = days
"w" = weeks

Requires a Non-Null Value	Yes
Default Value	"1d"
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

sessionstore_ttl_secs integer

The read-only representation of the value supplied in sessionstore_ttl. This value is in seconds.

Requires a Non-Null Value	Yes
Default Value	0

sessionread_namespace Key Namespace string

When reading data from the session storage this is the key that is used to lookup the data in the session storage.

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

sessionread_outKey Key Out Namespace string

The key that will contain the data retrieved from the session read action.

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

queue_queueIdentifier Queue Key string

All queues that use the same queue identifier will be listed in the same queue logs in the administration panel. Set this value to categorize your queues.

Requires a Non-Null Value	Yes
Minimum Characters	1
Default Value	"Default Queue"
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

queue_itemIdentifier Queue Item Identifier string

Searchable template used to help identify your queued processes in the queue logs. Please set this to make your logs easier to interpret.

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

queue_useDataFields Use Data Fields boolean

When enabled, the queued process will only store the supplied fields in it's memory. When disabled, all process data a the point when the process is queued will be available when the subsequent actions in the data flow execute.

Requires a Non-Null Value	Yes
Default Value	No

queue_dedupe Prevent Duplication boolean

Requires a Non-Null Value	Yes
Default Value	No

queue_dedupeKey Duplicate Item Template string

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

queue_dedupeUseTime Expire Duplicate Key options

Requires a Non-Null Value	Yes
Allowed Values	true
Default Value	Yes

queue_dedupeTime Duplicate Key Expire Time string

Requires a Non-Null Value	Yes
Default Value	"1 minute"
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

queue_dedupeIgnoreCompleted Allow Resubmissions of Completed Items boolean

Requires a Non-Null Value	Yes
Default Value	No

queue_dedupeIgnorePermanentlyFailed Allow Resubmissions of Permanently Failed Items boolean

Requires a Non-Null Value	Yes
Default Value	No

reenqueue_errorMessage Error Message string

Label applied to the queued item in the queue logs when a queue fails to execute. Set this to make your queue logs easier to interpret.

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

progress_totalKey Total Count Data Source string

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

progress_incrementKey Progress Increment Amount string

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

sendmessage_topicId Message Topic objectid

sendmessage_subject Subject string

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

sendmessage_htmlContent HTML Content string

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	Yes
Converts to Lowercase	No
Converts to Uppercase	No

sendmessage_textContent Text Content string

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	Yes
Converts to Lowercase	No
Converts to Uppercase	No

sendmessage_continueBehavior Send Message Continuation Behavior options

Requires a Non-Null Value	Yes
Allowed Values	ALWAYS_CONTINUE, CONTINUE_WHEN_ANY_SEND_SUCCEEDS, CONTINUE_WHEN_ALL_SENDS_SUCCEED
Default Value	CONTINUE_WHEN_ANY_SEND_SUCCEEDS

sample_input Sample Input Data string

Requires a Non-Null Value	Yes
Default Value	""
Trims Whitespace	No
HTML Tags Allowed	No
Converts to Lowercase	No
Converts to Uppercase	No

createdTime datetime

System managed property. Set to the timestamp of when the record is created.

Requires a Non-Null Value	Yes
Default Value	__auto__

modifiedTime datetime

System managed property. Set to the timestamp of when the record is updated.

Requires a Non-Null Value	Yes
Default Value	__auto__

projects join

The project that owns the process.

Data Model	projects
Local Property	processes.projectId
Foreign Property	projects._id

parents join

The process that immediately preceeds this process when executing the data flow.

Data Model	processes
Local Property	processes.parentProcess
Foreign Property	processes._id

processes join

All processes that will immediately execute after this process has executed in the data flow

Data Model	processes
Local Property	processes._id
Foreign Property	processes.parentProcess

transforms join

A set of properties used to modify input data with specified operations and then pass the modified data to subsequent actions. The transformations run on inputs that have lowest path depth first.

transforms.parentProcess

Find Key In... (findIn)	The process data that where the transform operator will search for the from key
Input Key (fromKey)	The lookup path for the data that will be transformed
Transform As (transformAs)	The operation that will be used to transform the input data found at the path listed in fromKey. All operations are also available via scripting. See the Instalink Scripting Documentation for more information
Output Key (toKey)	The lookup path for where the result of the transformation will be stored.
(description)
Parent Process (parentProcess)	A reference to the process that will execute the transformation.
Project (projectId)	A reference to the project that contains parent process.
Account (accountId)	A reference to the account that owns the project.
Script (script)	User defined script that performs a transformation on the input data. See the Instalink Scripting Documentation for more information
Arg 1 (arg1)
Arg 2 (arg2)
Arg 3 (arg3)
Arg 4 (arg4)
Arg 5 (arg5)
Arg 6 (arg6)
Arg 7 (arg7)
Arg 8 (arg8)
Arg 9 (arg9)
Arg 10 (arg10)
Arg 11 (arg11)
Arg 12 (arg12)

conditions Add conditions that must be met to perform this action join

A set of properties that are used to describe conditional clauses that must be evaluated as true before executing subsequent actions in the data flow. Will execute the THEN branch when all conditions are met. Will execute the ELSE branch if any of the conditions are not met.

conditions.parentProcess

fieldDefinitions.parentProcess

Find Key In... (findIn)	The sub-record within the data flow's process data where the key that is being evaluated my be found.
Input Key (checkKey)	The key that is being searched for in the process data.
Compare As (compareAs)	The logical operator that determines how the value found within the process data is to be compared against the value supplied in the condition.
Value (value)	The value that the evaluation will compare against in the manner defined by the compareAs logical operator
Parent Process (parentProcess)	A reference to the process that owns this condition.
Project (projectId)	A reference to the project that owns this condition.
Account (accountId)	A reference to the account that owns this condition.

fields join

A set of records that are used to define process data keys that are to be included when executing various actions.

Field Key (key)	Where to find or set the data in the process data. Uses dot notation conventions.
Value (value)	The value to set in the process data. Accepts template syntax.
Parent Process (parentProcess)	A reference to the process that owns this field record.
Project (projectId)	A reference to the project that owns this field record.
Account (accountId)	A reference to the account that owns this field record.

fieldDefinitions Include these action keys... join

A set of records that are used to define process data keys that are to be included when executing various actions.

queryFields.parentProcess

Action Key (key)
Parent Process (parentProcess)
Project (projectId)
Account (accountId)

queryFields Include these query fields... join

A set of records that are used to define conditionals for use in database queries.

Field Key (key)	The property of the database record to evaluate. Uses dot notation conventions.
Operator (queryOperator)	The logical operator that determines how the value of the property will be compared against the value supplied in the condition.
Value (value)	The value will be compared against the database using the designated operator.
Parent Process (parentProcess)	A reference to the process that owns this field record.
Project (projectId)	A reference to the project that owns this field record.
Account (accountId)	A reference to the account that owns this field record.

authorizations Additional Authentications join

A reference to the project authorization records that are available to LISTEN and RESPONSE actions in order to create permissioned requests.

Data Model	processAuthorizations
Local Property	processes._id
Foreign Property	processAuthorizations.processId

acceptedFiles Accepted Files join

A set of records that define the parameters of what file uploads a LISTEN action will allow.

acceptedFiles.processId

Account (accountId)	A reference to the account that owns this accepted file record.
Project (projectId)	A reference to the project that owns this accepted file record.
Process (processId)	A reference to the process that owns this accepted file record.
Field Key (key)	The identifier of the file that is expected to be uploaded.
Max Size Per File (maxFileSize)	The maximum size, in bytes, that any individual file may be that is sent to the LISTEN action. Leave blank to allow any size file.
Max Files Per Request (maxFiles)	The maximum number of files that will be accepted by the listen request.

observers join

A set of records that define mechanisms for inspecting success and error log occurrences as they occur.

Account (accountId)	A reference to the account that owns this observer record.
Project (projectId)	A reference to the project that owns this observer record.
Process (processId)	A reference to the process that owns this observer record.
Active? (active)	When enabled the observer will monitor the data flow for success and error occurrences.
Title (testTitle)	The label that identifies the test results in the admin panel observers report.
Description (testDescription)	A system generated description of what the test is evaluating, how often it runs, and what will occur when an alert or all clear is triggered.
Iteration (Minutes) (testInterval)	How often, in minutes, the observer test will execute.
Duration (Minutes) (testPeriod)	The timespan before the test execution that will be included in the evaluation.
Observe Data (testType)	The operator that determines how to analyze the success and error logs.
Condition (testCondition)	The threshold operator that is applied to the test.
Value (testValue)	The threshold that must be met in a specific occurrence of a test to trigger an action
Consecutive Occurrences (testThreshold)	The number of consecutive occurrences that the test has been met to trigger an action.
In Alert State? (inAlarm)	Indicates whether the observer has presently encountered conditions which have triggered an alert state.
Last Alert Time (lastAlarm)	The most recent date and time when the observer was in an alarm state
Last All Clear Time (lastClear)	The most recent date and time when the observer entered an all clear state.
Then (alertState)	The action to take when the defined conditions of the test are met.
Publish message on alert? (publishOnAlert)	When enabled the observer will send messages to the associated subscription topic when the observer enters an alert state.
Publish message on clear? (publishOnClear)	When enabled the observer will send messages to the associated subscription topic when the observer enters the all clear state.
Alert Topic (alertMessageTopic)	The message subscription list to send messages to when the observer enters an alert state.
Alert Message Title (alertMessageTitle)	When the observers enters the alert state the message sent to subscribers will contain this value as the subject. Accepts template syntax.
Alert Message Content (alertMessageContent)	When the observers enters the alert state the message sent to subscribers will contain this value as the message content. Accepts template syntax.
Alert Topic (clearMessageTopic)	The message subscription list to send messages to when the observer enters an all clear state.
Alert Message Title (clearMessageTitle)	When the observers enters the all clear state the message sent to subscribers will contain this value as the subject. Accepts template syntax.
Alert Message Content (clearMessageContent)	When the observers enters the all clear state the message sent to subscribers will contain this value as the message content. Accepts template syntax.

formFields join

A set of records that define input fields for Instalink forms within the admin panel.

formFields.parentProcess

logReportDefinitions.processId

Field Key (key)
Field Type (dataType)
Default Value (defaultValue)
Label (label)
Required (isRequired)
Parameter Documentation (documentation)
Priority (priority)
Parent Process (parentProcess)
Project (projectId)
Account (accountId)

connector join

The connector record that this process is utilizing.

Data Model	connectors
Local Property	processes.runaction_connectorId
Foreign Property	connectors._id

connectorProject join

The project, owned by the connector, that this process is utilizing.

Data Model	projects
Local Property	processes.projectId
Foreign Property	projects._id

logReportDefinitions join

messageAttachments.processId

Account (accountId)
Project (projectId)
process (processId)
Report Name (reportName)
Report Mode (reportMode)
Enabled (enabled)
Last Generated (lastGeneratedTime)

messageAttachments join