Attributes

X-CAD Design Management and the Integration Exchange Framework installs the attributes listed in this section. Attributes may be associated with Types or Relationships.

Attribute Name Description/Possible Values

Assembly Rule

String

Allows the designer to specify placement/instance of a component within an assembly using a textual rule. The rule might refer to features and geometry in the assembly.

Default: Unassigned

Bareboard Names

String

List of bareboard names of an ECAD PCB design.

Bounding Box

String

Stores the diagonal vertices of a bounding box bounding the model

Default: Unassigned

CAD Type

String

Design type, such as assembly, or component.

CAD Object Name

String

For a relationship, holds the name of the CAD Object.

Child Instance

String

For a Parent Instance, holds the name of the Child Instance.

DSCFailedMessageList

String, multiline

Lists the failed messages in the queue.

DSC-IsReplacementDone

String, hidden

Used by a parent assembly to check if any child objects are replaced (true) or not replaced (false).

-true -false

DSCMessageBody

String, multiline

The text of a queued message.

DSCMessageErrorDescription

String, multiline

Error content of a queued message.

DSCMessagePriority

Integer

Priority of queued message, range from 0 to 9 inclusive.

Default=0

DSCMessageSequenceNumber

String

Identifies the current sequence number on the rename queue.

Default=1

DSCMessageSuccessDescription

String, multiline

Success content of queued message.

DSCPendingMessageIndex

String, multiline

The pending message index list.

DSCPeriodicMessageInterval

Integer

Number of hours between runs for messages that need to run periodically.

Default: 60

DSCPeriodicMessageLastRun

Date, hidden.

Date/time of the last time the message object was executed.

DSCPeriodicMessageLimit

Integer.

Limit for periodic message runs.

DSCPeriodicMessageRunCount

Integer, hidden.

The count of periodic messages.

DSCPeridiocMessageIndex

String, multiline.

Stores the list of periodic messages.

DSCSequenceNumber

Integer

Sequence of the queued message.

Default=0

IDF Board File

String

Used with IDF Model to specify the board file attached with the IDF.

IDF Library File

String

Used with IDF Model to specify the library file attached with the IDF.

IDF Version

String

Version value for an IDF Model.

IEF-AdminTables

String

List of admin tables available to users.

IEF-AllowAutoGenerationForManualDerivedOutput

String, multiline

Allow automatic generation of derived output if manual generation fails.

IEF-AllowLeapFroggingInCheckin

Boolean

This attribute is now deprecated. Value of this attribute is not read and is treated as TRUE by default in the product.

IEF-AssignCADModelNameFromPart

Boolean

If true, shows the Assign Part column on the checkin page, and the name of the CAD object will be the same as the selected Part's name.

Default: False

IEF-AutoRFAUpdate

String, multiline

Maintains the list of RFA links that need to be updated for the user.

IEF-BackgroundCheckinDirectory

String, multiline

Location of background checkin directory.

IEF-CADToMxMandatoryAttrMapping

String, multiline

Stores mandatory attributes to be copied from the CAD system to Matrix when checking in.

IEF-CheckObsoleteAcrossRevisions

String

Checks whether or not the current revision is the latest revision

Default=false

IEF-CheckUUIDConflict

Boolean

Check the validity of UUID before checkin

-true

-false (default)

IEF-ClientSideRenamedFileDetails

String, multiline

Map of the client-side renamed filename and its ENOVIA type and name.

IEF-ClonedFrom

String

Records the original name of a CAD Model that the current model was cloned from.

IEF-ConnectedECO

String

Contains the name of the ECO object connected to a CAD Drawing or MCAD Model (or any of their subtypes).

IEF-CreateVersionObjects

Boolean

If true, create multiple versioned objects; if false, disables versioning.

-true (default) -false

IEF-CSEDerivedOutputOptions

String

Lists available options for creating derived output files.

IEF-CSEDisabledCommandsList

String

List of disabled commands.

IEF-DefaultExpandLevel

String, multiline

The level up to which the structure should be expanded when the page is opened

IEF-DeleteFilesBehaviourOnCheckin

String, multiline

Determines which files (selected, all, or none) to delete after successful checkin.

IEF-DerivedOutputParameterObjTypeMapping

String, multiline

Maps a Derived Output Parameter object to the derived output types it supports

IEF- DerivedOutputTypeDefaultParameterObjectMapping

String, multiline

Defines the default derived output type for Derived Output Parameter objects

IEF-DesignChangesReportInterval

This attribute is now deprecated.

IEF-EBOMSync-AssociatedSpecInfo

String, multiline

Related documents for additional part specification lists

IEF-EBOMSync-ConnectPartsJPO

String

JPO called to connect a Part with another Part of CAD Model.

IEF-EBOMSync-CreateNewPart

Boolean

If true, creates a new part during the EBOM Sync function if there is no existing part.

-true (default) -false

IEF-EBOMSync-DefaultNewPartType

String

Default object Type when creating new parts.

IEF-EBOMSync-DrawingRelationInfo

String, multiline

Name of the relationship used to connect a drawing to a component or assembly.

IEF-EBOMSync-FailOnNotFindingMatchingPart

Boolean

If true, EBOM Sync function fails if a matching part does not exist.

-true -false

IEF-EBOMSync-FindMatchingPartJPO

String

JPO used to find matching parts during the EBOM Sync function.

IEF-EBOMSync-GenerateCollapsedEBOM

Boolean

If true, generate the EBOM in collapsed mode.

-true -false

IEF-EBOMSync-InvalidTypes

String, multiline

Lists object types that cannot be used to execute the EBOM Sync function.

IEF-EBOMSync-NewPartCreationJPO

String

JPO used to create a new part during the EBOM Sync function.

IEF-EBOMSync-NewPartPolicy

String

Name of the policy to use when creating parts during the EBOM Sync function.

Default=Development Part

IEF-EBOMSync-NewPartRevision

String

Revision value for new parts created during the EBOM Sync function.

Default=A

IEF-EBOMSync-ObjectAttrMapping

String, multiline

Attribute mapping for business objects.

IEF-EBOMSync-MandatoryObjectAttrMapping

String, multiline

Attributes are transferred from the CAD object to the corresponding Part object.

IEF-EBOMSynchOnDesignCreation

Boolean

If true, the EBOM Synchronization process is initiated whenever a checkin occurs.

Default: False

IEF-EBOMSync-PartMatchRule

String, multiline

Rule name for matching parts during the EBOM Sync function.

-LATEST_REV (default)

-MATCH_CADMODEL_REV

IEF-EBOMSync-PartRelState

String

Release sates for the EBOMSyncConfig object.

Default=Complete

IEF-EBOMSync-PartTypeAttribute

String

Type name of the new part attached to the CAD Model.

IEF-EBOMSync-RegistryTNR

String

Type, Name, and Revision of the currently active EBOM registry.

Default=MCAD-EBOMSyncConfig|MCAD-EBOMSyncConfig|-

IEF-EBOMSync-RelAttrMapping

String, multiline

Maps relationships during the EBOM Sync function.

IEF-EBOMSynch-MandatoryRelAttrMapping

String, multiline

Mandatorily maps attribute values from the CAD relation to the corresponding Part relation. The mappings are retained from the attribute, IEF-EBOMSync-RelAttrMapping

IEF-EBOMSync-RelDetailsToNavigate

String, multiline

Relationship used to connect parent-to-child objects during the EBOM Sync function.

IEF-EnableBatchProcessorForRename

String

Enables or disables the ability to use the batch processor for renaming files.

IEF-EnableProgressiveLoading

String, multiline

Enables or disables the progressive loading function.

IEF-EnableRapidFileAccess

Boolean

Enables or disables rapid file access.

-true -false (default)

IEF-EnforceInstanceNameUniqueness

Boolean

Enforce unique instance names in the database.

-true -false (default)

IEF-FileMessageDigest

String, multiline

Stores the hashcode in the format (format,filename,hashcode).

IEF-FileSource

String

Stores the original of the file:

-designtool (default -template -copy -rename

IEF-FinalizationState

String, multiline

Maps the policy to its finalized state.

Default= Design Policy|Approved

IEF-IntegrationToGCOMapping

String, multiline

Maps a collaborative product to the GCO object that contains the configuration settings.

IEF-IsPrimary

Boolean

Denotes whether the instance is a primary instance of the connected family or not. An instance is a primary instance if it has been saved / checked in, when the family was saved / checked-in to ENOVIA.

-true

-false

IEF-MappedInterfaceAttributes

String

Interface Attributes mapped as Mandatory from CAD to Matrix.

IEF-MassPromote-RegistryTNR

String

Stores the Type, Name, and Revision of the Mass Promote configuration object.

Default = IEF-MassPromoteConfig|IEF-MassPromoteConfig|-

IEF-MassPromoteValidationRuleJPO

String

Name of the JPO used to validate CAD structure and lifecycle states when multiple objects are selected for promotion.

IEF-NotificationCriteriaJPO

This attribute is now deprecated.

IEF-ObjectBasedConfigurationRevisionMode

Function: Defines the behavior of an object family and its associated instances, when a family structure is revised.

Possible Values:

  • Together: In Together mode, the family table and its associated instances are revised together when revising any item from the family structure. By default, the value is together.
  • Individual: In Individual mode, only the selected object in the family table is revised.

A new familymode is

IEF-PartCADObjectAttrMapping

String, multiline

Map attributes on Part objects to attributes on CAD objects.

IEF-PartCADRelAttrMapping

String, multiline

Map attributes on relationships between Part objects to attributes on relationships between CAD objects.

IEF-PreferencesPageLayoutJPO

String

JPO that defines the layout of the Preferences page.

Default=IEFPreferencesPageLayout

IEF-Pref-IEF-AllowAutoGenerationForManualDerivedOutput

String

Allows automatic generation of derived output if manual generation fails. GCO value copied to LCO value.

Default=true

IEF-Pref-IEF-BackgroundCheckinDirectory

String

GCO value copied to LCO value.

IEF-Pref-IEF-DefaultConfigTables

String

GCO value copied to LCO value.

Version$Admin:DECVersionDetails@Baseline

$Admin:DECBaselineDetails@Open$Admin:

DECOpenPageDetails@Save$Admin:

DECSavePageDetails@PLMTree$Admin:

DECPLMTreeDetails@Checkin$Default@Checkout$Default@LockUnlock

$Default@Promote$Default@SaveAs

$Default@DesignChangeReport$Default@StartDesign$Default

@EBOMSynchronize$Default@RecentlyAccessedParts$Default

IEF-Pref-IEF-DefaultExpandLevel

String

GCO value copied to LCO value for checkin and checkout pages.

Default=1.

IEF-Pref-IEF-DeleteFilesBehaviourOnCheckin

String

GCO value copied to LCO value.

Default=Delete Selected Local Files

IEF-Pref-IEF-EnableProgressiveLoading

String

GCO value copied to LCO value.

Default=true

IEF-Pref-IEF-SelectedBackgroundDerivedOutputs

For the GCO, holds the preference for the Selected Background Derived Outputs option.

IEF-Pref-IEF-SelectedManualDerivedOutputs

For the GCO, holds the preference for the Selected Manual Derived Outputs option.

IEF-Pref-IEF-UserDirectoryAlias-Mode

String

GCO value copied to LCO value.

Default=not allowed

IEF-Pref-MCADInteg-ApplyToChildren

String

GCO value copied to LCO value.

Default=false

IEF-Pref-MCADInteg-BackgroundCheckin

String

GCO value copied to LCO value.

Default=true

IEF-Pref-MCADInteg-CheckOutDirectory

String

GCO value copied to LCO value.

Default=c:\temp

IEF-Pref-MCADInteg-CopyRelAttribOnCheckin

String

GCO value copied to LCO value.

Default=false

IEF-Pref-MCADInteg-CopyRelAttribOnCheckout

String

GCO value copied to LCO value.

Default=false

IEF-Pref-MCADInteg-CreateVersionOnCheckin

String

GCO value copied to LCO value.

Default=true

IEF-Pref-MCADInteg-DefaultTypePolicySettings

String, multiline

GCO value copied to LCO value.

IEF-Pref-MCADInteg-DeleteLocalFileOnCheckin

String

GCO value copied to LCO value.

Default=false

IEF-Pref-MCADInteg-LockObjectOnCheckin

String

GCO value copied to LCO value.

Default=false

IEF-Pref-MCADInteg-LockObjectOnCheckout

String

GCO value copied to LCO value.

Default=false

IEF-Pref-MCADInteg-PreCheckInEvaluation

String

GCO value copied to LCO value.

Default=(ENFORCED) false

IEF-Pref-MCADInteg-SelectChildItems

String

GCO value copied to LCO value.

Default=true

IEF-Pref-MCADInteg-SelectedDerivedOutputs

String

GCO value copied to LCO value.

IEF-Pref-MCADInteg-SelectFirstLevelChildren

String

GCO value copied to LCO value.

Default=false

IEF-Pref-MCADInteg-UseZipInFileOperations

String

GCO value copied to LCO value.

Default=true

IEF-Pref-MCADInteg-ViewRegistryName

String

GCO value copied to LCO value.

Default=(DEFAULTVALUE)DefaultViewRegistry

IEF-Pref-MCADInteg-WarnForFileOverwrite

String

GCO value copied to LCO value.

Default=true

IEF-RecentCheckinFiles

String, multiline

List of recently checked-in files.

IEF-RecentCheckinMaxFileDisplayed

Integer

Maximum number of files to retain and display in the recently checked-in list.

Default=50

IEF-RegistryData

String, multiline

IEF-based registration data for integrations

IEF-ReleasedState

String, multiline

Maps a policy to its released state.

Default= Design Policy|Release

IEF-SelectedBackgroundDerivedOutputs

For the LCO, holds the preference for the Selected Background Derived Outputs option.

IEF-SelectedManualDerivedOutputs

For the LCO, holds the preference for the Selected Manual Derived Outputs option.

IEF-SharedDrivesList

String

List of shared drives for the user.

IEF-SourceDetails

String

The App tool source information.

IEF-StartDesignForm

String

Name of the JSP used for the Start Design function.

Default=IEFStartDesignCreateObjectFS.jsp

IEFStartDesignJPO

String

Name of the JPO used for the Start Design function.

IEF-TypeTemplateMapping

String, multiline

Maps CAD types to Template Types for the Start Design function.

IEF-UsePreviousObjectStore

Boolean

If true, use the same store as the one used for the previous object.

-true -false (default)

IEF-UserDirectoryAlias-Map

String, multiline

Map to enable alias directory support.

IEF-UserDirectoryAlias-Mode

String, multiline

Default mode for enabling the alias directory support during checkout.

IEF-UserExitEventRegistration

String

Lists enabled user exits.

IEF-UUID

String

Unique identifier generated by the CAD Model or CAD Drawing.

IEF-UUIDConflictAdminRole

String

Administrative Role used to resolve UUID conflicts.

IEF-ValidateObjectPromotion

Boolean

Determines whether or not validate the object during the promote operation

-true (default) -false

IEF-ValidateObjectSelection

Boolean

Determines whether or not to validate an object when it is selected on the Promote page

-true (default) -false

Instance Parameters

String, Multiline

Stores variational parameters data that allows a Family to resolve into an instance.

IsFinalized

This attribute is deprecated in R2015x. Its value is always set as FALSE.

MCAD Label

String

Stores a list of baseline labels.

MCADInteg-ApplyToChildren

String, multiline

Apply the same choice as parent to child objects.

MCADInteg-BackgroundCheckin

String, multiline

Enables/disables background checkin.

MCADInteg-BusTypeMapping

String, multiline

Maps types used by the CAD tool to ENOVIA types.

MCADInteg-CADToMxAttribMapping

String, multiline

Maps attributes in the CAD tool to ENOVIA attributes.

MCADInteg-CADToMxRelAttribMapping

String, multiline

Maps relationship attributes from the CAD tool to ENOVIA relationship attributes.

MCADInteg-CheckOutDirectory

String, multiline

Defines the default directory for checking out objects.

MCADInteg-Comment

String, multiline

Contains comments entered when the object was checked out.

MCADInteg-CopyRelAttribOnCheckin

String, multiline

Default behavior for copying relationship attributes on checkin.

MCADInteg-CopyRelAttribOnCheckout

String, multiline

Default behavior for copying relationship attributes on checkout.

MCADInteg-CreateVersionOnCheckin

String, multiline

If true, create a new version object on checkin.

-true -false

IEF-Pref-IEF-DefaultLateralView

String

Defines the default lateral view.

MCADInteg-DefaultTypePolicySettings

String, multiline

Maps a type to its default design policy and default version policy.

IEF-Pref-IEF-DefaultVerticalView

String

Defines the default vertical view.

MCADInteg-DeleteLocalFileOnCheckin

String, multiline

Defines the default behavior for deleting local files at checkin.

MCADInteg-EnableHashcodeComputation

Boolean

If true, hashcode computation for CAD Model is enabled.

-true -false (default)

MCADInteg-EnableMajorRevCreation

Boolean

If true, create the target major revision during object creation.

-true (default) -false

MCADInteg-ExpandedSubComponent

Boolean

If true, shared subcomponents should be rolled up.

-true (default) -false

MCADInteg-FeatureJPOMapping

String, multiline

Maps features to the JPO that executes those features.

MCADInteg-InstanceAttributes

String, multiline

Stores the attributes for the instance.

MCADInteg-InstanceNames

String, multiline

Stores the instance names for a family object.

MCADInteg-Instances

String, multiline

Stores information about instances.

MCADInteg-InstanceSpecificAttributes

String, multiline

Stores instance-specific attributes.

MCADInteg-InstanceStructure

String, multiline

Stores the instance structure for nested instances.

MCADInteg-LateralNavigationProgNameMapping

String, multiline

Maps the program used for lateral navigation.

MCADInteg-LoadObjectsInCADTool

String, multiline

Default behavior for loading objects after checking them out.

MCADInteg-LockObjectOnCheckin

String, multiline

Default behavior for locking objects on checkin.

MCADInteg-LockObjectOnCheckout

String, multiline

Default behavior for locking objects on checkout.

MCADInteg-MxToCADAttribMapping

String, multiline

Maps ENOVIA attributes to CAD parameters for copying during checkout.

MCADInteg-MxToCADRelAttribMapping

String, multiline

Maps ENOVIA relationship attributes to CAD relationship attributes for copying during checkout.

MCADInteg-NonSupportedCharacters

String

Lists the characters that cannot be used in file names.

MCADInteg-PingInterval

Integer

Defines the time interval (in seconds) to ping the server to avoid timing out. Supported range is 1 to 3600 inclusive.

Default=1

MCADInteg-PreCheckInEvaluation

String, multiline

Prevalidation before checkin

MCADInteg-RelationShipClassMapping

String, multiline

Captures the behavior under change of objects of types participating in the mapped relationship.

MCADInteg-RelMapping

String, multiline

Maps relationships from the CAD tool to Matrix.

MCADInteg-RenameFilesInServer

Boolean

If true, allows the renaming of files in the database.

-true (default) -false

MCADInteg-RevReplacedFrom

String, multiline

MCADInteg-SelectChildItems

String, multiline

If true, select all child nodes of selected nodes during checkout.

MCADInteg-SelectedDerivedOutputs

String, multiline

Lists formats of derived output to be generated at checkin.

MCADInteg-SelectFirstLevelChildren

String, multiline

If true, users can check the select first level children option at checkin.

MCADInteg-ShowDetailsPopUpOnCheckin

String, multiline

If true, the properties page for an object is displayed in a popup window after it is checked in.

MCADInteg-TurnOnDebug

Boolean

If true, a debug log for the user is created.

-true -false (default)

MCADInteg-TypeChangeMapping

String, multiline

Maps of types allowed to be changed.

MCADInteg-TypeClassMapping

String, multiline

Captures the behavior for creating objects.

MCADInteg-TypeDerivedOutputMapping

String, multiline

Maps CAD types to derived output types.

MCADInteg-TypeFormatMapping

String, multiline

Maps CAD types to ENOVIA types and formats.

MCADInteg-TypePolicyMapping

String, multiline

Maps the object type to the policy that governs it.

MCADInteg-UseZipInFileOperations

String, multiline

Flag that determines whether or not the ZIP utility is used during file operations (checking in or out).

MCADInteg-VerticalNavigationProgNameMapping

String, multiline

Maps the programs to display for user-selection for vertical navigation.

MCADInteg-ViewRegistryName

String, multiline

Name of the object used to contain the list of views.

MCADInteg-WarnForFileOverwrite

String, multiline

Determines whether or not user will be warned at checkout if files may be overwritten.

Model Type

String

Classifies the CAD Model.

Default: Unassigned

Modified in Matrix

String, multiline

Supports structure generation from ENOVIA and specifies whether or not the design has been modified. Default is <blank>.

Must In Structure

Boolean

Indicates whether or not the child component is suppressed in its relationship with the Parent component.

-true (default) -false

New Transformation Matrix

String, multiline

Defines the position and scaling factor of a CAD object with respect to its parent. This attribute captures the 4x4 matrix that represents a new position of the component or assembly within its parent.

Format: x1,y1,z1,p,x2,y2,z2,q,x3,y3,z3,r,x4,y4,z4,s

Newly Created in Matrix

String, multiline

Supports structure generation from ENOVIA and specifies whether or not the design is a new ENOVIA object. Default is <blank>.

Parent Instance

String

For a Child Instance, holds the name of the Parent Instance.

Quantity

Real

Applied against the unit of measure for building the next assembly.

Default: 1.0

Reference Designator

String

Allows the designer to specify placement/instance of a component inside an assembly.

Default: Unassigned

Relationship Modification Status in Matrix

String, multiline

Indicates the structure modification status between CAD Models connected at the from and to end of the relationship.

Renamed From

String

Records the original name of an assembly, component, CAD Model, Parameterized Model, or instance that the current object was renamed from.

Source

String

Maintains details about the CAD tool integration version, must be a valid value.

For example:

Inventor|R211

Spatial Location

String

Stores the geometric data (as a 4x4 matrix) that positions the component within an assembly.

Default: Unassigned

Viewable Base Filename

String

Records the file name of the base viewable file.

Default: Unassigned

Viewable Base Format

String

Records the format of the business object that holds the base viewable file.

Default: Unassigned

Viewable State

String

Records the status of a viewable object based on the model it is derived from.

-Empty

-Synchronized

-Unsynchronized

Viewing Tool

String

Default=Unassigned

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.

IEF-EBOMSync-AssignPartToMajor: This attribute is now deprecated. Value of this attribute is not read and is treated as TRUE by default in the product.