BMC Helix Operations Management connector documentation reference

Name

String

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

x 

Connection

Connection

The connection types that can be provided to this configuration.

x 

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.

Server URL

String

x 

Access Key

String

x 

Secret Key

String

x 

Tenant ID

String

x 

Connection Timeout

Number

5000

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

Host

String

Port

Number

Username

String

Password

String

NTLM Domain

String

Configuration

String

The name of the configuration to use.

x 

Event Class

String

x 

Event Id

String

Input Payloads

Binary

 #[payload]

Streaming Strategy

• Repeatable In Memory Stream
• Repeatable File Store Stream

Configure if repeatable streams should be used and their behavior

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

Type

Any

Attributes Type

Response Status

Configuration

String

The name of the configuration to use.

x 

Event Class

String

x 

Input Payloads

Binary

 #[payload]

Streaming Strategy

• Repeatable In Memory Stream
• Repeatable File Store Stream

Configure if repeatable streams should be used and their behavior

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

Type

Any

Attributes Type

Response Status

Configuration

String

The name of the configuration to use.

x 

Get Event Payload

Any

#[payload]

Event Class

String

x 

Event Id

String

Streaming Strategy

• Repeatable In Memory Stream
• Repeatable File Store Stream

Configure if repeatable streams should be used and their behavior

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

Type

Binary

Attributes Type

Response Status

Configuration

String

The name of the configuration to use.

x 

Search Payload

Any

#[payload]

Severity

String

Status

String

Message

String

Maximum Processed Records

String

Maximum Records Per Page

String

Event Class

String

x 

Streaming Strategy

• Repeatable In Memory Stream
• Repeatable File Store Stream

Configure if repeatable streams should be used and their behavior

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

Type

Binary

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

Frequency

Number

How often (in ms) to reconnect

Count

Number

How many reconnection attempts to make

Frequency

Number

How often (in ms) to reconnect

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

Headers

Object

Status Code

Number

Initial Buffer Size

Number

This is the amount of memory that will be 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 will be buffer size by expanded if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be 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 will be 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

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 will start to buffer the content on disk.

Buffer Unit

Enumeration, one of:

• BYTE
• KB
• MB
• GB

The unit in which maxInMemorySize is expressed