application Command

An application is a collection of administrative objects (attributes, relationships and types) defined by the Business Administrator and assigned to a project. It acts as a central place where all application dependent associations to these other administration objects are defined.

For conceptual information on this command, see MQL Concepts: Applications.

This page discusses:

User Level

Business Administrator

Add Application

An application is created with the Add Application command.

add application NAME [ADD_ITEM {ADD_ITEM}];

ADD_ITEM provides additional information about the application:

description VALUE
icon FILENAME
version VALUE
[!|not]hidden
{member ADMIN access ACCESS_VALUE}
NAME [to ADMINTYPE NAME] [value STRING]
property NAME to ADMIN [value STRING]
  • ADMIN is an Add Application subclause and can be one of the following administration objects:
    Attribute
    Type
    Relationship
  • ACCESS_VALUE is one of the following options:
    public
    protected
    private

All these clauses are optional. You can define an application by simply assigning a name to it. If you do, 3DSpace uses the default application icon. If you do not want the default values, add clauses as necessary.

Version Clause

This clause provides additional information about the application you are defining. Application developers can use this information to classify versions or for other purposes. For more information, see About Administrative Object Names.

Member Clause

This clause lets you add members to the application. Application members can be Attributes, Relationships or Types that are already defined within the database. To each application member you can also assign the following levels of protection:

  • private
  • protected
  • public

The default level of protection is public.

In the following example, an application Catia is created. The application member of Catia is a type CTDrawing with the default protection level of protected.

add application Catia member type CTDrawing access protected;

Any type that you assign to an application must have at least protected (read) access to its ancestors in the inheritance tree. A derived type does not inherit protection level from its parent. Therefore, it must be assigned a protection level that is needed to access the parent definition. For example, you can assign the child (derived type) a protection level of public when the protection level of the parent is protected. But you cannot do the same when the protection level of the parent is set to private because it would not allow the child to access the parent definition.

A user who does not have access to a protected type still has toconnect and todisconnect access on objects of this type. However, fromconnect and fromdisconnect access are not allowed.

Copy Application

After an application is defined, you can clone the definition with the Copy Application command.

This command lets you duplicate defining clauses with the option to change the value of clause arguments:

copy application SRC_NAME DST_NAME [MOD_ITEM {MOD_ITEM}];

  • SRC_NAME is the name of the application definition (source) to copied.
  • DST_NAME is the name of the new definition (destination).
  • MOD_ITEMs are modifications that you can make to the new definition. For more information, see the table in Modify Application.

Modify Application

After an application is defined, you can change the definition with the Modify Application command.

This command lets you add or remove defining clauses and change the value of clause arguments:

modify application NAME [MOD_ITEM {MOD_ITEM}];

  • NAME is the name of the application you want to modify.
  • MOD_ITEM is the type of modification you want to make. You can make the following modifications. Each is specified in a Modify Application clause, as listed in the following table. You only need to specify the fields to be modified.
    Modify Application Clause Specifies
    name NEW_NAME The current application name changes to that of the new name entered.
    description VALUE The description is changed to the VALUE given.
    icon FILENAME The icon is changed to use the FILENAME given.
    version value The version is changed to the VALUE given.
    hidden The hidden option is changed to specify that the object is hidden.
    nothidden The hidden option is changed to specify that the object is not hidden.
    add property NAME [value STRING] The named property is added.
    add property NAME to ADMIN [value STRING] The named property is added to the ADMIN type .
    add member ADMIN access ACCESS_VALUE Modify the application members (they can be Attributes, Types or Relationships) and/or modify the level of protection for the application members.
    add property NAME [value STRING] The named property is added.
    remove property NAME [value STRING] The named property is removed.
    remove property NAME to ADMIN [value STRING] The named property is removed from the ADMIN type .
    remove member ADMIN access ACCESS_VALUE Remove application members.
    property NAME [value STRING] The named property is modified.
    property NAME to ADMIN [value STRING] The named property assigned to the ADMIN type changes to the value entered.
    member ADMIN access ACCESS_VALUE The current ADMIN definition and the access value changes to the value entered.

Each modification clause is related to the arguments that define the application.

Delete Application

If an application is no longer required, you can delete it with the Delete Application command.

delete application NAME;
  • NAME is the name of the app that you want to delete.

This command searches the list of applications. If the name is found, that application is deleted. If the name is not found, an error message results.