Sets a user ID as the authenticated user ID of the current context/session.
The Set authenticated user step allows to set a user ID as the authenticated user ID in the current context/session and thereby, sets the current context/session as authenticated.
The user ID is set using the User ID property.
Note: Although its Output property is set to false by default, this step generates an authenticatedUserID XML Element in output, that should always contain the user ID value if the step succeeds.
Property | Type | Category | Description |
---|---|---|---|
Comment | String | standard | Describes the object comment to include in the documentation report. This property generally contains an explanation about the object. |
Is active | boolean | standard | Defines whether the step is active. |
User ID | SmartType | standard | Defines the user ID that has to be set as authenticated user. This property is a “smart type” property, that allows to define the user ID to set in authentication. A “smart type” property can be of one of the following types: • a text: the value is therefore a default text value, • a JavaScript expression: the value is therefore a JavaScript expression that is evaluated at sequence execution, • a source: the value is a source and can be picked using the source picker. A source is defined as a reference on a step previously existing in the parent sequence, associated with an XPath applied on the step’s result DOM. At runtime, the XPath is applied on the step’s current execution result XML and extracts a list of XML nodes resulting from this execution. Note: If you use the source type for this property, the XPath application on target XML should give a text result. Otherwise, the first node’s text content is taken. |
Output | boolean | expert | Defines whether the XML generated by this step should be appended to the resulting XML. Set this property to true to add the step’s resulting XML to the sequence’s output XML (default value for steps generating XML). Set this property to false to prevent the steps’s XML result to appear in the sequence’s output XML. Setting this property to false does not prevent the step’s generated XML from being used as a source by other steps. |