BMC Remedy Action Request System enables you to automate many business processes without learning a programming language or complex development tools.

This connector provides access to the Remedy AR System API.

Additional Info

Requires Mule Enterprise License

Yes  

Requires Entitlement

No  

Mule Version

3.5.0 or higher

Configs

Configuration

<remedy:config>

Connection Management

Attributes

Name Java Type Description Default Value Required

name

String

The name of this configuration. With this name can be later referenced.

x 

username

String

A username

x 

password

String

A password

x 

server

String

x 

serverPort

Integer

 

authentication

String

 

locale

String

 

cacheTimeoutSeconds

Long

3600

 

attachmentAsString

Boolean

true

 

enumAsId

Boolean

false

 

Processors

Disconnect server

<remedy:disconnect-server>

Allow for manual disconnection from server

XML Sample

<remedy:disconnect-server config-ref="Remedy__Configuration"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

Create single

<remedy:create-single>

  DataSense enabled

Creates the single entry in the specified Remedy form.

XML Sample

<remedy:create-single config-ref="Remedy__Configuration" type="User">
        <remedy:object>
             <remedy:inner-object key="2">Admin</remedy:inner-object>
             <remedy:inner-object key="7">Current</remedy:inner-object>
             <remedy:inner-object key="8">Description</remedy:inner-object>
             <remedy:inner-object key="Login Name">Mark</remedy:inner-object>
        </remedy:object>
    </remedy:create-single>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

type

String

The Remedy Form to use

x 

object

Map<String,Object>

A map representing the object to create

#[payload]

 

Returns

Return Java Type Description

String

String representing the Id of the created object

Create

<remedy:create>

  DataSense enabled

Creates the entries in the specified Remedy form.

XML Sample

<remedy:create config-ref="Remedy__Configuration" type="User">
            <remedy:objects>
                <remedy:object>
                     <remedy:inner-object key="2">Admin</remedy:inner-object>
                     <remedy:inner-object key="7">Current</remedy:inner-object>
                     <remedy:inner-object key="8">Description</remedy:inner-object>
                     <remedy:inner-object key="Login Name">Mark</remedy:inner-object>
                </remedy:object>
            </remedy:objects>
    </remedy:create>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

type

String

The Remedy Form to use

x 

objects

List<Map<String,Object>>

A list of maps representing the objects to create

#[payload]

 

Returns

Return Java Type Description

List<String>

A list containing Ids for created objects

Get single

<remedy:get-single>

  DataSense enabled

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

XML Sample

<remedy:get-single config-ref="Remedy__Configuration" type="User" id="000000000000533"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

type

String

The Remedy Form to use

x 

id

String

The Id of the object to retrieve

#[payload]

 

idBased

Boolean

Optional whether returned value will use field id as key

 

Returns

Return Java Type Description

Map<String,Object>

Returns the specified entry on success

Get

<remedy:get>

  DataSense enabled

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

XML Sample

<remedy:get config-ref="Remedy__Configuration" type="User">
                <remedy:ids ref="[&quot;000000000000533&quot;,&quot;000000000000534&quot;,&quot;000000000000535&quot;]"/>
        </remedy:get>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

type

String

The Remedy Form to use

x 

ids

List<String>

A list containing the Ids for the objects to be retrieved

#[payload]

 

idBased

Boolean

Optional whether returned value will use field id as key

 

Returns

Return Java Type Description

List<Map<String,Object>>

Returns the specified entry on success

Update single

<remedy:update-single>

  DataSense enabled

Updates the single entry in the specified Remedy form.

XML Sample

<remedy:update-single config-ref="Remedy__Configuration" type="User">
                <remedy:object>
             <remedy:inner-object key="2">Admin</remedy:inner-object>
             <remedy:inner-object key="7">Current</remedy:inner-object>
             <remedy:inner-object key="8">Description</remedy:inner-object>
             <remedy:inner-object key="Login Name">Brett</remedy:inner-object>
             <remedy:inner-object key="Request ID">000000000000533</remedy:inner-object>
        </remedy:object>
    </remedy:update-single>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

type

String

The Remedy Form to use

x 

object

Map<String,Object>

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

#[payload]

 

Update

<remedy:update>

  DataSense enabled

Updates the entries in the specified Remedy form.

XML Sample

<remedy:update config-ref="Remedy__Configuration" type="User">
                <remedy:objects>
                        <remedy:object>
                     <remedy:inner-object key="2">Admin</remedy:inner-object>
                     <remedy:inner-object key="7">Current</remedy:inner-object>
                     <remedy:inner-object key="8">Description</remedy:inner-object>
                     <remedy:inner-object key="Login Name">Brett</remedy:inner-object>
                     <remedy:inner-object key="Request ID">000000000000533</remedy:inner-object>
                </remedy:object>
        </remedy:objects>
    </remedy:update>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

type

String

The Remedy Form to use

x 

objects

List<Map<String,Object>>

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

#[payload]

 

Query

<remedy:query>

  DataSense enabled

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

XML Sample

<remedy:query config-ref="Remedy__Configuration" type="User" query="'Login Name'=&quot;John&quot;"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

type

String

The Remedy Form to use

x 

query

String

The qualification string to be parsed

#[payload]

 

idBased

Boolean

Optional whether returned value will use field id as key

 

Returns

Return Java Type Description

List<Map<String,Object>>

A list of maps representing the query result

Upsert single

<remedy:upsert-single>

  DataSense enabled

Upserts the single entry in the specified Remedy form.

XML Sample

<remedy:upsert-single config-ref="Remedy__Configuration" type="User">
                <remedy:object>
             <remedy:inner-object key="2">Admin</remedy:inner-object>
             <remedy:inner-object key="7">Current</remedy:inner-object>
             <remedy:inner-object key="8">Description</remedy:inner-object>
             <remedy:inner-object key="Login Name">John</remedy:inner-object>
             <remedy:inner-object key="Request ID">000000000000533</remedy:inner-object>
        </remedy:object>
    </remedy:upsert-single>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

type

String

The Remedy Form to use

x 

object

Map<String,Object>

A map representing the object to be created or updated

#[payload]

 

Returns

Return Java Type Description

String

Returns the entry ID on successful creation

Upsert

<remedy:upsert>

  DataSense enabled

Creates the entries in the specified Remedy form.

XML Sample

<remedy:upsert config-ref="Remedy__Configuration" type="User">
                <remedy:objects>
                        <remedy:object>
                     <remedy:inner-object key="2">Admin</remedy:inner-object>
                     <remedy:inner-object key="7">Current</remedy:inner-object>
                     <remedy:inner-object key="8">Description</remedy:inner-object>
                     <remedy:inner-object key="Login Name">John</remedy:inner-object>
                </remedy:object>
        </remedy:objects>
    </remedy:upsert>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

type

String

The Remedy Form to use

x 

objects

List<Map<String,Object>>

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

#[payload]

 

Returns

Return Java Type Description

List<String>

A list containing the ids of the created objects