Mandatory Attribute Support

The attribute, IEF-CADToMxMandatoryAttrMapping, in the Global Configuration Object (GCO) allows the administrator to provide the mapping.

This page discusses:

The administrator uses Mandatory Attribute support to allow:

  • The user to synchronize certain attributes from CAD to 3DEXPERIENCE, regardless of whether the user selects the Copy Attributes option on the Checkin page. If the administrator marks attributes as mandatory, by putting them in the IEF-CADToMxMandatoryAttrMapping in the GCO, the system always synchronizes the indicated attributes. Synchronization occurs even when the user does not select Copy Attributes.
  • The administrator to provide mandatory attributes a value that is used regardless of the value that exists on the CAD tool.
  • The administrator to provide a value that can be over-written by the Client Side Extension (CSE), if required.
  • The CSE to provide the value of the mandatory attributes.

Format

The mandatory attribute type is defined in the Mandatory Attribute format.

The format of the CAD to 3DEXPERIENCE mandatory attribute name is:

attributeName,attributeValue,attributeType

In this mapping:

  • attributeName: The name of the attribute, for example, $$Comments$$.
  • attributeValue : The value of the attribute, for example, SOLIDWORKS File.
  • attributeType: The type of the mandatory value. The attribute Type can have the following values:
    • mandatory: The CSE must use the value specified in the attributeValue, ignoring the value of attributes in the File Summary Properties or the File Custom Properties.

      The administrator must provide a value in attributeValue as mandatory attributes require a value.

    • default: The CSE can use the value specified in the attributeValue or can over-write it based on some criteria. Presently, the CSE uses the attributeValue and synchronizes it with the X-CAD Design Management attribute.

      The administrator needs to provide a value for attributeValue with the default attribute Type as mandatory attributes require a value.

    • null: The CSE searches for the attribute in the File Summary Properties or in the File Custom Properties and synchronize the value with the X-CAD Design Management attribute. If a file or custom attribute is specified as null, that property should contain a value.

      The administrator should not provide a value for attributeValue as the CSE ignores the entries for attributeValue.

      .

Rules for Mandatory Attributes

This section lists the rules for mandatory attributes.

  • To declare an attribute mandatory, specify the attribute in IEF-CADToMxMandatoryAttrMapping as well as in MCADInteg-CADToMxAttribMapping.
  • All mandatory attributes must have a value.
  • If the administrator sets attributeType as mandatory or default, the administrator should provide a value in attributeValue, which cannot be empty. If it is empty, the user receives an error message noting that mandatory attributes cannot be empty.
    Note: The mappings for system attributes require lowercase on the Mx side.
  • If the system administrator sets attributeType as null, then the CAD user must ensure that the attribute, if it exists in File Summary Properties or File Custom Properties, holds a value and is not empty. If it is empty, the user receive an error message noting that mandatory attributes cannot be empty.

The system requires adherence to these mandatory attribute rules when users save with or without selecting the Copy Attributes option.