Show TOC

Function documentationRule Design Locate this document in the navigation structure

 

The system administrator can use the functions in Rule Design to configure rules to model business processes. To access the Rule Design list page, choose   Setup   System Setup   Integration   Rule Design  . Choose New to launch a wizard to step you through the creation process.

Field Help for Rule Design Parameters

Note Note

All rule design parameters in the wizard are required. You cannot change the parameters once you proceed to the next screen in the wizard. The combination of values for the parameters must be unique.

End of the note.

Field Name

Description

Rule Design Context

The context determines the event that triggers the rules. Select one of the following:

  • Document Lifecycle

  • Field Validation

  • Toolbar

  • Field Data Edit

  • Import Lifecycle Event

This is a required field

Application Context

Select the application context for which the rules should be executed. This shows the context to which the current user belongs and also the parent context if one exists. This is a required field.

Class

Select the class for which the Rule Design needs to be created. This is a required field.

Instance Type

If the object supports templates, you can select one of three values:

  • By selecting Document, the rules defined in the rule design are executed for documents only.

  • By selecting Template, the rules defined in the rule design are executed for templates only.

  • By selecting Any, the rules defined in the rule design are executed for both documents and templates.

If the selected class does not support templates, Any is automatically selected by default, and is read-only. This is a required field.

Document Type

If the object supports document types, you can select a document type for which rules are executed from a list of all the document types available for the class. Select Any if the rules should be executed for all document types. If the selected class does not support document types, Any is automatically selected by default, and is read-only. This is a required field.

Target

The value for this field depends on the selection of Rule Design Context.

If Document Lifecycle was selected, you can select one of the following lifecycle events:

  • Created: executed when a document is created

  • Duplicated: executed when a document is duplicated

  • Loaded: executed when a document is loaded from the database

  • Post Phase Change: executed after the phase for the document is changed

  • Pre Phase Change: executed before the phase for the document is changed

  • Pre Publish to ERP: executed before the document is published to the ERP system. This is only relevant for objects that support the Publish to ERP operation.

  • Saved: executed after save to database, but prior to transaction commit; only executed if validations did not result in error.

  • Validated: executed when user saves and there are changes to the document; after system validation

If Field Validation was selected, you can select the target from a list of display fields on the business object including extensions.

If Toolbar was selected, the target field is not visible.

If Field Data Edit was selected, you can select the target from a list of display fields on the business object including extensions.

If Import Lifecycle Event was selected, the only possible value is Process Row, which is displayed as read-only.

This is a required field.

Toolbar Key

This field is only visible if Toolbar was selected as the Rule Design Context. Enter a unique identifier for the toolbar script. This is a required field

Field Help for Rule Design Detail

Note Note

The parameters you entered for the rule design are displayed as read-only.

End of the note.

Field Name

Description

Inactive

If selected, the rule design is set to inactive in the database. It is no longer displayed in the list of active rule designs. All the rules in the rule design are automatically set to draft status and no longer impact the business process. To activate the rule design, deselect the checkbox. When you reactivate the rule design, you must individually activate its rules.

External ID

Enter a unique identifier for the rule design. This value cannot be changed once the rule design is created. This is a required field.

Display Name

Enter a name for the rule design. This is a required field.

Description

Enter a description for the rule design.

Toolbar Key

Specify a unique identifier for the toolbar script. This field is only visible if you selected Toolbar as the Rule Design Context. This is a required field.

Toolbar Name ID

Select a localized resource for the toolbar script display name. This field is only visible if you selected Toolbar as the Rule Design Context. This is a required field.

Toolbar Description ID

Select a localized resource for the toolbar script description. This field is only visible if you selected Toolbar as the Rule Design Context.

Toolbar Visibility

Indicates whether the script should be available in edit mode only, view mode onl,y or both. This field is only visible if you selected Toolbar as the Rule Design Context. This is a required field