Configuring the EBOM Configuration Object

You can change the behavior of the EBOM Synchronization process by changing attribute values of the MCAD-EBOMSyncConfig object.

You can create a subtype of this object for additional attributes if required.

If you write custom JPOs for this functionality, you need to update the object to point to the required JPOs.

When entering a system (for ENOVIA) or summary (for the App) attribute as a value, enclose it in $$, such as $$Description$$.

  1. Run the following MQL commands.
    Run MQL from the Live Collaboration Server folder or from 3DSpace. For more information, see Installation and Setup | Administrate | 3DEXPERIENCE Platform | 3DSpace | Collaboration and Approvals | Administrative Utilities | Running MQL
  2. You can clone MCAD-EBOMSyncConfig MCAD-EBOMSyncConfig-TEAM or edit original.

    Copy bus MCAD-EBOMSyncConfig MCAD-EBOMSyncConfig-TEAM - to <NEW_NAME> <REVISION>

    For example,

    Copy bus MCAD-EBOMSyncConfig MCAD-EBOMSyncConfig-TEAM - to MCAD-EBOMSyncConfig-TEAM_copy -

  3. The available attributes are:

    Attribute Description
    IEF-EBOMSync-ConnectPartsJPO

    Function: Defines the JPO that connects Parts to CAD objects.

    Default Value: IEFEBOMSyncConnectParts

    IEF-EBOMSync-FindMatchingPartJPO

    Function: Defines the JPO that locates the Part for a specific CAD object

    Default Value: IEFEBOMSyncFindMatchingPart

    IEF-EBOMSync-NewPartCreationJPO

    Function: Defines the JPO that creates new parts to connect to a specific CAD object

    Default Value: IEFEBOMSyncNewPartCreation

    IEF-EBOMSync-FailOnNotFindingMatchingPart

    Function: When set to True, process fails if an existing matching part cannot be found for a CAD object. If False, the process does not fail even if an existing matching part cannot be found for a CAD object.

    Default Value: False

    IEF-EBOMSync-CreateNewPart

    Function: If set to True, a new part is created if an existing part cannot be found for a CAD object. When set to False, a new part is not created even if an existing part cannot be found for a CAD object.

    Default Value: True

    The EBOM Synch config attributes, IEF-EBOMSync-FailOnNotFindingMatchingPart and IEF-EBOMSync-CreateNewPart should not be set as TRUE at the same time. If one of the attributes is set as TRUE, the other attribute must be set as FALSE or both as FALSE.

    IEF-EBOMSync-DefaultNewPartType

    Function: Provides the default type to use when creating parts, if the CAD object itself (in attribute IEF-EBOMSync-PartTypeAttribute) does not specify a part type for the EBOM process.

    Default Value: Part

    IEF-EBOMSync-ObjectAttrMapping

    Function: Maps attribute values from the CAD object to the corresponding Part object. Each line in this attribute value defines the mapping of 1 CAD object attribute to the associated Part object attribute, and the attribute can contain as many lines as needed. The major type mapping must be added individually.

    Default Value: The default value of this attribute is blank.

    Syntax: Matrix-Type1|Attr1|PartType1|Attr2

    Example:

    INV Component|Author|Part|Originator

    INV Component|$$Description$$|Part|Test01

    IEF-EBOMSync-MandatoryObjectAttrMapping

    Function: This mapping is specified by the administrator and is mandatory in the sense that, the user is not allowed to modify / remove this mapping through his local preferences.

    The mapped attributes thus are compulsorily transferred from the CAD object to the corresponding Part object.

    Default Value: The default value of this attribute is blank.

    Syntax: Matrix-Type1|Attr1|PartType1|Attr2

    Example:

    INV Component|Author|Part|Originator

    INV Component|$$Description$$|Part|Test01

    IEF-EBOMSync-RelAttrMapping

    Function: Maps attribute values from the relationship between CAD objects to the corresponding attribute on the relationship between Part objects.

    Each line in this attribute value defines the mapping of one CAD relationship attribute to the corresponding attribute on the relationship between Part objects.

    The attribute can contain as many lines as needed.

    Default Value: The default value of this attribute is blank.

    Syntax: CAD Rel1|Attr1|PartRel1|Attr2

    Example:

    CAD SubComponent|Spatial Location|EBOM|Component Location

    CAD SubComponent|Must In Structure|EBOM|Notes

    If using 3DLive, enter this value:

    CAD SubComponent|Spatial Location|EBOM|Component Location

    IEF-EBOMSync-MandatoryRelAttrMapping

    Function: This mapping is specified by the administrator and is mandatory in the sense that, the user is not allowed to modify / remove this mapping through his local preferences.

    The mapped attributes thus are compulsorily transferred from the CAD relationships to the corresponding relationships between Part objects.

    Default Value: The default value of this attribute is blank.

    Syntax: CAD Rel1 |Attr1|PartRel1|Attr2

    Example:

    CAD SubComponent|Spatial Location|EBOM|Component Location

    CAD SubComponent|Must In Structure|EBOM|Notes

    IEF-EBOMSync-NewPartPolicy

    Function: Defines the policy to use for newly-created Part objects.

    Default Value: EC Part

    IEF-EBOMSync-NewPartRevision

    Function: Defines the initial revision value for newly-created Part objects.

    Default Value: 1

    IEF-EBOMSync-PartMatchRule

    Function: Defines the rule to use for finding a Part match for a CAD object. The value of attribute IEF-EBOMSynch-NewPartRevision is not considered when the attribute IEF-EBOMSync-PartMatchRule is set to MATCH_CADMODEL_REV.

    Possible Values:

    • MATCH_CADMODEL_REV--The following cases are possible,
      • If an existing part with a matching revision for the CAD model is found by the JPO set in the attribute IEF-EBOMSynch-FindMatchingPartJPO, then the part is used during EBOM Synch.
      Note: If MATCH_CADMODEL_REV is set as the value,
      • The revision sequence defined in the policy which is followed by the CAD object, and the revision sequence defined in the policy which is followed by the corresponding engineering part should match.
      • If engineering part is already present for a CAD object, then the revision of the CAD object and revision of the engineering part should match.
      • If the JPO set in attribute IEF-EBOMSynch-FindMatchingPartJPO does not find a part with the same name and different revision, a new Part matching the CAD Model revision is created.
      • If the revision sequence of Part and CAD Model does not match, then an error message is displayed.
    • LATEST_REV - finds the latest revision of the Part.

      You can create custom JPOs for alternative matching rules.

    IEF-EBOMSync-RelDetailsToNavigate

    Function: Lists the relationships to use to recursively navigate the CAD design and to replicate to create the matching EBOM structure (structure of Parts connected to child Parts).

    Syntax: RelationshipName,direction

    where

    • RelationshipName indicates the name of relations used.
    • direction indicates the direction (from or to) where the object to be expanded is

    Example:

    CAD SubComponent,from

    As of X-CAD Design Management or IEF release 10.6, the out-of-the-box JPO ignores the type value.

    Default Values:

    CAD SubComponent,from

    SE Weldment,from

    Attached Reference,from

    Associated Drawing,to

    IEF-EBOMSync-AssociatedSpecInfo

    Function: Newline-separated list of related documents containing part specifications to be connected to the CAD drawing.

    Syntax: RelationshipName,direction,TypeName

    where

    • RelationshipName indicates the name of the relationship to be looked up during the EBOM sync operation to find the objects that need to be connected to the Part object as a specification.
    • direction indicates the end at which the design object exists.
    • TypeName indicates the types of objects on the other end of this relationship which are to be used for connecting with the Part object as additional specifications.

    Example:

    Associated Drawing,from,SW Drawing

    Default Values:

    Associated Drawing,from,ACAD Drawing

    Associated Drawing,from,SW Drawing

    Associated Drawing,from,SE Drawing

    Associated Drawing,from,Cat V4 Drawing

    Associated Drawing,from,INV Drawing

    Associated Drawing,from,ProE Drawing

    Associated Drawing,from,Cat Drawing

    Associated Drawing,from,UG Drawing

    Associated Drawing,from,INV Presentation

    IEF-EBOMSync-InvalidTypes

    Function: Newline-separated list of the ENOVIA types for which EBOM synchronization should not be done.

    In the baseline behavior, the types IDF Model, ACAD Insert, are added to the attribute IEF-EBOMSync-InvalidTypes.

    These have been defined as invalid types for EBOM synchronization and an EBOM will not be generated for these types.

    User's can add such types to the attribute IEF-EBOMSync-InvalidTypes, for which the user does not want EBOM to be synchronized. This is a new line separated list and the type has to be mentioned in this list.

    For example, if an user has the following structure, Drawing (having type SW Drawing) -> Component (having type SW Component) and has added types "SW Component" to the IEF-EBOMSync-InvalidTypes and wants to perform EBOM Sync operation on the drawing, the following steps should be followed, so that EBOM Sync operation is done only on the "Drawing" and not on the entire structure.

    1. Search for MCAD-EBOMSyncConfig and open its attributes window.
    2. Modify the attribute IEF-EBOMSync-DrawingRelationInfo and remove the entry SW Drawing|Associated,to
    3. Modify the attribute IEF-EBOMSync-AssociatedSpecInfo and remove the entry Associated Drawing,from,SW Drawing .

    IEF-EBOMSync-DrawingRelationInfo

    Function: New-line separated list that defines how to navigate from a Drawing to the related CAD Model

    Syntax: TypeName|RelationshipName, direction

    • TypeName indicates the ENOVIA drawing type.
    • RelationshipName indicates the name of the relationship to be looked up during the EBOM sync operation.
    • direction indicates the end at which the drawing object exists.

    The Drawing object is also connected as an additional specification to the Part object, created as part of EBOM operation for the associated object.

    Example:

    SW Drawing|Associated Drawing,to

    Default Values:

    ACAD Drawing|Associated Drawing,to

    SW Drawing|Associated Drawing,to

    SE Drawing|Associated Drawing,to

    Cat V4 Drawing|Associated Drawing,to

    INV Drawing|Associated Drawing,to

    ProE Drawing|Associated Drawing,to

    Cat Drawing|Associated Drawing,to

    UG Drawing|Associated Drawing,to

    INV Presentation|Associated Drawing,to

    IEF-EBOMSync-GenerateCollapsedEBOM

    Function: True/False flag to indicate whether or not to use multiple relationships to connect an Assembly to a Part when more than one occurrence of that Part is present in the Assembly.

    Possible Values:

    • True: Create one relationship between the Assembly and the Part, with the Quantity attribute on the relationship set to the needed value.
    • False: Create as many relationships as needed between the Assembly and the Part.

    Default Value: FALSE

    IEF-EBOMSync-PartRelState

    Function: Defines the state of the policy used as the released state during EBOM Synch.

    Default Value: Release

    IEF-EBOMSync-PartNumber

    Function - This attribute is used to configure the part number.

    Possible Values:

    • CADModelName
    • AutoName

    If the value is CADModelName then EC Part is created with:

    • Instance Name(Family Name) when IEF-EnforceInstanceNameUniqueness = FALSE.
    • Instance Name when IEF-EnforceInstanceNameUniqueness = TRUE.

    Note: Here CADModelName is cad model object name (not the title attribute).

    If AutoName is selected then part is created with AutoName.

    By default, the value is set to CADModelName.

    IEF-EBOMSync-PartSeries

    Function - This attribute is used to configure part series. This attribute is added on the IEF-EBOMSyncConfig object.

  4. If new subtype is created then modify IEF-EBOMSync-RegistryTNR in integartion GCO mod bus MxCATIAV5-GlobalConfig CatiaV5NewArch TEAM IEF-EBOMSync-RegistryTNR MCAD-EBOMSyncConfig|<NEW_OBJECT_NAME>|<NEW_OBJECT_REVISION>; For example, modify bus MxCATIAV5-GlobalConfig CatiaV5NewArch TEAM IEF-EBOMSync-RegistryTNR MCAD-EBOMSyncConfig|MCAD-EBOMSyncConfig-TEAM_copy|-;