DT489 Process rules
Below, you will find descriptions of the process rule parameters (process rule data fields) which are used in standard modules.
DI041217 Process rule ID
The ID of the process rule is generated automatically upon its creation.
DI041228 Process rule
Name of the process rule which is defined in the Rule DI041230 field
Modifiable
- in the Process Rules module,
- provided that the modifying user possesses the required rights
DI041229 Comment
Comment on the process rule
Modifiable
- in the Process Rules module,
- provided that the modifying user possesses the required rights
DI057862 Class
Name (incarnation field) of the process rule class. Here you can define whether the process rule is written in Python or SQL.
Modifiable
- in the Process Rules module,
- provided that the modifying user possesses the required rights
Note
- In the Process Rules module, this field is a mandatory field.
DI057966 Object type
Name (incarnation field) of the planning object type. Here you can define whether the rule is available for projects, ideas, proposals or requests.
Modifiable
- in the Process Rules module,
- provided that the modifying user possesses the required rights
Note
- This field is a required field.
DI059086 Rule type
Name (incarnation field) of the rule type. Here you can define whether the process rule is a process action (e.g. create status report or change project type) or a check rule (e.g. Project manager field is filled).
Modifiable
- in the Process Rules module,
- provided that the modifying user possesses the required rights
Details
- The values in this field define whether the process rule in the Process Model Templates module is displayed in the listbox on the Process rule or Process action field.
Note
- In the Process Rules module, this field is a mandatory field.
DI041230 Rule
Here, the process rule by which the completion of the process step is checked is defined.
Modifiable
- in the Process Rules module,
- provided that the modifying user possesses the required rights
Information
- Process rules are provided by the customizer.
- Rules are SQL statements or Python methods that are performed when a process step is being checked.
- For process rules that are written with Python methods, the Rule field is automatically filled with the default lines (initial line, return line and end line) for the particular rule type.
Methods | Definition |
---|---|
SQL statements | If it is a quantity check of multiple fields at project level, the columns of the select statement must be filled with a placeholder since they are read out from the rule parameters of the process steps. Example: Check on project check rule. This rule checks columns from the project table on the basis of rule parameters stored in the master data.
If it is a check on quality or frequency of use, a placeholder must be defined for the search criterion. Example: UF risks check rule. This rule checks whether risks have already been defined for the current project.
|
Python method | The "computeProcessRule" method is used for check rules and is handed down to the data item object. General structure of a check rule:
Example: Check on project check rule. This rule checks columns from the project table on the basis of rule parameters stored in the master data.
PY
Details
The "executeProcessAction" method is used for process actions and is inherited by the data item object. General check rule structure:
Example: Create status report process action:
PY
|
Note
- Several process rules are already included in the scope of supply of PLANTA project.