AssertAssignmentStatusValve
Valve for asserting the status of an assignment.
If assignment status is not equal to the expected status before timeout; valve will fail.
Supports getting assignments from a remote PhenixID server using the authentication API.
Properties
Name | Description | Default value | Mandatory | Supports property expansion |
---|---|---|---|---|
id | The id of the assignment to assert | YES | YES | |
expected | The expected status | YES | NO | |
timeout | Time out in milliseconds to wait for the expected status | 0 | NO | NO |
initial_wait |
Wait time before assignment polling starts | 1000 | NO | NO |
wait | Wait interval between assignment polls | 1000 | NO | NO |
api_base_url |
API base url. If configured, valve will use API instead of local call to create assignment. |
NO | NO | |
api_tenant |
API tenant identifier |
NO | NO | |
api_username |
API username |
NO | NO | |
api_password |
API password |
NO | NO | |
Example configuration
{ "name": "AssertAssignmentStatusValve", "config": { "id": "{{item.assignment_id}}", "expected": "CONFIRMED", "timeout": "5000", "api_base_url": "http://host:8888/api/authentication/onetouch", "api_tenant": "default", "api_username": "system", "api_password": "password" } }
Assignment status
See below for list of valid assignment status values:
Name | Description |
---|---|
PENDING | Assignment created but not yet downloaded |
IN_PROGRESS |
Assignment is downloaded |
CONFIRMED | Assignment confirmed by user |
REJECTED | Assignment rejected by user |
ERROR | Assignment in error |