Pre Check New Version (PLMPreCheckNewVersion)

An opening ID is an entry point used to customize business logic. Pre Check New Version describes the conditions to be satisfied before operating the creation of the version, to prevent the operation. 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 invoked before creating a new version of a component.

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

Opening ID: PLMPreCheckNewVersion
Customization intent: Validation
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
PolicyString ReadPolicy name.

Sample

The following sample shows you how to check that the object has no children.

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

/* ----------------- */
/*      Declare      */
/* ----------------- */
let ListInstance (List)
let ListInstanceSize (Integer)

/* ----------------------------------------------------------------------------- */
/*    By default, we validate the operation  */
/* ----------------------------------------------------------------------------- */
Validation = true

/* ----------------------------------------------------------------------------- */
/*    If the object has at least one child, the clone is not allowed  */
/* ----------------------------------------------------------------------------- */
ListInstance = ThisObject.Children
ListInstanceSize = ListInstance.Size()
if ( ListInstanceSize > 0 )
        Validation = false