toolset Command

Business Administrators create three types of programs:

• Programs, which can be executed without first selecting an object. This type of program might perform a query and generate a report on the found objects.
• Methods, which are programs that are associated with particular object type. For example, a method on a Product object might create a User Guide object and connect it to the Product automatically.

Toolsets can be defined and managed from within MQL.

[add|copy|modify|print|list|delete]toolset NAME {CLAUSE};

• NAME is the name of the toolset you are defining. The toolset name cannot include asterisks.
• CLAUSEs provide additional information about the toolset.

Syntax

add toolset NAME [user USER_NAME] [ADD_ITEM {ADD_ITEM}];

• NAME is the name of the toolset you are defining. When assigning a name to the toolset, you cannot have the same name for two toolsets. If you use the name again, an error message will result. However, several different users could use the same name for different toolsets. (Remember that toolsets are local to the context of individual users.)
• USER_NAME can be included with the user keyword if you are a business administrator with person access defining a toolset for another user. If not specified, the toolset is part of the current user’s workspace.
• ADD_ITEM specifies the characteristics you are setting. The following are Add Toolset clauses:

  [!|in|notin|not]active

  program | NAME {,NAME} |

  method

  [!not]hidden

  visible USER_NAME{,USER_NAME};

  property NAME on ADMIN [to ADMIN] [value STRING]

Program Clause

This clause allows you to define which programs should be added to the Toolset. You can include multiple programs.

Method Clause

This clause allows you to define the method to be added to the Toolset. Only one method can be included in a toolset.

After a toolset is defined, you can clone the definition with the Copy Toolset command.

If you are a business administrator with person access, you can copy toolsets to and from any person’s workspace (likewise for groups and roles). Other users can copy visible toolsets to their own workspaces.

This command lets you duplicate toolset definitions with the option to change the value of clause arguments:

copy toolset SRC_NAME DST_NAME [COPY_ITEM {COPY_ITEM}] [MOD_ITEM {MOD_ITEM}];

• SRC_NAME is the name of the toolset definition (source) to be copied.
• DST_NAME is the name of the new definition (destination).
• COPY_ITEM can be:

  COPY_ITEM	Specifies
  fromuser USERNAME	USERNAME is the name of a person, group, role or association.
  touser USERNAME
  overwrite	Replaces any toolset of the same name belonging to the user specified in the touser clause.

  The order of the fromuser, touser and overwrite clauses is irrelevant, but MOD_ITEMS, if included, must come last.

• MOD_ITEMs are modifications that you can make to the new definition. For more information, see Modify Toolset.

modify toolset NAME [user USER_NAME] [MOD_ITEM {MOD_ITEM}];

• NAME is the name of the toolset you want to modify. If you are a business administrator with person access, you can include the user clause to indicate another user’s workspace object.
• MOD_ITEM is the type of modification you want to make. You can use these modification clauses to change a toolset:

  Modify Toolset Clause	Specifies
  active	The active option is changed to specify that the object is active.
  notactive	The active option is changed to specify that the object is not active.
  add program NAME {,NAME}	The named program is added to the toolset.
  add method NAME {,NAME}	The named method is added to the toolset.
  remove program NAME {,NAME}	The named program is removed from the toolset.
  remove method NAME {,NAME}	The named method is removed from the toolset.
  remove all	All methods and programs are removed from the toolset.
  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 visible USER_NAME{,USER_NAME}	The object is made visible to the other users listed.
  visible USER_NAME{,USER_NAME}	The object is made visible to the other users listed.
  property NAME [to ADMINTYPE NAME] [value STRING]	The named property is modified.
  add property NAME [to ADMINTYPE NAME] [value STRING]	The named property is added.
  remove property NAME [to ADMINTYPE NAME] [value STRING]	The named property is removed.
  remove visible USER_NAME{,USER_NAME}	Visibility to the toolset is removed from the specified users.

These clauses are essentially the same ones that are used to define an initial toolset except that Add property and Remove property clauses are included. When making modifications, you simply substitute new values for the old.

Although the Modify Toolset command allows you to use any combination of criteria, no other modifications can be made except the ones listed. To change the toolset name or remove the toolset entirely, you must use the Delete toolset command and create a new toolset.

delete toolset NAME [user USER_NAME];

• NAME is the name of the toolset to be deleted. If you are a business administrator with person access, you can include the user clause to indicate another user’s workspace object.

This command searches the local list of existing toolsets. If the name is found, that toolset is deleted. If the name is not found, an error message results.

When a toolset is deleted, there is no effect on the business objects or on queries. Toolsets are local only to the user’s context and are not visible to other users.