Validate Branch End Connection (EHIRouting_ValidateBranchExtremityConnection)

An opening ID is an entry point used to customize business logic. The Validate branch end connection opening ID is available in the Electrical physical system design resources set and it is used to validate if a segment end can be connected to another object (another segment end or device).

Note: For more information about customization by business rules, see Installation and Setup: Customize: Behavior: Data Setup: Customization by Business Rules.

This page discusses:

General Information

This opening ID is invoked during the Electrical Branch Geometry command. See Electrical 3D Design User's Guide: Inserting an Electrical Branch Geometry: Inserting an Electrical Branch Geometry and First Branch.

During the Branch Routing, select an object to connect (another branch extremity or an electrical device instance), the Business Rule will check if the bundle segment extremity can be connected to this object. The Business Rule can either:

  • validate the Branch connection to the object (severity=0)
  • validate the Branch connection to the object with a warning computed from the rules context (severity=1)
  • forbid the Branch connection to the object with a warning computed from the rules context (severity=2)

The business rule is triggered when an object to be connected is selected in Branch Routing.

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

PLM Opening ID: EHIRouting_ValidateBranchExtremityConnection
Customization intent: Validation
Execution context:Client

Input Objects

Input objects must be of the following types:

  • ThisObject: branch segment to route
  • Parameters corresponds to the context object. The standard context and the message attribute are displayed in a warning if the validation fails.
  • Validation: a variable to know if the validation succeeded or failed.
  • Severity messages:
    • Severity= 0 the treatment is to be continued (no message).
    • Severity= 1 the treatment is to be continued and only a warning raised.
    • Severity= 2 the treatment is supposed to be undone.

Context Object Parameters

Parameter NameTypeRead/WriteComments
SegmentExtremity (input)PLM Entity ReadExtremity of the routed branch.
SegmentExtremitytoConnect (input)PLM Entity ReadExtremity of the branch to connect (may be null if connection to device instance).
InstanceToConnect (input)PLM Entity ReadInstance of Product to connect (mainly electrical device instance).
PortToConnect (input)PLM Entity ReadPort of product to connect (mainly bundle connection Point of electrical instance).