add-ins
latest
false
Add-ins User Guide
Last updated Jul 17, 2024

Types

Default Header

Field

Type

Description

Default Value

Required

Key

String

  

Yes

Value

String

  

Yes

Default Query Param

Field

Type

Description

Default Value

Required

Key

String

  

Yes

Value

String

  

Yes

Proxy

Field

Type

Description

Default Value

Required

Host

String

  

Yes

Port

Number

  

Yes

Username

String

   

Password

String

   

Non Proxy Hosts

String

   

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 suitesenabled for this context.

  

Trust Store

Trust Store

   

Key Store

Key Store

   

Revocation Check

Standard Revocation Check

Custom Ocsp Responder

Crl File

   

Trust Store

Field

Type

Description

Default Value

Required

Path

String

The location (which is resolved relative to the current class path 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 are performed, rendering connections vulnerable to attacks. Use at your own risk.

  

Key Store

Field

Type

Description

Default Value

Required

Path

String

The location (which is 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 is 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

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.

  

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 add-ins. If set to true, deployment fails 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.

  

Blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

  

Count

Number

How many reconnection attempts to make.

  

Reconnect Forever

Field

Type

Description

Default Value

Required

Frequency

Number

How often (in ms) to reconnect.

  

Blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

  

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.
  

Http Response Attributes

Field

Type

Description

Default Value

Required

Status Code

Number

  

Yes

Headers

Object

  

Yes

Reason Phrase

String

  

Yes

Repeatable In Memory Stream

Field

Type

Description

Default Value

Required

Initial Buffer Size

Number

This is the amount of memory allocated in order to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then it will be expanded by according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

  

Buffer Size Increment

Number

This is by how much the buffer size is expanded by if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full.

  

Max Buffer Size

Number

This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower or equal to zero means no limit.

  

Buffer Unit

Enumeration, one of:

BYTE

KB

MB

GB

The unit in which all these attributes are expressed.

  

Repeatable File Store Stream

Field

Type

Description

Default Value

Required

In Memory Size

Number

Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it starts to buffer the content on disk.

  

Buffer Unit

Enumeration, one of:

BYTE

KB

MB

GB

The unit in which maxInMemorySize is expressed.

  

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.