CreateAssignmentValve

Valve for creating an Assignment.

An assignment template is required. The assignment template can be supplied in the request (using property expansion), inline in configuration or in an external file.

The assignment template support property expansion and a custom rendering context can be supplied as a JSON hash. Values in custom context will be translated/localized before rendering.

Note: the assignment template is expanded twice meaning that it is possible to provide a template containing expansion properties in the request .

The following scopes are available during template rendering:

  • item - the current item
  • request - request parameters
  • attributes - flow attributes
  • system - system properties
  • context - custom context
  • now - ISO timestamp


Supports creating assignments on a remote PhenixID server using the authentication API.

Properties

Name Description Default value Mandatory Supports property expansion
uid The unique identifier for user assigned to this assignment 
YES YES
dest Item destination property receiving the assignment identifier assignment_id NO NO
template The assignment template
YES (unless template_path is specified) NO
template_path Path to the assignment template
NO NO
template_context Assignment template rendering context
NO YES





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": "CreateAssignmentValve",
	"config": {
		"uid": "{{request.uid}}",
		"template_path": "/path/to/assignment_template.json",
		"template_context": "{\"yes\":\"common.messages.yes\", \"no\":\"common.messages.no\"}",
		"api_base_url": "http://host:8888/api/authentication/onetouch",
		"api_tenant": "default",
		"api_username": "system",
		"api_password": "password"
	}
}
Click to copy

See also

OneTouch/IssueAssignmentValve - valve creating an assignment designed to be used in an authentication scenario.