Automation Anywhere Module Documentation Reference

Configurations

Config

Parameters

Name	Type	Description	Required
Name	String	The name for this configuration. Connectors reference the configuration with this name.	x
Connection	API Key Authentication Connection Basic Authentication Connection	The connection types that can be provided to this configuration.	x
Listener Config	String	Reference to the http:listener-config used for listening for the bots responses	x
Base Callback Url	String	The base URL to which callbacks should be sent. This parameter must not be specified when the application is deployed to Cloudhub as the connector build build a base url that points to the correct CloudHub worker (this is specially important when the application is deployed with several replicas) When deploying deploying on-prem or Runtime Fabric, the connector will not be able to determine a base callback URL, in which case this parameter should be specified. If not provided, the connector will build a URL using the Server IP. This IP however could not be publicly accessible (e.g: 127.0.0.1).
Expiration Policy	Expiration Policy	Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform will expire the instance at the exact moment that it becomes eligible. The runtime will actually purge the instances when it sees it fit.

Name

Type

Description

Default Value

Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

Connection

API Key Authentication Connection
Basic Authentication Connection

The connection types that can be provided to this configuration.

Listener Config

String

Reference to the http:listener-config used for listening for the bots responses

Base Callback Url

String

The base URL to which callbacks should be sent. This parameter must not be specified when the application is deployed to Cloudhub as the connector build build a base url that points to the correct CloudHub worker (this is specially important when the application is deployed with several replicas) When deploying deploying on-prem or Runtime Fabric, the connector will not be able to determine a base callback URL, in which case this parameter should be specified. If not provided, the connector will build a URL using the Server IP. This IP however could not be publicly accessible (e.g: 127.0.0.1).

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform will expire the instance at the exact moment that it becomes eligible. The runtime will actually purge the instances when it sees it fit.

Connection Types

API Key Authentication Connection

Parameters

Name	Type	Description	Default Value	Required
Control Room URL	String	A control room has an ip or url that will be used to connect for bot operations.		x
Control Room Username	String	Your username to login your control room		x
Request Time Out	Number		30
Request Time Out Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS		SECONDS
Connection Idle Time Out	Number		30
Connection Idle Time Out Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS		SECONDS
Proxy Config	Proxy	Reusable configuration element for outbound connections through a proxy. A proxy element must define a host name and a port attributes, and optionally can define a username and a password.
Control Room API Key	String	Your API Key to authenticate with the Control Room		x
Tls Context	Tls
Reconnection	Reconnection	When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn't pass after exhausting the associated reconnection strategy

Name

Type

Description

Default Value

Required

Control Room URL

String

A control room has an ip or url that will be used to connect for bot operations.

Control Room Username

String

Your username to login your control room

Request Time Out

Number

Request Time Out Unit

Enumeration, one of:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

SECONDS

Connection Idle Time Out

Number

Connection Idle Time Out Unit

Enumeration, one of:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

SECONDS

Proxy Config

Proxy

Reusable configuration element for outbound connections through a proxy. A proxy element must define a host name and a port attributes, and optionally can define a username and a password.

Control Room API Key

String

Your API Key to authenticate with the Control Room

Tls Context

Tls

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn't pass after exhausting the associated reconnection strategy

Basic Authentication Connection

Parameters

Name	Type	Description	Default Value	Required
Control Room URL	String	A control room has an ip or url that will be used to connect for bot operations.		x
Control Room Username	String	Your username to login your control room		x
Request Time Out	Number		30
Request Time Out Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS		SECONDS
Connection Idle Time Out	Number		30
Connection Idle Time Out Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS		SECONDS
Proxy Config	Proxy	Reusable configuration element for outbound connections through a proxy. A proxy element must define a host name and a port attributes, and optionally can define a username and a password.
Control Room Password	String	Your password to authenticate with the Control Room		x
Tls Context	Tls
Reconnection	Reconnection	When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn't pass after exhausting the associated reconnection strategy

Name

Type

Description

Default Value

Required

Control Room URL

String

A control room has an ip or url that will be used to connect for bot operations.

Control Room Username

String

Your username to login your control room

Request Time Out

Number

Request Time Out Unit

Enumeration, one of:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

SECONDS

Connection Idle Time Out

Number

Connection Idle Time Out Unit

Enumeration, one of:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

SECONDS

Proxy Config

Proxy

Reusable configuration element for outbound connections through a proxy. A proxy element must define a host name and a port attributes, and optionally can define a username and a password.

Control Room Password

String

Your password to authenticate with the Control Room

Tls Context

Tls

Reconnection

Associated Sources

On Bot Result

Operations

Get Bot Activity

<automationanywhere:get-bot-activity>

Provides the status and progress of bot execution based on the specified deployment ID. See online documentation for details.

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Deployment ID	String	The id of the bot deployment for both A2019 and 11.3.2+ Control Rooms. This is required. For A2019 Control Room, the format of the Id is in GUID format. For 11.3.2+ Control Room, it is a numeric format. i.e.: For A2019, it must be 7100ee04-b363-49ad-b1bd-d9df26b3fdfd. For 11.3.x, it can be 7100ee04-b363-49ad-b1bd-d9df26b3fdfd or 123.		x
Retry Policy Template	[RetryPolicyTemplate]	The retry policy template.
Target Variable	String	The name of a variable on which the operation's output will be placed
Target Value	String	An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use.

Deployment ID

String

The id of the bot deployment for both A2019 and 11.3.2+ Control Rooms. This is required. For A2019 Control Room, the format of the Id is in GUID format. For 11.3.2+ Control Room, it is a numeric format. i.e.: For A2019, it must be 7100ee04-b363-49ad-b1bd-d9df26b3fdfd. For 11.3.x, it can be 7100ee04-b363-49ad-b1bd-d9df26b3fdfd or 123.

Retry Policy Template

[RetryPolicyTemplate]

The retry policy template.

Target Variable

String

The name of a variable on which the operation's output will be placed

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Array of Bot Activity

Attributes Type

Response Attribute

For Configurations.

Config

Throws

AUTOMATIONANYWHERE:CONNECTIVITY
AUTOMATIONANYWHERE:BOT_ACTIVITY_EXECUTION
AUTOMATIONANYWHERE:RETRY_EXHAUSTED
AUTOMATIONANYWHERE:INVALID_PARAMETER

Run Bot

<automationanywhere:run-bot>

Launch the selected bot synchronously and wait until the result is ready. Be sure to have properly specified the baseConfigUrl parameter in the config before using this operation. See online documentation for details.
This operation could take several minutes to complete as it waits for a bot to become available and executed. Keep this in mind when using this operation in flows triggered by event sources that emits responses, such as the <http:listener>. This is specially important when deploying to CloudHub, where the load balancer automatically times out all inbound http request that run for more than five minutes.

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Bot	String	The id of the bot. It is required. i.e.: Bot Name (1), 1.		x
Run As User/Device	String	The id of the Run As User for A2019 or the id of the device for 11.3.2+ Control Room. For both Control Rooms, this is required. i.e: RunAsUser (1), 1, 1,2,3		x
Device Pool	String	The id of the device pool for A2019 and this is not supported for 11.3.2+ Control Room. For A2019 Control Rooms, this is optional. i.e.: Device Pool (1), 1
Input Variables	Object	The input variables of the bot. For A2019 Control Room, only input and non-read-only variables are available to be mapped. For 11.3.2+ Control Room, all variables are available to be mapped.
Execution Time Out	Number	Scalar value for the operation timeout. A TIMEOUT error is thrown if a response is not obtained in time	5
Execution Time Out Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	The unit for the timeout parameter	MINUTES
(For 11.3.x only) Run With RDP	Boolean	Whether the bot should be deployed using remote desktop process.	false
(For A2019 only) Run Elevated	Boolean	Whether to deploy the bot using elevated permissions or not.	false
(For A2019 only) Override Default Device	Boolean	Whether to use default device or not. This will be effective if the poolId(s) are provided. If false default device is preferred else device from the pool is picked.	false
Bot Result Headers	Object	The headers of the on bot result source. It is optional. Headers may contain authentication token, content type, etc. If specified, the value will return from the callback response under the otherAttributes property of On Bot Result Attributes.
Target Variable	String	The name of a variable on which the operation's output will be placed
Target Value	String	An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use.

Bot

String

The id of the bot. It is required. i.e.: Bot Name (1), 1.

Run As User/Device

String

The id of the Run As User for A2019 or the id of the device for 11.3.2+ Control Room. For both Control Rooms, this is required. i.e: RunAsUser (1), 1, 1,2,3

Device Pool

String

The id of the device pool for A2019 and this is not supported for 11.3.2+ Control Room. For A2019 Control Rooms, this is optional. i.e.: Device Pool (1), 1

Input Variables

Object

The input variables of the bot. For A2019 Control Room, only input and non-read-only variables are available to be mapped. For 11.3.2+ Control Room, all variables are available to be mapped.

Execution Time Out

Number

Scalar value for the operation timeout. A TIMEOUT error is thrown if a response is not obtained in time

Execution Time Out Unit

Enumeration, one of:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

The unit for the timeout parameter

MINUTES

(For 11.3.x only) Run With RDP

Boolean

Whether the bot should be deployed using remote desktop process.

false

(For A2019 only) Run Elevated

Boolean

Whether to deploy the bot using elevated permissions or not.

false

(For A2019 only) Override Default Device

Boolean

Whether to use default device or not. This will be effective if the poolId(s) are provided. If false default device is preferred else device from the pool is picked.

false

Bot Result Headers

Object

The headers of the on bot result source. It is optional. Headers may contain authentication token, content type, etc. If specified, the value will return from the callback response under the otherAttributes property of On Bot Result Attributes.

Target Variable

String

The name of a variable on which the operation's output will be placed

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Object

Attributes Type

Response Attribute

For Configurations.

Config

Throws

AUTOMATIONANYWHERE:CONNECTIVITY
AUTOMATIONANYWHERE:BOT_EXECUTION
AUTOMATIONANYWHERE:TIMEOUT
AUTOMATIONANYWHERE:BOT_CONTENT_EXECUTION
AUTOMATIONANYWHERE:RETRY_EXHAUSTED
AUTOMATIONANYWHERE:INVALID_PARAMETER

Run Bot Async

<automationanywhere:run-bot-async>

Launch the selected bot asynchronously and receive the Deployment Id. To receive the bot execution results, specify the matching Bot Result Key in the On Bot Result source listener to await for responses. See online documentation for details.

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Bot	String	The id of the bot. It is required. i.e.: Bot Name (1), 1.		x
Run As User/Device	String	The id of the Run As User for A2019 or the id of the device for 11.3.2+ Control Room. For both Control Rooms, this is required. i.e: RunAsUser (1), 1, 1,2,3		x
Device Pool	String	The id of the device pool for A2019 and this is not supported for 11.3.2+ Control Room. For A2019 Control Rooms, this is optional. i.e.: Device Pool (1), 1
Input Variables	Object	The input variables of the bot. For A2019 Control Room, only input and non-read-only variables are available to be mapped. For 11.3.2+ Control Room, all variables are available to be mapped.
Bot Result Key	String	The key of the on bot result source. It is optional if bot output is not required. If specified, the key must match the existing bot result key of the on bot result source. i.e.: bot-result-key
(For 11.3.x only) Run With RDP	Boolean	Whether the bot should be deployed using remote desktop process.	false
(For A2019 only) Run Elevated	Boolean	Whether to deploy the bot using elevated permissions or not.	false
(For A2019 only) Override Default Device	Boolean	Whether to use default device or not. This will be effective if the poolId(s) are provided. If false default device is preferred else device from the pool is picked.	false
(For A2019 only) Num. Of Run As Users To Use	Number	Used to indicate how many run as users should be used from the list of runAsUserIds provided. System will pick the specified number of runAsUsers with the least number of tasks queued for the user at the moment of deploy request. If 0 then all the users will be used. If the number is greater than the number of runAsUsers provided. If the number is less than zero, the number of runAsUsers is set to default value	1
Bot Result Headers	Object	The headers of the on bot result source. It is optional. Headers may contain authentication token, content type, etc. If specified, the value will return from the callback response under the otherAttributes property of On Bot Result Attributes.
Target Variable	String	The name of a variable on which the operation's output will be placed
Target Value	String	An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use.

Bot

String

The id of the bot. It is required. i.e.: Bot Name (1), 1.

Run As User/Device

String

The id of the Run As User for A2019 or the id of the device for 11.3.2+ Control Room. For both Control Rooms, this is required. i.e: RunAsUser (1), 1, 1,2,3

Device Pool

String

The id of the device pool for A2019 and this is not supported for 11.3.2+ Control Room. For A2019 Control Rooms, this is optional. i.e.: Device Pool (1), 1

Input Variables

Object

The input variables of the bot. For A2019 Control Room, only input and non-read-only variables are available to be mapped. For 11.3.2+ Control Room, all variables are available to be mapped.

Bot Result Key

String

The key of the on bot result source. It is optional if bot output is not required. If specified, the key must match the existing bot result key of the on bot result source. i.e.: bot-result-key

(For 11.3.x only) Run With RDP

Boolean

Whether the bot should be deployed using remote desktop process.

false

(For A2019 only) Run Elevated

Boolean

Whether to deploy the bot using elevated permissions or not.

false

(For A2019 only) Override Default Device

Boolean

Whether to use default device or not. This will be effective if the poolId(s) are provided. If false default device is preferred else device from the pool is picked.

false

(For A2019 only) Num. Of Run As Users To Use

Number

Used to indicate how many run as users should be used from the list of runAsUserIds provided. System will pick the specified number of runAsUsers with the least number of tasks queued for the user at the moment of deploy request. If 0 then all the users will be used. If the number is greater than the number of runAsUsers provided. If the number is less than zero, the number of runAsUsers is set to default value

Bot Result Headers

Object

Target Variable

String

The name of a variable on which the operation's output will be placed

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Run Bot Async Response

Attributes Type

Response Attribute

For Configurations.

Config

Throws

AUTOMATIONANYWHERE:CONNECTIVITY
AUTOMATIONANYWHERE:BOT_EXECUTION
AUTOMATIONANYWHERE:BOT_CONTENT_EXECUTION
AUTOMATIONANYWHERE:RETRY_EXHAUSTED
AUTOMATIONANYWHERE:INVALID_PARAMETER

Sources

On Bot Result

<automationanywhere:bot-result-listener>

Required to receive the bot run results, the On Bot Result source listener, handles the HTTP call back response of bot execution and returns the bot output. See online documentation for details.

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Bot	String	The id of the bot. It is required. i.e.: 1.		x
Bot Result Key	String	The key of the on bot result source. It is optional if bot output is not required. If specified, the key must match the existing bot result key of the on bot result source. i.e.: bot-result-key.		x
Use the Bot Result Key as URL Path?	Boolean	This setting allows you to create a friendly url path based on your Bot Result Key. This is helpful to pre-determine the full url when it needs to be whitelisted in Firewall or Control Room version 11.3.x. If needed to generate unique path instead of friendly name, uncheck the setting.	true
Primary Node Only	Boolean	Whether this source should only be executed on the primary node when runnning in Cluster	true
Redelivery Policy	Redelivery Policy	Defines a policy for processing the redelivery of the same message

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use.

Bot

String

The id of the bot. It is required. i.e.: 1.

Bot Result Key

String

The key of the on bot result source. It is optional if bot output is not required. If specified, the key must match the existing bot result key of the on bot result source. i.e.: bot-result-key.

Use the Bot Result Key as URL Path?

Boolean

This setting allows you to create a friendly url path based on your Bot Result Key. This is helpful to pre-determine the full url when it needs to be whitelisted in Firewall or Control Room version 11.3.x. If needed to generate unique path instead of friendly name, uncheck the setting.

true

Primary Node Only

Boolean

Whether this source should only be executed on the primary node when runnning in Cluster

true

Redelivery Policy

Defines a policy for processing the redelivery of the same message

Output

Type

Object

Attributes Type

Response Attribute

For Configurations.

Config

Types

Proxy

Field	Type	Description	Required
Host	String	Host where the proxy requests will be sent.	x
Port	Number	Port where the proxy requests will be sent.	x
Username	String	The username to authenticate against the proxy.
Password	String	The password to authenticate against the proxy.
Non Proxy Hosts	String	A list of comma separated hosts against which the proxy should not be used

Field

Type

Description

Default Value

Required

Host

String

Host where the proxy requests will be sent.

Port

Number

Port where the proxy requests will be sent.

Username

String

The username to authenticate against the proxy.

Password

String

The password to authenticate against the proxy.

Non Proxy Hosts

String

A list of comma separated hosts against which the proxy should not be used

Tls

Field

Type

Description

Default Value

Required

Enabled Protocols

String

A comma separated list of protocols enabled for this context.

Enabled Cipher Suites

String

A comma separated list of cipher suites enabled for this context.

Trust Store

Key Store

Revocation Check

Standard Revocation Check
Custom Ocsp Responder
Crl File

Trust Store

Field	Type	Description
Path	String	The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store.
Password	String	The password used to protect the trust store.
Type	String	The type of store used.
Algorithm	String	The algorithm used by the trust store.
Insecure	Boolean	If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.

Field

Type

Description

Default Value

Required

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store.

Password

String

The password used to protect the trust store.

Type

String

The type of store used.

Algorithm

String

The algorithm used by the trust store.

Insecure

Boolean

If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.

Key Store

Field	Type	Description
Path	String	The location (which will be resolved relative to the current classpath and file system, if possible) of the key store.
Type	String	The type of store used.
Alias	String	When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default.
Key Password	String	The password used to protect the private key.
Password	String	The password used to protect the key store.
Algorithm	String	The algorithm used by the key store.

Field

Type

Description

Default Value

Required

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the key store.

Type

String

The type of store used.

Alias

String

When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default.

Key Password

String

The password used to protect the private key.

Password

String

The password used to protect the key store.

Algorithm

String

The algorithm used by the key store.

Standard Revocation Check

Field	Type	Description
Only End Entities	Boolean	Only verify the last element of the certificate chain.
Prefer Crls	Boolean	Try CRL instead of OCSP first.
No Fallback	Boolean	Do not use the secondary checking method (the one not selected before).
Soft Fail	Boolean	Avoid verification failure when the revocation server can not be reached or is busy.

Field

Type

Description

Default Value

Required

Only End Entities

Boolean

Only verify the last element of the certificate chain.

Prefer Crls

Boolean

Try CRL instead of OCSP first.

No Fallback

Boolean

Do not use the secondary checking method (the one not selected before).

Soft Fail

Boolean

Avoid verification failure when the revocation server can not be reached or is busy.

Custom Ocsp Responder

Field	Type	Description	Default Value	Required
Url	String	The URL of the OCSP responder.
Cert Alias	String	Alias of the signing certificate for the OCSP response (must be in the trust store), if present.

Field

Type

Description

Default Value

Required

Url

String

The URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response (must be in the trust store), if present.

Crl File

Field	Type	Description	Default Value	Required
Path	String	The path to the CRL file.

Field

Type

Description

Default Value

Required

Path

String

The path to the CRL file.

Reconnection

Field	Type	Description	Default Value	Required
Fails Deployment	Boolean	When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy
Reconnection Strategy	Reconnect Reconnect Forever	The reconnection strategy to use

Field

Type

Description

Default Value

Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy

Reconnection Strategy

Reconnect
Reconnect Forever

The reconnection strategy to use

Reconnect

Field	Type	Description	Default Value	Required
Frequency	Number	How often (in ms) to reconnect
Count	Number	How many reconnection attempts to make

Field

Type

Description

Default Value

Required

Frequency

Number

How often (in ms) to reconnect

Count

Number

How many reconnection attempts to make

Reconnect Forever

Field	Type	Description	Default Value	Required
Frequency	Number	How often (in ms) to reconnect

Field

Type

Description

Default Value

Required

Frequency

Number

How often (in ms) to reconnect

Expiration Policy

Field	Type	Description	Default Value	Required
Max Idle Time	Number	A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration
Time Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit that qualifies the maxIdleTime attribute

Field

Type

Description

Default Value

Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration

Time Unit

Enumeration, one of:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit that qualifies the maxIdleTime attribute

Response Attribute

Field

Type

Description

Default Value

Required

Accept Encoding

String

Cache Control

String

Content Encoding

String

Content Length

String

Content Type

String

Date

String

Others

Object

Pragma

String

Status Code

Number

User Agent

String

Redelivery Policy

Field	Type	Description
Max Redelivery Count	Number	The maximum number of times a message can be redelivered and processed unsuccessfully before triggering process-failed-message
Use Secure Hash	Boolean	Whether to use a secure hash algorithm to identify a redelivered message
Message Digest Algorithm	String	The secure hashing algorithm to use. If not set, the default is SHA-256.
Id Expression	String	Defines one or more expressions to use to determine when a message has been redelivered. This property may only be set if useSecureHash is false.
Object Store	[ObjectStore]	The object store where the redelivery counter for each message is going to be stored.

Field

Type

Description

Default Value

Required

Max Redelivery Count

Number

The maximum number of times a message can be redelivered and processed unsuccessfully before triggering process-failed-message

Use Secure Hash

Boolean

Whether to use a secure hash algorithm to identify a redelivered message

Message Digest Algorithm

String

The secure hashing algorithm to use. If not set, the default is SHA-256.

Id Expression

String

Defines one or more expressions to use to determine when a message has been redelivered. This property may only be set if useSecureHash is false.

Object Store

[ObjectStore]

The object store where the redelivery counter for each message is going to be stored.

Bot Activity

Field

Type

Description

Default Value

Required

Automation Id

String

Automation Name

String

Can Manage

Boolean

Command

String

Created By

String

Created On

String

Current Line

Number

Deployment Id

String

Device Id

String

Device Name

String

End Date Time

String

File Id

String

File Name

String

File Path

String

Message

String

Modified By

String

Modified On

String

Progress

Number

Queue Id

String

Queue Name

String

Start Date Time

String

Status

String

Total Lines

Number

Type

String

User Id

String

User Name

String

Using Rdp

Boolean

Run Bot Async Response

Field	Type	Description	Default Value	Required
Deployment Id	String	The id of the bot deployment		x

Field

Type

Description

Default Value

Required

Deployment Id

String

The id of the bot deployment