You are here:
InsPolicyService:invokeRules
Use this service to invoke state transition rules associated with a target state transaction on a target policy. If the rules satisfy the transition criteria, this service executes actions associated with the transition, optionally logs the results of the rule executions, and transitions the target policy to the new state.
How It Works
-
This service retrieves the object specified by the policyId option.
-
Based on the object type, the object's current state, and the toState option, the target state transition is determined.
-
From the state transition, state transition rules, and state transition rule actions, product rules are retrieved and executed.
-
If the state transition rules satisfy the transition completion criteria specified on the state transition, the object is transitioned to the toState.
If the state transition has an action associated with it, that action is executed.
If the transition completion criteria is not satisfied, the object is transitioned to the Alternate state specified on the state transition if it exists. If the state transition has no Alternate state, the object retains its current state.
-
If the logResults option is specified, the results from each rule and the result of the object transaction (success or failure) is logged.
Remote Options
Option |
Description |
|---|---|
policyID |
Required. ID of target policy for which to apply rules against |
toState |
Required State to move target object to based on state transition criteria |
lastDefaultState |
Optional Name of last default state of target object |
invokeStateTransitionRules |
Optional true Use to have state transition rules invoked. This is the default. false Use if you do not want to invoke state transition rules. |
invokeProductRules |
Optional true Use to have product rules invoked. This is the default. false Use if you do not want to invoked product rules. |
invokeActionType |
Optional If specified, indicates the type of actions to invoke if criteria is fulfilled. The default setting is default. default Only execute default actions associated with the state transition all Execute all actions associated with the state transition none Do not invoke any actions associated with the state transition |
actionScope |
Optional If specified, indicates if invoked actions must be defined on the current state model version or on any state model versions. The default setting is version. version Only execute actions associated with the current state model version any Execute actions associated with any state model version |
logResults |
Optional true Use to have results logged. This is the default. false Use if you do not want to log results. |
fromNoneState |
Optional true Object is transitioning from None state. false Object is not transitioning from None state. This is the default. |
Input JSON
The following example shows sample input JSON.
{
"objectId": "02i3h0000009OqCAAU",
"toState": "Review",
"lastDefaultState": "Draft",
"invokeActionType": "draft",
"actionScope": "version",
"logResults": true,
"fromNoneState": false
}Output JSON
The following example shows sample output JSON.
{
"transition": true,
"transitedState": "Review",
"stateTransitionRules": {
"result": true,
"ruleDetails": [{
"result": true,
"conditions": "Asset.Status == 'Draft'",
"name": "Status is Draft",
"ruleId": "a5Q6g0000005vSPEAY",
"transitionName": "Draft > Review",
"objId": "02i3h0000009OqCAAU"
}, {
"result": false,
"conditions": "Asset.Name == 'Test'",
"name": "Name is Test",
"ruleId": "a5Q6g0000005vSPEAZ",
"transitionName": "Draft > Review",
"objId": "02i3h0000009OqCAAU"
}]
},
"productRules": {
"allFalse": false,
"trueRules": {
"Asset": [{
"ruleDetails": {
"ruleId": "a5Q6g0000005vSPEBX",
"objectId": "02i3h0000009OqCAAU",
"transitionName": "Draft > Review",
"productId": "01t6g000000RzFAAA0",
"action class": null,
"action method": null,
"message": "Name is not blank",
"conditions": "Asset.Name != ''",
"requirement name": "Name is not blank"
}
}]
},
"falseRules": {
"Asset": [{
"ruleDetails": {
"ruleId": "a5Q6g0000005vSPEBX",
"objectId": "02i3h0000009OqCAAU",
"transitionName": "Draft > Review",
"productId": "01t6g000000RzFAAA0",
"action class": null,
"action method": null,
"message": "Name is blank",
"conditions": "Asset.Name == ''",
"requirement name": "Name is blank"
}
}]
}
}
}Result Description
result
ruleDetails
This JSON includes the following key/value pairs.
Key |
Value |
|---|---|
result |
Result of rule condition evaluation against target object |
conditions |
Rule condition |
name |
Name of rule |
ruleId |
Rule Id |
transitionName |
Name of transition associated with rule |
objId |
Object ID that rules were executed against |
