Modify Description (modifydescription)

An opening ID is an entry point used to customize business logic. modifydescription modifies the description of an object.

Warning: This trigger is also fired at create.
Note: For more information about customization by business rules, see Installation and Setup: Customize: Behavior: Data Setup: Customization by Business Rules.

This page discusses:

Environment: Cloud only

General Information

This opening ID is a precommit trigger. For more information about the specifities of a precommit trigger, see About Precommit Triggers.

Definition Description
PLM Opening ID modifydescription
Customization intent Not applicable
Execution context Cloud server

Input Objects

  • ThisObject (input) the object on which the trigger has been fired.
  • Parameters: RuleContext. For more information, see Installation and Setup: Customize: 3DEXPERIENCE Platform: 3DSpace Data Model: Unified Typing Reference Dictionary: Server Packages: Standard Types.
  • Validation (output) Boolean indicating if the rule has been validated.

Context Object Parameters

No context object parameters.

Sample

Trace(1, "Execution MyCATRule on ", ThisObject.PLM_ExternalID )
Report("Information", "infoMsg", "description changed to #", ThisObject.description )
	
if (ThisObject.description == "error")
{		
	Parameters.Message = "This is an error"
	Validation = false
}
else
{
	Report("Warning", "warnMsg", "This is a warning")
	ThisObject.SetAttributeString("PLMEntity.V_description", "modified by script")
	Validation = true
}