Overview

This reference contains detailed information about using each MQL command.

MQL is intended for deep customization of the system, and should only be used in specifically identified areas (such as access control customization through policies definition). Do not use it for administration purposes. Instead, use these apps:

  • Members Control Center for inviting persons and assigning roles to them
  • 3DSpace for managing collaborative spaces
  • Collaboration and Approvals: Advanced profile for managing organizations
  • Manage P&O and Content console for roles definition
  • Collaborative Spaces Configuration Center for naming rules, versioning scheme, editing maturity graph, and attribute definition
  • Data Model Customization for defining or modifying schema such as subtypes, extensions, and attributes

This page discusses:

See Also
What's New

When to Use MQL

For conceptual information related to the commands, see MQL Concepts.

MQL is used to develop and customize applications. It should not be used for data creation or manipulation. It is important to restrict the use of MQL to developers who understand the relationships between the various administrative objects, existing code, and business processes.

Apps run JavaBean code that requires data to have specific characteristics and conditions. For example, objects may have to have certain relationships defined, have specific values entered for attributes, be in specific lifecycle states, or be in particular vaults. When a person uses an app in the 3DEXPERIENCE platform, these data conditions are met. However, MQL is not aware of these conditions and therefore a person executing MQL commands can easily compromise data integrity.

Certain actions have different results depending on where the action is taken. A command on a JSP page could include options (such as additional MQL clauses) to ensure that the operation is completed as the app expects, but a user issuing MQL commands has no guidance on what options should be specified.

MQL can be used in the following situations:

  • App features require data that cannot be created within the app user interface.
  • Automated business rules and processes need to be configured, such as triggers and autonamers.
  • Data needs to be investigated for troubleshooting, testing, or data conversion.

MQL should only be used in these situations, using the instructions provided in the administration roadmaps or in conjunction with DS professional services or customer support, and only by specially-trained business administrators. Also, using any programming interface that does not go through the applications bean layer has the potential to cause undesirable results within the app data.

Recommended Apps for Administrative Tasks

Several tools are available to work with people, organizations, and content. This table lists the preferred tool for each platform type:

Function On the Cloud On Premises Baseline Behavior On Premises Customer-Specific Behavior
Recommended Tool Tools not to Use Recommended Tool Tools not to Use Recommended Tool Tools not to Use
Inviting persons (Creating users) Members Control Center Collaboration and Approvals Members Control Center or VPLMPosImport Collaboration and Approvals or MQL Members Control Center or VPLMPosImport Collaboration and Approvals, Manage P&O and Content, or MQL
Managing groups User Groups — VPLMPosImport MQL VPLMPosImport MQL
Assigning roles Members Control Center — Members Control Center or VPLMPosImport MQL Members Control Center or VPLMPosImport Manage P&O and Content or MQL
Managing organizations Collaboration and Approvals (Advanced Profile) — Collaboration and Approvals (Advanced Profile) or VPLMPosImport MQL Collaboration and Approvals (Advanced Profile) or VPLMPosImport MQL
Managing collaborative spaces 3DSpace — 3DSpace or VPLMPosImport Manage P&O and Content or MQL Manage P&O and Content or VPLMPosImport MQL
Adding attributes Collaborative Spaces Control Center — Data Model Customization or Collaborative Spaces Control Center MQL Data Model Customization or Collaborative Spaces Control Center MQL
Defining predicate for 6W filtering Enterprise Control Center — Enterprise Control Center MQL or config.xml Manage P&O and Content or VPLMPosImport MQL or config.xml
Defining new roles Not available Manage P&O and Content or VPLMPosImport MQL
Defining new policies Not available MQL —

In addition, the Legacy ENOVIA Web Apps Customization Guide provides information for a developer or an architect to create custom apps or functionality. Do not use the information in that guide to perform any of the functions listed in the above table.