Automation Services Application Program Interface › $RECALL SERVICE=ACTION

$RECALL SERVICE=ACTION

This API procedure function call activates or inactivates a rule set.

Syntax

This API procedure function call has the following format:

$RECALL SERVICE=ACTION
        ACTION={ACT|INACT}
        NAME=‘RULESET=rulesetname’

Operands

This API procedure function call has the following operands:

SERVICE=ACTION

Specifies that an action is to be performed on a rule set.

ACTION={ACT|INACT}

Specifies that the rule set is to be activated or inactivated.

NAME=‘RULESET=rulesetname’

Specifies the name of the rule set to be activated or inactivated.

Return Variable

This API procedure function call returns the following variable:

&SYSMSG

Contains the returned message.

Return Codes

Return codes indicate the success or failure of processing. This API procedure function call returns the following return codes in the &RETCODE variable:

0

Indicates that processing was successful.

8

Indicates that processing failed.

16

Indicates that error occurred in the call syntax.

Example: Activate a Rule Set

This example activates rule set SET01:

$RECALL SERVICE=ACTION ACTION=ACT NAME='RULESET=SET01'

Example: Inactivate a Rule Set

This example inactivates rule set SET01:

$RECALL SERVICE=ACTION ACTION=INACT NAME='RULESET=SET01'