Rule
A rule consists of general information and rule parameters. The general information is described below.
Figure 81 Rules
Field | Contents | Type |
---|---|---|
Name | Name for the rule | 140 chars |
Description | Description of the rule | 255 chars |
Implementation class | Full classname, the java implementation for this rule | 255 chars |
Locked | Once a rule has been locked, it is impossible to modify or change the rule parameters. Rules which are used in a default AvantGard Trax implementation and do not have to be modified later on (e.g. specifying an output directory must also be possible later on) will be locked to prevent accidental erasure or modifications. Take care with this feature as once a rule has been created and locked, it is not possible to modify this self-created rule anymore either. The only recourse is to delete the entire rule and rewrite it. The rule cannot be unlocked. | T/F |
Input Class | GUI class which will provide the input for the rule. | 255 chars |
Output Class | GUI class which will handle the output of the rule. | 255 chars |
Table 81 Rules
The Rule parameters are listed under the rule parameters tab and can be edited, added or deleted as necessary (unless the rule has been locked).
Figure 82 Rule Parameters
The parameter details are configured in the detail screen shown below.
Figure 83 Rule Parameter Details
Field | Contents | Type |
---|---|---|
Name | Name of the parameter | 140 chars |
Data Type | The parameter type | Selection |
Class Name | The class of custom created code. This is a technical reference to a JAVA component and reserved for custom integration. | 255 chars |
Type | The parameter type | Selection |
Description | Description of the rule parameter | 255 chars |
Required | Set to true if this parameter is required | T/F |
Default Value | Default value for the parameter. | 255 chars |
Table 82 Rule Parameter Details