New Version Action (PLMActionNewVersion)

An opening ID is an entry point used to customize business logic. New Version Action describes conditions to be satisfied when operating the creation of the version. When the check fails, a message can be provided to the end user, explaining the reason why.

Important: This opening ID is not called if administrators select the Primary and Secondary revision format in Collaborative Spaces Control Center. For more information, see Configuring Lifecycle and Collaboration Commands.

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: On premises only

General Information

This opening ID is called when creating a new version of a component.

The table below provides you with information related to the definition of the Opening ID.

Opening ID: PLMActionNewVersion
Customization intent: Execution
Execution context:Server

Input Objects

Input objects must be of the following types:

  • ThisObject corresponds to the source object of the command:
    • In New Version: The object to be revised.
    • In New Version From Distant Data: The source object containing the distant data (to be inserted into the revision family).
  • Parameters corresponds to the context object.
  • Validation

Context Object Parameters

Parameter NameTypeRead/WriteComments
NewObjectPLMEntity ReadThe object resulting from the new version.
PolicyStringReadPolicy name.

Sample

The following sample 

/*The following rule is an example of what can be done*/

/* ----------------- */
/*      Declare      */
/* ----------------- */
Let newObject (PLMEntity)
Let DescriptionValue=""

/* ----------------------------------------------------------------------------- */
/*    Retrieves the object description and searches for specific string sequence  */
/* ----------------------------------------------------------------------------- */
DescriptionValue = ThisObject->GetAttributeString("V_description")
DescriptionValue = DescriptionValue + " PLMActionNewVersion"
ThisObject.V_description = DescriptionValue

set newObject = Parameters->GetAttributeObject("NewObject")
if (newObject == NULL) Trace(1, "obj null")
else newObject.V_description = DescriptionValue