Nav

BMC Remedy Connector Reference

Configuration

Parameters

Name Type Description Default Value Required

Name

String

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

x

Connection

Basic Configuration

The connection types that can be provided to this configuration.

x

Expiration Policy

ExpirationPolicy

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 expires the instance at the exact moment that it becomes eligible. The runtime purges the instances as it sees fit.

Basic Configuration Type

Parameters

Name Type Description Default Value Required

Username

String

The username required to authenticate the end user.

x

Password

String

The password associated with the username.

x

Server

String

The remedy server URL that we want to connect.

x

Server Port

Number

The serverPort which we want to use.

Authentication

String

Locale

String

Reconnection

Reconnection

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

Cache Timeout Seconds

Number

3600

Attachment As String

Boolean

true

Enum As Id

Boolean

false

Operations

  • Create

  • Create Single

  • Delete Entry

  • Disconnect Server

  • Get

  • Get Single

  • Query

  • Update

  • Update Single

  • Upsert

  • Upsert Single

Create

<remedy:create>

Creates the entries in the specified Remedy form.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Remedy Form Type

String

The Remedy Form to use.

x

Entry

Array of Object

A list of maps representing the objects to create.

#[payload]

Target Variable

String

The name of a variable in which the operation’s output is placed.

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

Array of String

For Configurations

  • config

Throws

  • REMEDY:RETRY_EXHAUSTED

  • REMEDY:CONNECTIVITY

Create Single

<remedy:create-single>

Creates a single entry in the specified Remedy form.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Remedy Form Type

String

The Remedy Form to use.

x

Entry

Object

A map representing the object to create.

#[payload]

Target Variable

String

The name of a variable in which the operation’s output is placed.

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression ide stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • config

Throws

  • REMEDY:RETRY_EXHAUSTED

  • REMEDY:CONNECTIVITY

Delete Entry

<remedy:delete-entry>

Removes the form entry with the indicated ID from the specified server. You can delete entries from base forms only. To remove entries from join forms, delete them from the underlying base forms.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Remedy Form Type

String

The Remedy Form that containing the entry

x

Entry ID

String

The ID of the entry to be deleted.

x

Delete Option

Number

Specify 0 for this parameter (reserved for future use).

x

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

For Configurations

  • config

Throws

  • REMEDY:RETRY_EXHAUSTED

  • REMEDY:CONNECTIVITY

Disconnect Server

<remedy:disconnect-server>

Allow for manual disconnection from server.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

For Configurations

  • config

Throws

  • REMEDY:RETRY_EXHAUSTED

  • REMEDY:CONNECTIVITY

Get

<remedy:get>

Gets the entries with the specified IDs in the specified Remedy form.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Remedy Form Type

String

The Remedy Form to use.

x

Entry ID

Array of String

A list containing the IDs for the objects to be retrieved

#[payload]

Results use Field IDs

Boolean

Optional - Whether the returned value uses the field ID as the key.

false

Target Variable

String

The name of a variable in which the operation’s output is placed.

Target Value

String

An expression to evaluate against the operation’s output, and to store the outcome of that expression in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

Array of Object

For Configurations

  • config

Throws

  • REMEDY:RETRY_EXHAUSTED

  • REMEDY:CONNECTIVITY

Get Single

<remedy:get-single>

Gets the single entry with the specified ID in the specified Remedy form.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Remedy Form Type

String

The Remedy Form to use.

x

Entry ID

String

The ID of the object to retrieve.

#[payload]

Result uses Field IDs

Boolean

Optional - Whether the returned value uses the field ID as the key.

false

Target Variable

String

The name of a variable in which the operation’s output is placed.

Target Value

String

An expression to evaluate against the operation’s output, and to store the outcome of that expression in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

  • config

Throws

  • REMEDY:RETRY_EXHAUSTED

  • REMEDY:CONNECTIVITY

Query

<remedy:query>

Gets the entries in the specified Remedy form that match the query string.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Remedy Form Type

String

The Remedy Form to use.

x

Query

String

The qualification string to be parsed

#[payload]

Result with Field ID

Boolean

Optional - Whether the returned value uses the field ID as the key.

false

Target Variable

String

The name of a variable in which the operation’s output is placed.

Target Value

String

An expression to evaluate against the operation’s output, and to store the outcome of that expression in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

Array of Object

For Configurations

  • config

Throws

  • REMEDY:RETRY_EXHAUSTED

  • REMEDY:CONNECTIVITY

Update

<remedy:update>

Updates the entries in the specified Remedy form.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Remedy Form Type

String

The Remedy Form to use.

x

Entry

Array of Object

A list of maps representing the new versions of the objects to be updated.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

For Configurations

  • config

Throws

  • REMEDY:RETRY_EXHAUSTED

  • REMEDY:CONNECTIVITY

Update Single

<remedy:update-single>

Updates the single entry in the specified Remedy form.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Remedy Form Type

String

The Remedy Form to use.

x

Entry

Object

A map representing the new version of the object to be updated.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

For Configurations

  • config

Throws

  • REMEDY:RETRY_EXHAUSTED

  • REMEDY:CONNECTIVITY

Upsert

<remedy:upsert>

Creates the entries in the specified Remedy form.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Remedy Form Type

String

The Remedy Form to use.

x

Entry

Array of Object

A list of maps representing the objects to be created or updated.

#[payload]

Target Variable

String

The name of a variable in which the operation’s output is placed.

Target Value

String

An expression to evaluate against the operation’s output, and to store the outcome of that expression in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

Array of String

For Configurations

  • config

Throws

  • REMEDY:RETRY_EXHAUSTED

  • REMEDY:CONNECTIVITY

Upsert Single

<remedy:upsert-single>

Upserts the single entry in the specified Remedy form.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Remedy Form Type

String

The Remedy Form to use.

x

Entry

Object

A map representing the object to be created or updated

#[payload]

Target Variable

String

The name of a variable in which the operation’s output is placed.

Target Value

String

An expression to evaluate against the operation’s output, and to store the outcome of that expression in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

  • config

Throws

  • REMEDY:RETRY_EXHAUSTED

  • REMEDY:CONNECTIVITY

Reconnection Type

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 fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Reconnection Strategy

  • reconnect

  • reconnect-forever

The reconnection strategy to use.

Reconnect Type

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

Count

Number

How many reconnection attempts to make.

Reconnect Forever Type

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds 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.