The Global Configuration Object

Design with Creo Parametric is one of the suites of the Unified X-CAD Design-based integrations designed to use with 3DEXPERIENCE apps such as Engineering BOM Management. All Unified X-CAD Design-based integrations are configurable through an object called the Global Configuration Object.

The base type is MCADInteg-GlobalConfig. Design with Creo Parametric also creates a subtype called CREOUPS-GlobalCofig because Design with Creo Parametric adds its own specific attributes specific to itself. It typically has the name CREOUPS with a revision of TEAM.

The Global Configuration Object has the following attributes:

This page discusses:

MCADInteg-BusTypeMapping: (Multiline String)

This maps the business types from Design with Creo Parametric to 3DEXPERIENCE. The types on the left side of the separator (|) cannot change, but the 3DEXPERIENCE types they map to are modifiable.

Default Values:

assembly|VPMReference
assemblyInstance|VPMReference
assemblyFamily|XCADModelRepReference
component|VPMReference
componentInstance|VPMReference
componentFamily|XCADModelRepReference
drawing|Drawing
format|XCADNonPSBaseRepReference
layout|XCADNonPSBaseRepReference
diagram|XCADNonPSBaseRepReference
sketch|XCADNonPSBaseRepReference
manufacture|VPMReference
idf|XCADNonPSBaseRepReference
image_jpg|DerivedOutputEntity
tif|DerivedOutputEntity
postscript|DerivedOutputEntity
dxf|DerivedOutputEntity
iges|DerivedOutputEntity
step_ap203|DerivedOutputEntity
cgrOutput|DerivedOutputEntity
svgOutput|DerivedOutputEntity
cgrViewable|DerivedOutputEntity
svgViewable|DerivedOutputEntity
cgm|DerivedOutputEntity
linkableOutput|DerivedOutputEntity
note|XCADNonPSBaseRepReference
pdf|DerivedOutputEntity
dwg|DerivedOutputEntity

MCADInteg-CADToLRDAttribMapping: (Multiline String)

This is the Design with Creo Parametric to 3DEXPERIENCE LRD attribute mapping. It synchronizes attributes from Creo Parametric to the 3DEXPERIENCE LRD (Local Recognition Directory) as well as the attribute synchronization operation during checkin.

The syntax for each attribute mapping from Creo Parametric to 3DEXPERIENCE is: CADtype|filename.

The names of the valid Creo Parametric types are the same ones used in the MCADInteg-BusTypeMapping section. Valid names for the supported Creo Parametric types are: component, componentInstance, componentFamily, assembly, assemblyInstance, assemblyFamily, drawing, format, layout, diagram, and manufacture.

Default Values:

component|filename
componentInstance|uuid
componentFamily|filename
assembly|filename
assemblyInstance|uuid
assemblyFamily|filename
drawing|filename

MCADInteg-CADToMxAttribMapping: (Multiline String)

This is the Design with Creo Parametric to 3DEXPERIENCE attribute mapping. Use this for synchronizing attributes from Creo Parametric to 3DEXPERIENCE as well as the attribute synchronization operation during checkin. The syntax for each attribute mapping from Creo Parametric to 3DEXPERIENCE is the CADtype,CADparameter|Matrix type,Matrix attribute.

All user-defined Creo Parametric parameters are accessible through Design with Creo Parametric. In addition, Design with Creo Parametric can also access 3DEXPERIENCE system attributes such as V_description. Material attributes such as Mass, Density, and Volume can also be mapped to update during the Save operation.

The names of the valid Creo Parametric and 3DEXPERIENCE types are the same ones that appear in the MCADInteg-BusTypeMapping section. Valid names for the supported Creo Parametric types are: component, componentInstance, componentFamily, assembly, assemblyInstance, assemblyFamily, drawing, format, layout, diagram, and manufacture. The attributes specific to the mapping must exist in 3DEXPERIENCE and the attributes must be associated with the 3DEXPERIENCE types.

The following is an example of mapping from Design with Creo Parametric to 3DEXPERIENCE. This example maps Creo Parametric parameters (Description and Checkin comment) to 3DEXPERIENCE attributes for parts and assemblies and from Creo Parametric parameters (Description and Checkin comment) for drawings.

Note: The Design with Creo Parametric parameter names can be defined in any case (lowercase, uppercase, or camel case) in the mapping of the Global Configuration Object attribute MCADInteg-CADToMxAttribMapping. Design with Creo Parametric honors these names to transfer these attribute values during the Save operation.

Default Value: [blank] Example

component,description|VPMReference,V_description
assembly,DESCRIPTION|VPMReference,V_description
drawing,DESCRIPTION|Drawing,V_description
component,checkincomment|VPMReference,V_versionComment
assembly,checkincomment|VPMReference,V_versionComment
drawing,checkincomment|Drawing,V_versionComment 
component,Manufacture_Procure|VPMReference,V_IsManufacturable
componentInstance,Manufacture_Procure|VPMReference,V_IsManufacturable
assembly,Manufacture_Procure|VPMReference,V_IsManufacturable
assemblyInstance,Manufacture_Procure|VPMReference,V_IsManufacturable

MCADInteg-MxToCADAttribMapping: (Multiline String)

This map synchronizes attributes from 3DEXPERIENCE to Creo Parametric during the Open operation.

VPMReference,V_IsManufacturable|component,Manufacture_Procure
VPMReference,V_IsManufacturable|componentInstance,Manufacture_Procure
VPMReference,V_IsManufacturable|assembly,Manufacture_Procure
VPMReference,V_IsManufacturable|assemblyInstance,Manufacture_Procure

MCADInteg-UpdateAttribMapping: (Multiline String)

This map reflects the attributes in the Attribute Update dialog for the user to be able to update attribute values for the designs shown in the Save dialog.

1|Manufacture_Procure|V_IsManufacturable

IEF-CADTOMxMandatoryAttrMapping:

This map makes the defined attributes Mandatory during the Save operation.

component|V_IsManufacturable|TRUE
componentInstance|V_IsManufacturable|TRUE
assembly|V_IsManufacturable|TRUE
assemblyInstance|V_IsManufacturable|TRUE

MCADInteg-CADToMxRelAttribMapping: (Multiline String)

This is the Creo Parametric to 3DEXPERIENCE attribute mappings for relationships. This is also used for the Attribute Synchronization operation during checkin.

Default Value: [blank]

MCADInteg-DirectRelationships: (String)

During checkout, the Required Children option uses this attribute to determine the appropriate CAD-type relationship.

Default Value: 

assemblyComponent|drawing

MCADInteg-RelationShipClassMapping: (Multiline String)

This attribute classifies the relationships. As a rule, do not alter this attribute. This is a system level attribute that tells Unified X-CAD Design how to treat each relationship. Each entry is a map of two strings separated with this character (|). The left side of each entry denotes the Design with Creo Parametric-defined relationship and the right side denotes the class of the relationship.

Default Values: 

assemblyComponent|REL_INSTANCE_LIKE
drawing|REL_PRIMARY_DEPENDENCY_LIKE
InstanceOf|REL_FAMILY_ITEM_LIKE
md|Dependency|REL_EXTERNAL_REFERENCE_LIKE
merged|REL_EXTERNAL_REFERENCE_LIKE
format|REL_PRIMARY_DEPENCENCY_LIKE
derived|REL_PRIMARY_DEPENDENCY_LIKE
idf|REL_EXTERNAL_REFERENCE_LIKE
mfg|REL_EXTERNAL_REFERENCE_LIKE
DerivedOutputOf|DerivedOutputLike
ViewableOf|DerivedOutputLike
FileToFile|REL_PRIMARY_DEPENCENCY_LIKE
sketch|REL_PRIMARY_DEPENDENCY_LIKE
Suppressed|REL_PRIMARY_DEPENDENCY_LIKE

MCADInteg-RelMapping: (Multiline String)

This attribute maps Design with Creo Parametric-defined relationships to 3DEXPERIENCE relationships. The string on the left of the vertical line (|) is the Design with Creo Parametric-defined relationship. The string on the right of the (|) is the 3DEXPERIENCE relationship; a comma-separated list of two entries. The second entry such as VPMInstance is the name of the corresponding relationship in 3DEXPERIENCE. The first entry indicates the direction of the arrowhead for the relationship, either to or from.

Default Values:

assemblyComponent|to,VPMInstance
drawing|from,XCADBaseDependency
format|to,XCADBaseDependency
derived|to,XCADBaseDependency
merged|to,XCADBaseDependency
mfg|to,XCADBaseDependency
md|Dependency|to,XCADBaseDependency
idf|to,XCADBaseDependency
InstanceOf|to,XCADItem
FileToFile|to,XCADBaseDependency
sketch|to,XCADBaseDependency
Suppressed|to,XCADBaseDependency

MCADInteg-TypeClassMapping: (Multiline String)

This is a system level attribute that defines the class for business types. Do not modify this attribute. This attribute has two entries separated by a vertical line (|). The entry on the left defines the class for the business types, while the entry on the right contains a comma-separated list of Design with Creo Parametric types.

Default Values:

TYPE_ASSEMBLY_LIKE|assembly,assemblyInstance
TYPE_COMPONENT_LIKE|component,componentInstance
TYPE_FAMILY_LIKE|assemblyFamily,componentFamily
TYPE_OBJECT_WITHOUT_FILE|assemblyInstance,componentInstance
TYPE_DERIVED_OUTPUT_LIKE|svgOutput,cgrOutput,image_jpg,tif,gif,cgm,step_ap203,iges,pdf,png,postscript,dxf,dwg
TYPE_FAMILY_ITEM_LIKE|assemblyInstance,componentInstance
TYPE_DRAWING_LIKE|drawing
TYPE_VISUALIZATION_LIKE|cgrViewable ,svgViewable
TYPE_REPRESENTATION_LIKE|cgr,svg
TYPE_CAD_DOCUMENT_LIKE|format,layout,diagram,note,sketch
TYPE_BREP_LIKE|linkableOutput

MCADInteg-TypeDerivedOutputMapping: (Multiline String)

This attribute contains the mapping between business types and derived output types. This mapping determines the type of the derived output object that you want to create (if MCADInteg-CreateDerivedOutputObj is TRUE) for mapped business types. Each mapping contains two entries separated by a vertical line (|). The entry on the left is a business type in the Design with Creo Parametric context, and the entry on the right contains one or more derived output types. If there are multiple derived output types, separate them with a comma.

Default Values: 

component|image_jpg,tif,iges,step_ap203,png,cgrViewable, linkableOutput
componentInstance|image_jpg,tif,iges,step_ap203,png,xpr,cgrViewable, linkableOutput
drawing|image_jpg,postscript,dxf,iges,cgm,pdf,dwg
assembly|
assemblyInstance|
format|
layout|
diagram|
manufacture|
sketch|

MCADInteg-TypeFormatMapping: (Multiline String)

This attribute maps the Design with Creo Parametric type to the 3DEXPERIENCE type and format. Each entry is a map of two strings separated by a vertical line (|). The string on the left is the Design with Creo Parametric. The string on the right is the 3DEXPERIENCE type and its format.

For example, if the entry is component|VPMRefence,prt, then the components are checked in to the .prt format.

Default Values:

component|VPMReference,prt
componentInstance|VPMReference,prt
componentFamily|XCADModelRepReference,prt
assembly|VPMReference,asm
assemblyInstance|VPMReference,asm
assemblyFamily|XCADModelRepReference,asm
drawing|Drawing,drw
format|XCADNonPSBaseRepReference,frm
layout|XCADNonPSBaseRepReference,lay
sketch|XCADNonPSBaseRepReference,SEC
diagram|XCADNonPSBaseRepReference,dgm
note|XCADNonPSBaseRepReference,TXT
idf|XCADNonPSBaseRepReference,idf
image_jpg|DerivedOutputEntity,THUMBNAIL
tif|DerivedOutputEntity,TIF
postscript|DerivedOutputEntity,PS
dxf|DerivedOutputEntity,DXF
iges|DerivedOutputEntity,IGES
step|DerivedOutputEntity,STEP
cgrOutput|DerivedOutputEntity,CGR
svgOutput|DerivedOutputEntity,SVG
cgm|DerivedOutputEntity,CGM
png|DerivedOutputEntity,THUMBNAIL
pdf|DerivedOutputEntity,PDF
xpr|DerivedOutputEntity,XPR
xas|DerivedOutputEntity,XAS
svgViewable|DerivedOutputEntity,SVG
dwg|DerivedOutputEntity,DWG
linkableOutput|DerivedOutputEntity,FMTLINKABLE

MCADInteg-TypePolicyMapping: (Multiline String)

This attribute defines the policies to use for each type. Each entry is a map consisting of two strings divided with a vertical line (|). The left side of the (|) is the type and the right side is the policy that controls it.

Note: The types and policies must exist in 3DEXPERIENCE.

Default Values:

VPMReference|VPLM_SMB_Definition
XCADModelRepReference|VPLM_SMB_Definition
3DShape|VPLM_SMB_Definition
Drawing|VPLM_SMB_Definition
XCADNonPSBaseRepReference|VPLM_SMB_Definition
DerivedOutputEntity|VPM_PRIVATE

ProEAssemblyFamilyInstanceHandling: (String, DefaultValue: AssemblyFamilyInstanceLight )

This is an attribute specific to Design with Creo Parametric. Possible values are AssemblyFamilyInstanceLight and AssemblyFamilyInstanceLoaded.

This attribute defines whether or not assembly family instances are generated and retrieved into a session during the processing of the checkin command (and Lock or Unlock). When the option is defined to AssemblyFamilyInstanceLoaded, each assembly family instance is retrieved into a session and generates derived outputs. When the option is AssemblyFamilyInstanceLight, the instances are read from the Creo Parametric model file without loading each assembly instance into session. AssemblyFamilyInstanceLight is a significant performance gain over Assembly FamilyInstanceLoaded.

Default Value:

AssemblyFamilyInstanceLoaded

ProEAutoLoadMasterRep: (String, Default Value: FirstTime):

This is an attribute specific to Design with Creo Parametric. Possible values are: FirstTime, Always, and Never.

When a Creo Parametric assembly with a simplified representation active is being saved to 3DEXPERIENCE, this attribute controls whether or not the Master Representation is automatically loaded before the Save operation.

When this attribute is defined to the default FirstTime, the Master Representation automatically loads if the assembly does not exist in the 3DEXPERIENCE database.

When this attribute is specified to Always, the Master Representation is always automatically loaded before the Save operation, regardless of whether or not the assembly has been previously saved to the 3DEXPERIENCE database.

When this attribute is Never, the Master Representation does not automatically load before the Save operation, regardless of whether or not the assembly has been previously saved to the 3DEXPERIENCE database.

Defining the ProEAutoLoadMasterRep attribute to FirstTime or Never can provide improved performance because you do not need to activate the entire Master Representation before every save of the assembly. However, you must ensure that all components participating in the Master and other Simplified Reps are saved to the 3DEXPERIENCE database. In general this can be ensured by:

• If the assembly is modified to include a new component, then check in the assembly with the Master Representation (or a Simplified Rep that includes that new component) active.

Note: If a Master or Specific Representation of an assembly is opened using 3DEXPERIENCE>Open, but it has missing components (for example, the assembly was never saved with the Master or Specific Representation active) then the requested representation of the assembly opens by suppressing the missing components. Messages regarding the missing components get written to the text area of Design with Creo Parametric. If the assembly is to be saved to 3DEXPERIENCE again, care must be taken to retrieve the missing components and to unsuppress them in the assembly.

Default Value:

FirstTime

ProEDerivedOutputOptions: (Multiline String):

This is an attribute specific to the Design with Creo Parametric. This attribute defines the user-configurable options of image file and derived output generation. The syntax is:

derivedoutput|option=value,<option=value,…>

Default Values:

image_jpg|width=5.0,height=5.0,depth=8,dpi=100,delete_on_checkin=yes
tif|width=5.0,height=5.0,depth=8,dpi=100,delete_on_checkin=yes
postscript|size=auto,variable_width=0.0,variable_height=0.0,quality=3,scale=1,pen_slew=no,
pen_velocity_x=0.0,pen_velocity_y=0.0,pages=all,first_page=0,last_page=0,segmented_output=no,
label=no,separate_files=no,delete_on_checkin=yes
cgrViewable|sag=0.0,delete_on_checkin=yes
dxf|all_sheets=yes,delete_on_checkin=yes
iges|delete_on_checkin=yes
step_ap203|delete_on_checkin=yes
png|width=5.0,height=5.0,delete_on_checkin=yes
pdf|depth=color,dpi=300,pages=all,delete_on_checkin=yes
xpr|delete_on_checkin=yes
xas|delete_on_checkin=yes
svgViewable|delete_on_checkin=yes
dwg|all_sheets=yes,delete_on_checkin=yes

Notes:
  1. delete_on_checkin specifies whether or not to delete the derived output file on successful completion of the check-in operation. If you choose Yes, then the derived output file is deleted on checkin. If you choose No, then the derived output file is not deleted.
  2. For the CATIA Graphics Representation (CGR) derived output generation, the definition of the SAG value is used by the Spatial’s module that generates the CGR. The SAG value is a float value that enables the application to tessellate based on this value to have finer details of the design in the CGR file generated and improves the quality of the CGR. The lower the value, the better the quality is. The default value is 0.0.

ProEObjectLoadingInSession: (String, Default Value: LoadObjectsInSession)

This is an attribute specific to Design with Creo Parametric. Possible values are LoadObjectsInSession and DoNotLoadObjectsInSession. This attribute defines whether or not to load objects that are unavailable in the session. This affects nonrequired related items that are not in session. For example, layouts may have references to many other objects that are not loaded in session. If this attribute is defined to DoNotLoadObjectsInSession, Design with Creo Parametric does not attempt to bring the unloaded objects into session. When this option is defined to DoNotLoadObjectsInSession, no derived outputs get generated for unloaded objects.

Default Value:

LoadObjectsInSession

ProEPartFamilyInstanceHandling: (String, Default Value: PartFamilyInstanceLoaded)

This is an attribute specific to the Design TEAM Definition Management. Possible values are PartFamilyInstanceLight and PartFamilyInstanceLoaded.

This attribute defines whether or not part family instances are generated and retrieved into session during processing of the checkin command (lock/unlock). The PartFamilyInstanceLoaded option retrieves each part family instance into session to interrogate the structure, looks for nested instances, and generates derived outputs. The PartFamilyInstanceLight option reads the instances from the Creo model file without loading each instance into session. PartFamilyInstanceLight is a significant performance gain over PartFamilyInstanceLoaded. The limitation is that some operations, such as derived output generation, cannot be performed on instances that are already in session. When using the PartFamilyInstanceLight setting, it is possible for you to generate derived outputs by loading specific instances into a session.

Default Value:

PartFamilyInstanceLoaded

ProEUnloadedChildRelationshipExceptions: (String, Default Value: ‘’)

This is an attribute specific to the Design with Creo Parametric. This allows a comma-separated list of relationship names as found on the left-hand side of the mappings in the MCADInteg-RelMapping GCO attribute (for example; assemblyComponent, drawing, format, derived, merged, mfg, and mdlDependency). The default value is an empty string.

The purpose of this setting is to ignore missing children depending on their relationship to the parent model. To avoid an incomplete structure checking-in, Design with Creo Parametric prohibits any model to be selectable for checkin if any of its related children are missing. This can happen for nonrequired related children that are unnecessary for successful regeneration of the parent model. It may be desirable to make exceptions for certain types of relationships where it may be common for nonrequired related children to be missing on disk. This most often occurs with part-to-part or part-to-assembly relationships that are mapped as merged and mdlDependency relationships.

If this value is empty, there are no exceptions and any missing child results in the parent object not selectable for checkin.

If this value is mdlDependency,merged, then an exception is made for any missing child of a mdlDependency or merged relationship and the parent object is selectable for checkin.

ProEMissingLinksWarning: (Boolean, Default Value: FALSE )

This is an attribute specific to the Design with Creo Parametric. The app alerts you of missing links corresponding to nonrequired relationships when checkin is chosen from the 3DEXPERIENCE menu.

You can continue or cancel the checkin operation. If you choose to continue with the check-in operation, Design with Creo Parametric can either prevent those parent models with missing links from being selected for check-in or can ignore the missing links and allow the parent models to be selected for check-in. This behavior is controlled by the GCO attribute ProEUnloadedChildRelationshipExceptions.