Entering GCO Attribute Values

Function: Defines the CAD-to-Matrix attribute mapping.

Syntax: CAD-Type,CAD-Attribute|Matrix-Type,Matrix-Attribute

CAD Type values: component, componentInstance, componentFamily, assembly, assemblyInstance, assemblyFamily, drawing and ALL.

Examples:

component,Test01|INV Component,Test01

component,$$Author$$|INV Component,Author

component,$$Comments$$|INV Component,$$Description$$

Do not map the Title attribute. This attribute is required for Common Document Model functionality. The "Title" attribute is not supported in the Matrix side of the MCADInteg-CADToMxAttribMapping. If present in the mapping, it is ignored during attribute synchronization.

IEF-CADToMxMandatoryAttrMapping

Function: Define attributes to be copied for attribute synchronization on checkin.

Syntax: CADAttribute,value,mandatoryValue

where mandatoryValue is one of these values:

• mandatory - values are always synchronized / copied from the GCO. If no value is specified in GCO, then the checkin / save to ENOVIA operation will fail with an appropriate error message.
• default - If attribute value is not set on file, then the value from GCO is synchronized / copied. If value is set on file, then the value on file is synchronized / copied. If no value is specified (neither on the CAD file nor in the GCO), then checkin / save to ENOVIA operation will fail with an appropriate error message.
• null - When an attribute is defined as "null", it is compulsory that the user specifies some value for this attribute on the CAD file. This value specified by the user on the CAD file is synchronized / copied to the object. If no value is specified on the CAD file, then checkin / save to ENOVIA operation will fail with an appropriate error message.

Example:

$$Subject$$,companyABC,mandatory

Test01,alwaysCopy,mandatory

$$Comments$$,drawing by ABC,default

Test01,defaultValue,default

$$Author$$,,null

Test01,,null

Function: Whenever an user checks in a family with instances, the name of the instance object that is created in ENOVIA depends upon the value of this attribute.

Possible Values:

• True - The instance object name does not contain family name. For example, if an instance I1 with family F1 is checked in, then the name of the instance object that is created will be I1.
• False - The instance object name contains family name. For example, if an instance I1 with family F1 is checked in, than the instance object name will be I1(F1).

Default Value: False

Function: Used to restrict certain X-CAD Design Management features for the user.

Example:

INV Component|Rename,Purge

INV Assembly|Purge

Default Value: Blank

Function: Define the temporary directory where design files are kept during background checkin, and where success and failure logs are created. If left blank, X-CAD Design Management uses the User Profile Directory.

Example: For Windows XP, the background checkin directory location is, C:\Documents and Settings\<user>\IEFBackgroundCheckin\BackgroundCheckin<date_time>

For Windows Vista and Windows 7, the background checkin directory is located at,

C:\Users\<user>\IEFBackgroundCheckin\BackgroundCheckin<date_time>

Default Value: False

Function: Define whether or not new version objects can be created for a Revision

Possible Values:

• True - more than one iteration object can be created in any revision stream.
• False - only one iteration object can be created in one revision stream and Version column is not displayed in all UI pages.

Default Value: True

Function: Used to define the list of admin tables that will be available in all the custom table views to all the users assigned to the GCO.

Syntax: AdminTable1|AdminTable2

Examples: INVOpenPageDetails|INVSavePageDetails

Function: Define the mapping between ENOVIA Type, DesignPolicy and Version Policy. This mapping shows default values for new objects in the policy columns for the selected ENOVIA Type in the Checkin page. The mapping between ENOVIA Type, revision Policy and iteration Policy as the policies is specific to each Collaborative product.

Syntax: ENOVIA Type|Design TEAM Definition,Design TEAM Definition

Example:

(DEFAULTVALUE)INV Component|Design TEAM Definition, Design TEAM Definition

(ENFORCED)INV Assembly|Design TEAM Definition, Design TEAM Definition

Function: Define the integration to use for the Start Design feature, including an optional App version; the version is the integration version, not the CAD tool version

Syntax: integration|version

Examples:

SolidWorks

SolidWorks|V6R2011

Function: List of Webforms forms available to the user.

Examples:INVObjectProperties|INVSearchForm

Function: Define the list of possible type changes entered as a newline-separated list.

Examples: component|componentFamily

Function: Define how structures are loaded into the Checkout page

Possible Values:

• True--during checkout or promote, only root level assembly is brought for display in the Checkout or Promote page, User has to expand this node to get the first level children from the database.
• False--entire structure will be brought to Checkout or Promote page

Default Value: True

Function: Define the default lateral view to be applied

Syntax: [DEFAULTVALUE]LatestRevision

Function: Define the default vertical view to be applied

Syntax: [DEFAULTVALUE]None

Function: Define whether or not to select first level children when selecting a root node

Possible Values:

• True - select the first level children if you select the root node of a structure
• False - selecting the root node of a structure selects only that node

Default Value: False

For this flag to work as expected, MCADInteg-SelectChildItems must be false.

Function: Define the default location for downloading files during checkout.

Default Value: C:\temp

Function: Enable or disable rapid file access (hardlink).

Possible Values:

• True - Rapid file access is enabled
• False - Rapid file access is disabled

Default Value: False

Function: Define the path where the binary file for the CAD tool exists. This path is used to launch the CAD tool when the user clicks Start CAD Tool option from X-CAD Design Management.

Function: Define the lifecycle state at which a design is considered finalized. The policy governing the design must have at least two states where the first state must not be the finalization state.

Syntax: Policy|State

Examples:

Design TEAM Definition|FROZEN

Function: Enable or disable background checkin.

Possible Values:

• True - Background checkin option will be active by default during checkin
• False - The CAD tool is not released until the checkin operation is completed.

Default Value: False

Function: User Exits help you abort a particular action when the condition fails. The user exits for each event are entered on a single line.

Syntax: Value1,Value2

Examples: CheckinPartPre,CheckoutPartPre

For UG, ProE, and CATIA, values are entered as a space-separated list.

For SolidWorks, SolidEdge, Microstation and AutoCAD: values are entered as a comma-separated list.

For more details on IEF-UserExitEventRegistration, see About User Exits.

Function: Maps the custom workspace tables to the X-CAD Design Management pages.

Examples:

(DEFAULTVALUE)Version$Default@(DEFAULTVALUE)Checkout$Default@(DEFAULTVALUE)EBOMSynchronize$Default@(DEFAULTVALUE)Baseline$Default@(DEFAULTVALUE)PLMTree$Default@(DEFAULTVALUE)RecentlyAccessedParts$Default@(DEFAULTVALUE)StartDesign$Default@(DEFAULTVALUE (DEFAULTVALUE)Version$Default@(DEFAULTVALUE)Checkout$Default@(DEFAULTVALUE)EBOMSynchronize$Default@(DEFAULTVALUE)Baseline$Default@(DEFAULTVALUE)PLMTree$Default

"Default" can be any defined workspace table.

Function: Define characters that cannot be used in filenames. If any CAD object with any of these characters in file name is checked in, an error message is displayed and checkin is not allowed.

Example: "/\\|<>*$?;:@,[]{}%'#&

Function: This attribute is used to map an entity specific list of unsupported characters. Mappings for the following entities can be made:

• familybusname: Business object name of a family type object.
• instancebusname: Business object name of an instance type object.
• busname: Business object name of all other object types except family, instance, workspace/folder object.
• foldername: Business object name of Workspace and Workspace folder.
• filename: Name of the actual file.
• title: Title attribute of the business object.
• familytitle: Title attribute of the family.
• instancetitle: Title attribute of the instance.

Syntax: The mapping between entity type and unsupported characters is defined in the following format:

• title|<LIST OF UNSUPPORTED CHARACTERS>
• familytitle|<LIST OF UNSUPPORTED CHARACTERS>
• instancetitle|<LIST OF UNSUPPORTED CHARACTERS>
• familybusname|<LIST OF UNSUPPORTED CHARACTERS>
• instancebusname|<LIST OF UNSUPPORTED CHARACTERS>
• busname|<LIST OF UNSUPPORTED CHARACTERS>
• foldername|<LIST OF UNSUPPORTED CHARACTERS>
• filename|<LIST OF UNSUPPORTED CHARACTERS>

Default Mapping:

• title||
• familytitle|()
• instancetitle|/@
• familybusname|()
• instancebusname|/@
• busname||#@"$&%*?<>,[]
• foldername|\/:
• filename|/:*?"<>[]'|@\#$&%

Function: Enable or disable application of choices from parent to child nodes.

Possible Values:

• True - choices made for the parent node are applied to its child nodes.
• False - choices made for the parent node are not applied to its child nodes.

Default Value: False

Function: Enable or disable the ability to check in older version of designs if a higher version exists, such as occurs when one user checks out a design, then another user checks out the same design, makes changes, and checks it in. When the first user tries to check in changes, this attribute determines what happens.

Possible Values:

• True - Users can check in older version of the file, creating a version higher than any others in the revision stream.
• False - Users cannot check in older versions of the file; even to other revision streams of the design.

See About Lock Behavior for a discussion about how the various attributes related to locks affect the user's process.

Function: Define the EBOM Synch configuration object using the type, name, and revision.

Syntax: ENOVIAType|Name|revision

Default Value: MCAD-EBOMSyncConfig|MCAD-EBOMSyncConfig-TEAM|-

If you created subtypes of this object to configure it for your business processes (see Configuring the EBOM Configuration Object), use that name for the ENOVIA subtype.

Function: Proxy JPO Name which is used to call EBOM Syncronization on multiple cad objects.

Default Value: IEFEBOMProxy

Function: Maps CAD type to ENOVIA type and format

Syntax: CADType|ENOVIAType,format

Examples:

component|INV Component,prt

assembly|INV Assembly,asm

drawing|INV Drawing,drw

Function: Enable or disable the ability to retain lock after checkin.

Possible Values:

• True - Users can choose to retain the lock on objects when checking in
• False - Users can not retain the lock.

Default Value: False

Function: Set the registry name to indicate which View Registry object sets the lateral and vertical views.

Examples: CompanyViewRegistry

Default Value: DefaultViewRegistry

See Creating or Editing Checkout Views Registry.

Function: Maps default webforms for X-CAD Design Management pages.

Examples: (DEFAULTVALUE)Properties$INVObjectProperties@(DEFAULTVALUE)Search$INVSearchForm Properties$INVObjectProperties@Search$INVSearchForm

Function: Enable or disable copying of relationship attributes at checkin.

Possible Values:

• True - relationship attributes are copied on check in.
• False - relationship attributes are not copied on check in.

Default Value: False

If enabled, you must map relationship attributes using the MCADInteg-CADToMxRelAttribMapping attribute.

Function: Map ENOVIA-to-CAD attributes for attribute synchronization during checkout (attributes must exist). The user can choose whether or not to perform the attribute sync.

Syntax: ENOVIA-Type,ENOVIA-Attribute|CAD-Type,CAD-Attribute

When mapping the revision attribute for an iteration object, you can use any one of below formats:

• ENOVIA-Type,$$revision$$|CAD-Type,CAD-Attribute
• ENOVIA-Type,$$Major_Revision$$|CAD-Type,CAD-Attribute

When the object is not finalized, the first, $$revision$$, maps the ENOVIA iteration object to the CAD file; the second, $$Major_Revision$$, maps the ENOVIA revision object to the CAD file. Mapping for these attributes is supported from ENOVIA to the CAD file, not from the CAD file to ENOVIA.

Only use $$revision$$ OR $$Major_Revision$$ for an object type. Do not use both.

When mapping the major revision attribute for an iteration object, you can use any one of below formats:

• ENOVIA-Type,$$state$$|CAD-Type,CAD-Attribute
• ENOVIA-Type,$$Major_State$$|CAD-Type,CAD-Attribute

When the object is not finalized, the first, $$state$$ maps the ENOVIA iteration object to the CAD file; the second $$Major_State$$, maps the ENOVIA revision object to the CAD file. Mapping for these attributes is supported from ENOVIA to the CAD file, not from the CAD file to ENOVIA.

Only use $$state$$ OR $$Major_State$$ for an object type. Do not use both.

All the attributes listed in the MCADInteg-MxToCADAttribMapping are displayed as search fields in ENOVIA Open dialog box in the CAD Collaborative products. Only text based search is allowed using the fields added using this attribute. The system attributes are not displayed. For example, if the string

INV Component,Test01|component,MX_ATTRIB_TEST

is added to MCADInteg-MxToCADAttribMapping, then Test01 is added as a search criteria in ENOVIA Open dialog box.

Examples:

For system to system mapping:

INV Component,$$description$$ |component,$$Comments$$

Note that the attribute mapping of "description" string must be in lowercase. The mappings for System attributes must always be in lower case on the Mx side.

For system to custom mapping:

INV Component,$$Major_Revision$$ |component,rev

For custom to custom mapping:

INV Component,Test01|component,Test01

Function: Enable or disable warning if files will be overwritten during checkout.

Possible Values:

• True - warning for overwriting the file appears during checkout
• False - no warning displays

Default Value: True

Function: Enable or disable renaming of files on the server when user performs a Rename or Save As action

Possible Values:

• True - the files are renamed on the Server side during Rename and SaveAs
• False - no file renaming operation is done on the Server side during Rename and SaveAs.

Default Value: True

Function: Set the default state of the Create Version check box.

Possible Values:

• True - every checkin creates the next version
• False - the first object creates a version, and subsequently all the files are checked into the same version overwriting the earlier design.

Default Value: True

Function: Name of the JPO that creates the page layout for the preference page (do not change unless you create a custom JPO)

Default Value: IEFPreferencesPageLayoutTeam

Function: Set the default Checkout directory. Users can change their default Checkout directory from the Checkout or Preferences page.

Default Value: c:\temp

Function: Map the CAD relationship to ENOVIA relationship.

Syntax: CADRelationship|direction,MatrixRelationship

direction is to or from; use symbolic names for the ENOVIA relationship

Examples:

CADSubcomponent|to, CAD SubComponent

CADDrawing|from, Associated Drawing

Function: Map CAD types to ENOVIA template types for the Start Design function.

Syntax: CAD_TYPE|TEMPLATE_TYPE

Example:

component|INV Component Template

assembly|INV Assembly Template

drawing|INV Drawing Template

Function: Setting to apply the view to child nodes during checkout.

Possible Values:

• True - applies views to child nodes during checkout.
• False - views are not applied to child nodes during checkout.

Default: True

Function: Map ENOVIA relationships to CAD relationships.

Syntax: Matrix-Relationship-Type, Matrix-Attribute|CAD-Relationship-Type, CAD-Attribute

Examples:

CAD SubComponent,Spatial Location|CADSubcomponent,relativeXform

The relativeXform attribute represents the relative transform of a component with respect to its immediate parent assembly. Do not change this name. The mapped ENOVIA attribute can be any attribute defined on the CAD SubComponent relationship. The Local Configuration Object includes these attributes:

• MCADInteg-CopyRelAttribOnCheckout
• MCADInteg-CopyRelAttribOnCheckin

These attributes allow you to enable/disable this feature on an individual user basis. See Entering LCO Attribute Values.

Function: Map the business type to derived output types.

Syntax: CADBusinessType|DerivedOutputType

DerivedOutputType can be a comma-separated list of the types that have been defined for the specified object.

Example:

component|preview,dwf,step203,step214,pdf,cgr

Function: Enables or disables the selection of background derived outputs in the Preferences page.

When set to (DEFAULT)none, the checkboxes for each derived output file type under Selected Background Derived Outputs column in the Preferences page is available for selection.

When set to (ENFORCED)none, the selection is disabled for all options under Selected Background Derived Outputs column in the Preferences page.

Default Value: (ENFORCED)none

Function: Enable or disable the default setting for lock object on checkout.

Possible Values:

• True - Object is locked by default (but can be changed)
• False - Object is not locked by default

Default Value: False

Function: Map the list of derived outputs supported by the CAD tool to the listed derived outputs selected by default in the Preferences page and in the Derived Output selection page.

Syntax:

Integration Name1|<derived output format1>,<derived output format2>

Integration Name2|<derived output format2>,<derived output format3>

Example:

SolidEdge|image_jpg,image_tif

SolidWorks|cgr,image_jpg,image_tif

Function:

Holds the preference for the Selected Manual Derived Outputs option. The specified derived outputs have to be manually created and placed in the checkin directory, from where they are picked by the integration and checked in.

Syntax:

Integration Name1|<derived output format1>,<derived output format2>

Integration Name2|<derived output format2>,<derived output format3>

Example:

SolidEdge|image_jpg,image_tif

SolidWorks|cgr,image_jpg,image_tif

Function: This value is polulated when the administrator specifies a default folder through the Global Preferences.

Syntax:

(DEFAULTVALUE)<FolderType>,<FolderName>,<Revision>

Example:

(DEFAULTVALUE)Workspace Vault,F1,643C83190000240C4C8867FE000003DE

Default Value:[DEFAULTVALUE]

Function: Defines how the shared components or sub-assemblies bearing multiple CAD Subcomponent relationships with an assembly are displayed in the Navigate dialog box. The default value is TRUE..

Possible Values:

• TRUE - If the value of this attribute is TRUE, the number of shared components or sub-assemblies displayed in the Navigate dialog box is equal to the number of CAD SubComponent relationships that are created between the shared component / sub-assembly and the assembly.
• FALSE - If the value of this attribute is FALSE, only one object per shared component / sub-assembly is displayed in the Navigate dialog box even if the object occurs multiple times under the same parent assembly.

  A new “Quantity” column is added in the Navigate dialog box for the object, that displays the actual number of relationships of the assembly with a particular child.

This is a system level attribute and this attribute is generally not modified.

Function: Define the class for business types (can provide a comma-separated list)

Syntax: BusinessTypeClass|CADBusinessType

Examples:

TYPE_CADMODEL_LIKE|assembly, component, drawing, assemblyFamily, componentFamily

TYPE_COMPONENT_LIKE|component,componentInstance

TYPE_ASSEMBLY_LIKE|assembly,assemblyInstance

TYPE_FAMILY_LIKE|assemblyFamily,componentFamily

TYPE_INSTANCE_LIKE|assemblyInstance,componentInstance

TYPE_DERIVEDOUTPUT_LIKE| preview

TYPE_COMPONENT_FAMILY_LIKE|componentFamily

TYPE_ASSEMBLY_FAMILY_LIKE|assemblyFamily

Function: Enable or disable hashcode computation during checkin and checkout .

Possible Values:

• True - Hashcode computation enabled and the file transfer happens only after comparing the hashcode value of the local file and the hashcode stored in the corresponding business object in the database
• False - No hashcode computation is done

Default Value: True

Function: Enable or disable copying of relationship attributes at checkout.

Possible Values:

• True - Copies relationship attributes
• False - Does not copy attributes

Default Value: False

If enabled, you must map relationship attributes using the MCADInteg-MxToCADRelAttribMapping attribute.

Function: Define the CAD-to-Matrix relationship attribute mapping for attribute synchronization during checkin

The Title attribute should not be mapped from the CAD Tool to ENOVIA.

Syntax: CAD-Relationship-Type, CAD-Relationship-Attribute| Matrix-Relationship-Type, Matrix-Relationship-Attribute

Examples:

CADSubcomponent,relativeXform|CAD SubComponent,Spatial Location

Function: Map CAD business types to ENOVIA object types

Syntax: CADType|MatrixType

Examples:

assembly|INV Assembly

component|INV Component

drawing|INV Drawing

You can change the ENOVIA type, but not the CAD type. The ENOVIA type can be a comma-separated list requiring the user to select a type when the object is created.

All derived output cad types with name starting with "userfile_" mapped in the MCADInteg-BusTypeMapping attribute of the GCO will have the automatic and background selection disabled. These options are disabled because these derived outputs need to be generated explicitily by the user.

Function: Enable or disable the ability to select all children in the Checkin, Promote, SaveAs, and Checkout pages.

Possible Values:

• True - Enable
• False - Disable

Default Value: True

Function: Define the policies available for each ENOVIA object type (can provide a comma-separated list) .

Syntax:Type|Policy

Examples:

INV Component|Design TEAM Definition

INV Assembly|Design TEAM Definition

INV Drawing|CAD Drawing

INV Engine Component|Design TEAM Definition, CAD Model Engine Policy

Function: This system-level attribute determines if the relationship should be treated as an Assembly, Family, or External Reference.

Syntax: CADrelationship|RelationshipClass

Possible/Default Value:

CADSubcomponent|AssemblyLike

CADDrawing|AssemblyLike

CADInstanceOf|FamilyLike

JoinPart|AssemblyLike,ExternalReferenceLike

This attribute is not generally changed.

Function: Enable or disable the requirement to create a revision during the first checkin

Possible Values:

• True--Uses an existing revision object at checkin, or creates the revision object if it does not exist
• False--Uses an existing revision object at checkin, if it does not exist, shows an error message to the user. The Start Design, SaveAs, and Checkin features do not function if this attribute is set to false.

Default Value: True

Function: Enable or disable zip compression during checkin and checkout. When enabled, the system uses the zip utility included with Java (platform-independent). No additional zip utility is required on the client or server systems.

Possible Values:

• True--Compress files during checkin and checkout using Zip file compression
• False--Do not compress files during checkin and checkout

Default Value: (DEFAULTVALUE)true

Function: Set befault behaviour to download files locally during RFA checkout. Incase of locked objects, the file is downloaded to the local disk by default.

Possible Values:

• True - The file is downloaded to local disk during RFA checkout.
• False - The file is not downloaded to the local disk. Incase of locked objects, users have the option to change this value during checkout in the Checkout page.

Default Value: (DEFAULTVALUE)false

Function: Enable or disable selection of required children during checkout

Possible Values:

• True - The required children are selected upon checkout.
• False - The required children are not selected during checkout.

Default Value: False

Function: For CATIA V5 users, choose how to select alias directories

Possible Values:

• Current - The directory chooser lists and allows selection of ALIAS directories. If ALIAS directories are not registered by the App, then the directory chooser supports system directories but the user must specifically select the system directory using the directory chooser.
• Allowed - The directory chooser allows selection of system directories as well as ALIAS directories. If ALIAS directories are not registered by the App, then directory chooser supports the selection of system directories only.
• Not Allowed - The IEF applet ignores the ALIAS directories.

Function: Enable for silent checkin

Possible Values:

• True - during revision of an object, the files in the new revision are checked in into the store where the previous revision files existed
• False - the object is checked into default policy store

Default Value: False

Function: List menus (comma-separated list) to disable in the CAD tool when connected to ENOVIA (for SolidWorks, SolidEdge, Microstation, and AutoCAD integrations only).

Syntax: menuname1,menuname2

Examples: Save,Open

Function: Defines the mapping between attributes of Part and CAD objects.

Syntax:

<EC Part Type>,attribute|<ENOVIA Type>,attribute

Example:

Part|Originator|SE Component|Author

Part|Originator|SE Assembly|Author

Part|$$Description$$|SE Component|$$Description$$

Part|$$Description$$|SE Assembly|$$Description$$

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

Syntax: <Name of relatonship between engineering parts>,<Attribute on relationship between engineering parts>|<Name of relationship between CAD objects>,<attribute on relationship between CAD objects>

Example:

EBOM|Reference Designator|CAD SubComponent|Reference Designator

Function: Set the state of Release for an object.

Syntax: PolicyName Policy|StateName

Example: Design TEAM Definition|RELEASED

Function: Checks for obsolete nodes across revisions during the check in or save operation.

Possible Values:

• True - Save operation checks for obsolete objects in all existing revisions of the object.
• False - Save operation will NOT check for obsolete objects in all existing revisions of the object. Check for obsolete object is done only in the current revision stream.

Default Value: False

Local Workspace Management and Update will not honor the IEF-CheckObsoleteAcrossRevisions flag. Whatever the value of the flag IEF-CheckObsoleteAcrossRevisions, Local Workspace Management always checks for obsolete nodes across object's revision and the Update functionality always updates across object's revision.

Function: Enables or disables the ability to rename files in a batch process.

Possible Values:

• True - Enables
• False - Disables

Default Value: False

Function: Sets the function that shows on the Checkin page, delete all or delete selected, the user can check or clear the check box

Possible Values:

• Delete all local files - All selected files plus files with a status other than Modified or New in the checkin list are deleted after the checkin process.
• Delete selected local files - Only those files that are selected are deleted after the checkin process.

Default Value: Delete selected local files

Function: For CATIA only: When conflicts occur with IEF-UUID (universally unique identifier) attributes, this role is granted the ability to resolve the conflict of UUID.

Possible Values: Matrix Roles

Default Value: Integration Administrator

Function: For CATIA only: Checks the validity of IEF-UUID (universally unique identifier) attribute of the ENOVIA object before checkin.

Possible Values:

• True - Check is done
• False - Check is not done

Default Value: True

Function: Determines whether or not to execute a JPO that evaluates if an object can be selected for checkin. The return value of the JPO determines whether or not that object can be selected for checkin.

Possible Values:

• True - JPO is used to evaluate selection of objects
• False - JPO is not used

Default Value: (DEFAULTVALUE)false

Function: Determines whether or not to execute a JPO that evaluates if an object can be selected for checkout. The return value of the JPO determines whether or not that object can be selected for checkout.

Possible Values:

• True - JPO is used to evaluate selection of objects
• False - JPO is not used

Default Value: (DEFAULTVALUE)false

Pre-Checkout evaluation functionality is not supported in Collaborative Design products that use Native UI and therefore will not work for integrations which have an Native UI. Pre-Checkout evaluation is supported only for Connector for CATIA V5 version V6R2012.

Function: Defines the default expand level shown on the Checkin, Checkout, and Promote pages.

Default Value: 1

Function: Defines whether or not to automatically generate a derived output file if the user selected manual generation but the manually-generated file does not exist in the defined location

Possible Values:

• True - Generates the derived output for a design if the manually-generated file cannot be found
• False - Does not generate derived output; if the manually-generated file cannot be found, no derived output is checked in with the design.

Default Value: True

Function: Lists the interface attributes mapped in the IEF-CADToMxMandatoryAttrMapping attribute to prevent checkin from failing if the attributes are not present. If present, the listed attributes are updated after checkin.

Possible Values: A comma-separated list of interface attributes mapped in the IEF-CADToMxMandatoryAttrMapping attribute

Example: $$Author$$,mandatory

Function: Determines if the Assign Part column shows on the Checkin page, and if so, uses the selected Part name to name the CAD object being checked in for that Part. The true value is supported only for CATIA V5 collaboration tool. For other CAD tools, this value can be changed to true after the client-side extensions are installed.

Possible Values:

• True - Shows the Assign Part column
• False - Hides the Assign Part column

Default Value: False

Function: Defines whether or not to the EBOM synchronization process is initiated whenever a CAD object is checked in .

This attribute is supported for Checkin, Save As and Start Design features.

Possible Values:

• True - EBOM Sync will be done whenever a CAD object is checked in
• False - EBOM Sync must be manually initiated

Default Value: False

Function: Maps a Derived Output Parameter object to the derived output types it supports. Displayed in the Derived Output page (when checking in designs) as the list of Parameter Objects associated with a specific derived output format.

Syntax:DerivedOutputType|ParameterObject

where:

• DerivedOutputType - The image format used for derived output
• ParameterObject - The type, name, revision of the Derived Output Parameter object

Example:

image_jpg|Image DOP Parameter

cgr|CGR DOP Parameter

image_tif|Other DOP Parameter

Function: Defines the default derived output type for Derived Output Parameter objects. Shows on the Derived Output dialog (when checking in designs) as the default Parameter Objects for a specific derived output format.

Syntax: DerivedOutputType|DefaultParameterObject

where:

• DerivedOutputType - The image format used for derived output
• DefaultParameterObject - The type, name, revision of the Derived Output Parameter object to be used as the default .

Example:

image_jpg|Image DOP Parameter,myImageDOPParameterObj1,A

cgr|CGR DOP Parameter,myCGRDOPParameterObj1,A

image_tif|Other DOP Parameter,myOtherDOPParameterObj1,A

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

Default: IEF-MassPromoteConfig|IEF-MassPromoteConfig|-

Function: This attribute governs the Read-Only file behavior.

If "MCADInteg-FileReadOnlyBehavior" flag is set to "TRUE" then depending on the lock status of the design object in X-CAD Design Management, the file is made read-only or writable.

If the flag is set to "FALSE", then there are no behavior changes to any feature.

See Behavior Changes - Read Only Flag section on details of impact of this attribute on the features.

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.
• Individual: In Individual mode, only the selected object in the family table is revised.

By default, the value is Together.

This attribute is also applicable for Mass Update of Ownership.

If the value is set to Together, update operation for owner (including both Mass Update and Update) updates the owner attribute on Family and all of its instances including both Active and Inactive.

Some nodes that are not displayed on Navigate page are updated in the background.

Also, if an instance is connected to multiple revisions of family, the owner of all family revisions and its instances are updated.

If Change Owner operation is performed on the Family Object itself, the entire family tower (family and its active inactive instances) are updated and not the structure below the instances.

Function: This attribute governs the IEF-ObjectBasedConfigurationRevisionMode attribute behavior.

Possible Values:

• Together: In Together mode, the family table and its associated instances are revised together when revising any item from the family structure.

This attribute is also applicable for Mass Update of Ownership.

Function: This attribute governs behavior of the Download Structure operation. The inclusion or exclusion of children and sub-children in the downloaded structure is based on the value set for this attribute.

Possible Values:

• True: To include the child items of the node with Must In Structure = False, when you download a structure.
• False: To exclude the node with Must In Structure = false and its child , when you download a structure.

By default, the value is True.

Function: This attribute governs behavior of the Promote operation for a structure with External References links. The inclusion or exclusion of children in the structure with External references link having MustInStructure=false for promotion is based on the value set for this attribute.

Possible Values:

• True: To include children with External References relationship having MustInStructure=false in the structure for promotion.
• False: To exclude children with External References relationship having MustInStructure=false in the structure for promotion. If false, the nodes for children with external reference relationship having MustInStructure=false are disabled and cannot be selected.

By default, the value is True.

If IEF-PromoteUnrequiredRef = FALSE,

Children with External Reference relationship that have Must InStructure=false will not be expanded and will be excluded from promote operation.

Children with External Reference relationship that have MustInStructure=true can be expandable and will be considered in promote operation.

Children with CAD SubComponent relationship that have MustInStructure=false will be considered for promote operation.

Function: Locks the design while you are saving the designs in 3DEXPERIENCE R2022x or in the CAD.

The unlocked designs are not saved if this flag is set to true.

Click Lock in the dialog box when you are saving the design in CAD.

The dialog box is displayed if,

• The design is not locked by current user and
• The design is being saved for first time in the login session and
• The status of the design is not NEW .

When you are saving the design to 3DEXPERIENCE R2022x, you can view the unlocked designs from the Status column in the 3DEXPERIENCE-Save dialog box.

You can lock the unlocked designs using RMB Lock menu.