BMC Remedy Connector Reference | MuleSoft Documentation
# BMC Remedy Connector Reference
BMC Remedy Connector v3.0
Release Notes: BMC Remedy Connector Release Notes
## Configuration
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
The name for this configuration. Connectors reference the configuration with this name.  
Connection |  Basic Configuration | The connection types that can be provided to this configuration.  
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 | The username required to authenticate the end user.  
Password | The password associated with the username.  
The remedy server URL that we want to connect.  
Server Port | The serverPort which we want to use.  
Authentication  
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  
Attachment As String  
Enum As Id  
## Operations
  * Create
  * Create Single
  * Delete Entry
  * Disconnect Server
  * 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 | The name of the configuration to use.  
Remedy Form Type | The Remedy Form to use.  
Array of Object | A list of maps representing the objects to create. | `#[payload]`  
Target Variable | The name of a variable in which the operation’s output is placed.  
Target Value | 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
Array of String  
---  
### For Configurations
### 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 | The name of the configuration to use.  
Remedy Form Type | The Remedy Form to use.  
A map representing the object to create. | `#[payload]`  
Target Variable | The name of a variable in which the operation’s output is placed.  
Target Value | 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.  
### For Configurations
### 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 | The name of the configuration to use.  
Remedy Form Type | The Remedy Form that containing the entry  
Entry ID | The ID of the entry to be deleted.  
Delete Option | Specify 0 for this parameter (reserved for future use).  
Reconnection Strategy | 
  * reconnect
  * reconnect-forever

| A retry strategy in case of connectivity errors.  
### For Configurations
### 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 | The name of the configuration to use.  
Reconnection Strategy | 
  * reconnect
  * reconnect-forever

| A retry strategy in case of connectivity errors.  
### For Configurations
### Throws
  * REMEDY:RETRY_EXHAUSTED
  * REMEDY:CONNECTIVITY


`<remedy:get>`
Gets the entries with the specified IDs in the specified Remedy form.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Remedy Form Type | The Remedy Form to use.  
Entry ID |  Array of String | A list containing the IDs for the objects to be retrieved | `#[payload]`  
Results use Field IDs | Optional - Whether the returned value uses the field ID as the key.  
Target Variable | The name of a variable in which the operation’s output is placed.  
Target Value | 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
Array of Object  
---  
### For Configurations
### 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 | The name of the configuration to use.  
Remedy Form Type | The Remedy Form to use.  
Entry ID | The ID of the object to retrieve. | `#[payload]`  
Result uses Field IDs | Optional - Whether the returned value uses the field ID as the key.  
Target Variable | The name of a variable in which the operation’s output is placed.  
Target Value | 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.  
### For Configurations
### 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 | The name of the configuration to use.  
Remedy Form Type | The Remedy Form to use.  
The qualification string to be parsed | `#[payload]`  
Result with Field ID | Optional - Whether the returned value uses the field ID as the key.  
Target Variable | The name of a variable in which the operation’s output is placed.  
Target Value | 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
Array of Object  
---  
### For Configurations
### 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 | The name of the configuration to use.  
Remedy Form Type | The Remedy Form to use.  
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
### 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 | The name of the configuration to use.  
Remedy Form Type | The Remedy Form to use.  
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
### 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 | The name of the configuration to use.  
Remedy Form Type | The Remedy Form to use.  
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
### 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 | The name of the configuration to use.  
Remedy Form Type | The Remedy Form to use.  
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
### 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 | The name of the configuration to use.  
Remedy Form Type | The Remedy Form to use.  
Array of Object | A list of maps representing the objects to be created or updated. | `#[payload]`  
Target Variable | The name of a variable in which the operation’s output is placed.  
Target Value | 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
Array of String  
---  
### For Configurations
### 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 | The name of the configuration to use.  
Remedy Form Type | The Remedy Form to use.  
A map representing the object to be created or updated | `#[payload]`  
Target Variable | The name of a variable in which the operation’s output is placed.  
Target Value | 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.  
### For Configurations
### Throws
  * REMEDY:RETRY_EXHAUSTED
  * REMEDY:CONNECTIVITY


## Reconnection Type
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Fails Deployment | 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  
---|---|---|---|---  
How often to reconnect (in milliseconds).  
The number of reconnection attempts to make.  
If false, the reconnection strategy runs in a separate, non-blocking thread.  
## Reconnect Forever Type
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
How often in milliseconds to reconnect.  
If false, the reconnection strategy runs in a separate, non-blocking thread.  
## Expiration Policy
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Max Idle Time | 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

| A time unit that qualifies the maxIdleTime attribute.  
## See Also
MuleSoft Help Center