package Command

A package groups administrative objects. The package can then be associated with objects so that all items in the package are added to that object at once.

This page discusses:

User Level

Business Administrator

Add Package

To define a package from within MQL use the Add Package command.

Syntax

add package NAME [ADD_ITEM {ADD_ITEM}];
  • NAME is the name of the package you are defining.
  • ADD_ITEM provides additional information about the menu. The Add Package clauses are:
    member ADMIN_TYPE ADMIN_NAME {,ADMIN_TYPE ADMIN_NAME}
    usespackage NAME {, NAME}
    description VALUE
    custom [ [true] | false ]
    [!|not] hidden
    property NAME [to ADMINTYPE NAME] [value STRING]

Member Clause

This clause specifies the administrative types that are part of this package.

Usespackage Clause

This clause lets you incorporate a separate package as part of this package.

Modify Package

Use the Modify Packacge command to add or remove defining clauses and change the value of clause arguments.

Syntax

 modify package NAME [MOD_ITEM {MOD_ITEM}];
  • NAME is the name of the menu you want to modify.
  • MOD_ITEM is the type of modification you want to make. Each is specified in a Modify Package clause, as listed in the following table. You need specify only the fields to be modified.
    Modify Package Clause Specifies
    description VALUE The current description value, if any, is set to the value entered.
    add member ADMIN_TYPE ADMIN_NAME {,ADMIN_TYPE ADMIN_NAME} The specified administrative objects are added to the package.
    remove member [all | ADMIN_TYPE ADMIN_NAME {,ADMIN_TYPE ADMIN_NAME}] The specified administrative objects, or all administrative objects, are removed from the package.
    add usespackage NAME {, NAME} The specified packages are added to this package.
    remove usespackage [all | NAME] The specified packages are removed from this package.
    custom true Defines the package as custom.
    custom false Defines the package as not a custom package.
    hidden Defines the package as hidden.
    not hidden Defines the package as visible.
    property PROPERTY_NAME to ADMIN [value STRING] Adds the specified property to the package.
    | property PROPERTY_NAME [value STRING] Adds the specified property to the package.

Delete Package

If a package is no longer required, you can delete it using the Delete Package command.

delete package NAME;
  • NAME is the name of the package to be deleted.

Searches the list of defined packages. If the name is found, that package is deleted. If the name is not found, an error message is displayed.

After this command is processed, the package is deleted and you receive an MQL prompt for another command.