requirements object serves two purposes.
First, it functions as a safety net. It specifies the set of entities that must exist for a rule to work as expected. Whenever one or more rule requirements are not met, corresponding errors are shown in the workflow administration UI. The rule is not executed until all of the problems are fixed.
Second, it functions as a reference. Each entity in the requirements is plugged into the
contextobject, so you can reference entities from inside your context-dependent functions (like an
There are two types of requirements: project-wide and system-wide.
Project-wide requirements contain a list of custom fields to be attached to each project which uses the rule as well as the required values from the sets of values for each custom field.
System-wide requirements contain a list of other entities that must be available in YouTrack. This includes users, groups, projects, issues, tags, saved searches, and issue link types.
Here's an example of a requirements statement that includes the definitions for a custom field and the values that are required for this field, followed by a list of system-wide requirements.
Every entity that is specified in the requirements statement is identified by an alias. In the example above, the Priority field is assigned the alias
P. When you assign an alias to an entity in the requirements, you use the alias to reference the entity in context. For example, the Priority field can be referenced as
Each requirement that is specified in the requirements statement has the following properties:
|The data type of the entity. This property is required. Here is the complete list of types for custom fields: |
The following types are used for system-wide entities:
|The name of the entity. This property is optional. If a name is not set, it is considered to be equal to the alias. |
For specific system-wide entities, this property is ignored entirely.
In addition, there are properties that are only available for specific entity types. These properties are listed below:
|Any property that is defined for an entity that is not one of the known properties listed above is considered to be the requirement for a value in the set of values for a custom field. Each |
In the example above, the value
A Boolean property. When
The outward name of the issue link type.
The inward name of the issue link type.
The login for a specific user. Used instead of the
The ID of a specific issue. Used instead of the