Item Commands

Use these commands to create, copy, modify, print or delete an instance of an item. This section provides an overview of command usage. See the specific command topics for additional details.

This page discusses:

User Level

Business Administrator

Syntax

[ add | copy | modify | print | delete ]ITEM ITEM_NAME [CLAUSES {SUBCLAUSES}];
  • ITEM_NAME is the name of the item.
  • CLAUSES provide additional information about the item.
  • SUBCLAUSES provide additional information about the item.

Add Item

This command creates an instance of an item. The Add command generally has many clauses and in some cases, subclauses specific to each item.

Syntax:

add ITEM ITEM_NAME [ADD_ITEM {ADD_ITEM}];

ITEM can be any of the following:

application association attribute
businessobject channel command
connection dataobject dimension
expression filter form
format group icon
index inquiry interface
location menu path
person portal program
policy property query
relationship rule set
role store table
site vault webreport
type
  • ITEM_NAME is a unique name for that kind of item.
  • ADD_ITEM is applicable fields for each item with defined values.

Copy Item

This command clones a definition, rename it, and make the specified modifications.

Syntax:

copy ITEM SRC_NAME DST_NAME [MOD_ITEM {MOD_ITEM}];

  • ITEM can be any of the items listed for the Add Item command above.
  • SRC_NAME is the original (source) item name.
  • DST_NAME is the new (destination) item name.
  • MOD_ITEM is applicable fields for each item with new values.

Modify Item

This command makes the specified changes to an existing definition.

modify ITEM NAME [MOD_ITEM {MOD_ITEM}];

  • ITEM can be any of the items listed for the Add Item command above.
  • NAME is a unique name for that kind of item.
  • MOD_ITEM is applicable fields for each item with new values. Refer to the specific item for more information.

Print Item

The Print Item command prints the item definition to the screen allowing you to view it. When a Print command is entered, MQL displays the various clauses that make up the definition.

print ITEM NAME [SELECT] [DUMP] [tcl] [output FILENAME];

  • ITEM can be any of the items listed for the Add Item command above.
  • NAME is the specific instance of the item.
  • FILENAME lets you specify the name of the file to save the printed information to.

Delete Item

This command enables you to delete an item when it is no longer needed in the 3DSpace environment. Because deleting certain items can affect other elements of 3DSpace, use it carefully. See the Delete section of each item chapter for a discussion of the impact of the deletion.

delete ITEM NAME;
  • ITEM can be any of the items listed for the Add Item command above.
  • NAME is the specific instance of the item.

Help Item

The Help Item command is always available while you are in the MQL interactive mode. Help commands produce a summary of all commands applicable to the item with the appropriate syntax.