Validate XML Device and Device Instance Link (ELBManageLink_ValidateLinkInstance)

An opening ID is an entry point used to customize business logic. The Validate XML device and device instance link opening ID is available in the Electrical physical system design resources set and it is used to check if an XML device instance is compatible with a V6 device instance to link.

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 Linking Electrical Devices command. See Electrical 3D Design User's Guide: Importing Electrical Data: Linking Electrical Devices.

This opening ID is used to check:

  • if a V6 instance created or linked from the XML definition is compatible with its XML definition.
  • if the CATIA product containing an instance corresponding to an XML object is matching the XML system definition.
For this you need to:
  • check if the V6 instance is aggregated into the right product, by using Manage Links. For example, check if the XML system "door harness" contains an electrical connector instance "ECP1" linked to XML harness "door harness".
  • check if the active product, when placing the ECP1 object, has a name compatible with the system name, and if the harness name "door harness" is in another GBN in CATIA, in order to avoid placing an object defined in "door harness" XML system.

The Business Rule can either:

  • validate if the V6 instances compatible with XML instance (severity=0)
  • validate if the V6 instance is compatible with XML instance with a warning computed from the rules context (severity=1)
  • forbid the link and (instantiation) of the V6 instance with the XML instance with a warning computed from the rules context (severity=2)

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

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

Input Objects

This validation business rule is triggered when an object, to be placed or linked, is selected in Manage Links. For Place operation, the business rule is used after the instance is created in the active product. Input objects must be of the following types:

  • ThisObject: instance of device (the object allows to retrieve the father product).
  • Parameters corresponds to the context object. The standard context and message attribute are displayed in a warning if the validation fails.
  • Validation: a variable to know if the validation succeeded of failed.
  • Severity information:
    • 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
SystemName(input string)PLM Entity ReadXML system Name (that contains the XML device object). A new API is needed to retrieve the system name from any object. The system name is actually the XML file name.
HarnessID (input string)String ReadXML Harness ID (if the XML device object is linked to an XML harness).The Harness ID can be retrieved for any connector, splice, conductor or conductor group.
DeviceNameString Read
X (input real); X value from XMLString Read
Y (input real): Y value from XMLString Read
Z (input real): Z value from XMLString Read

Sample

The following sample explains how to use an opening ID to check the links between electrical devices.

/* CATRule signature (do not edit) : 
  (ThisObject : #In PLMProductInstanceDS, Parameters 
  : #In RuleContext, Validation : #Out Boolean) 
  : #Void */

Let Owner(Feature)
let sOwnerName(String)
let sDevice(String)
let sHarness(String)
let sSystem(String)

sHarness = Parameters.GetAttributeString("HarnessName")
sSystem = Parameters.GetAttributeString("SystemName")
sDevice = Parameters.GetAttributeString("DeviceName")

set Owner = ThisObject.Owner
if(NULL <> Owner)
{
   sOwnerName = Owner.Name
   if(0 <= sOwnerName->Search(sHarness))
   {
      Validation = true
      Parameters.Severity = 0
      Parameters.Message = "Link Valid"
   }
   else if(0 <= sSystem->Search(sOwnerName))
   {
      Validation = true
      Parameters.Severity = 1
      Parameters.Message = "Business Rule Warning: " 
       + sDevice + " is placed in " + sOwnerName
   }
   else
   {
      Validation = false
      Parameters.Severity = 2
      if(sOwnerName <> "Harness2_IncorrectForLink")
         Parameters.Message = "Business Rule Error: " 
          + sDevice + " cannot be placed in " + sOwnerName
          + ". It should be placed in " +
sHarness + "/" + sSystem
   }
}