This documentation supports the 9.1 version of Remedy Action Request System.

To view the latest version, select the version from the Product version menu.

Server object actions and structures

The ARCreate Object, ARGet Object, and ARSet Object functions for filters, escalations, and active links have an actionList parameter that defines the set of one or more actions performed for entries that match the associated qualification. Because the actions available for filters and escalations are different from those for active links, the actions associated with these objects are represented by different data structures.

For filters and escalations, the actionList parameter is a pointer to an ARFilterActionList structure (see the following figure).

Structures used to define filter or escalation actions 

 

ARFilterActionList contains zero or more ARFilterActionStruct items. Each ARFilterActionStruct represents one filter or escalation action and has the following elements:

Action Type

Integer that specifies the type of action (see the following table).

Action Definition

Action to perform (represented by data types or structures appropriate to the type of action).


1

AR_FILTER_ACTION_NOTIFY

Send a notification to the specified user.

2

AR_FILTER_ACTION_MESSAGE

Display the specified message (filters only).

3

AR_FILTER_ACTION_LOG

Write the specified text to a log file.

4

AR_FILTER_ACTION_FIELDS

Set values for the specified fields.

5

AR_FILTER_ACTION_PROCESS

Execute the specified command.

6

AR_FILTER_ACTION_FIELDP

Transfer, or push, data from a field in the current request to a field in a request of another schema on the same server.

7

AR_FILTER_ACTION_SQL

Perform the specified SQL statements.

8

AR_FILTER_ACTION_GOTOACTION

Go to the filter with the specified execution order.

9

AR_FILTER_ACTION_CALLGUIDE

Perform the specified guide.

10

AR_FILTER_ACTION_EXITGUIDE

Exit the current guide or all guides.

11

AR_FILTER_ACTION_GOTOGUIDELABEL

Go to the filter with the specified guide label in the current guide.

12

AR_FILTER_ACTION_SERVICE

Return a result without making a database change.

For active links, the actionList parameter is a pointer to an ARActiveLinkActionList structure (see the following figure).

Structures used to define active link actions


The ARActiveLinkActionList structure contains zero or more ARActiveLinkActionStruct items. Like ARFilterActionStruct, each ARActiveLinkActionStruct represents one active link action and has the following elements:

Action Type

Integer that specifies the type of action (see the following table).

Action Definition

Action to perform (represented by data types or structures appropriate to the type of action).


1

AR_ACTIVE_LINK_ACTION_MACRO

Execute the specified macro.

2

AR_ACTIVE_LINK_ACTION_FIELDS

Set values for the specified fields.

3

AR_ACTIVE_LINK_ACTION_PROCESS

Execute the specified command.

4

AR_ACTIVE_LINK_ACTION_MESSAGE

Display the specified message.

5

AR_ACTIVE_LINK_ACTION_SET_CHAR

Set characteristics for the specified field.

6

AR_ACTIVE_LINK_ACTION_DDE

Perform the specified DDE action.

7

AR_ACTIVE_LINK_ACTION_FIELDP

Transfer, or push, data from a field in the current request to a field in a request of another schema on the same server.

8

AR_ACTIVE_LINK_ACTION_SQL

Perform the specified SQL statements.

9

AR_ACTIVE_LINK_ACTION_AUTO

Perform the specified OLE automation.

10

AR_ACTIVE_LINK_ACTION_OPENDLG

Open a schema as a modal dialog.

11

AR_ACTIVE_LINK_ACTION_COMMITC

Commit changes from a dialog to the parent schema window.

12

AR_ACTIVE_LINK_ACTION_CLOSEWND

Close a dialog or schema window.

13

AR_ACTIVE_LINK_ACTION_CALLGUIDE

Perform the specified guide.

14

AR_ACTIVE_LINK_ACTION_EXITGUIDE

Exit the current guide or all guides.

15

AR_ACTIVE_LINK_ACTION_GOTOGUIDELABEL

Go to the active link with the specified guide label in the current guide.

16

AR_ACTIVE_LINK_ACTION_WAIT

Make the current guide wait for user input.

17

AR_ACTIVE_LINK_ACTION_GOTOACTION

Go to the active link with the specified execution order.

18

AR_ACTIVE_LINK_ACTION_SERVICE

Return a result without making a database change.

Was this page helpful? Yes No Submitting... Thank you

Comments