Skip to main content
Version: 3.2

Importing Macros

Importing macros by uploading a macro definition file (see Macro File Examples) allows you to upload multiple macros without having to manually define each macro.

You can import macros directly from a file to any object (Account, Template, User, Configuration).

Notes
  • You can import macrodef files in XML (v9) or JSON (v9 and later) formats. For examples, see Macro File Examples.
  • v9 macros cannot be encrypted.
  • Imported macrodef files with encrypted values will only import the macro name. The value will be empty.

You can import macros in two ways:

  • Method 1: Using the Add Macros dialog, which allows you to both upload a macro file and manually enter name/value pairs
  • Method 2: Using the Upload Macro File dialog, which only allows you to upload a file.

Method 1: Add Macros Dialog​

  1. Click the Add Macro button.

  2. In the Add Macros dialog, drag and drop or browse and select an existing XML or JSON file:

    Add Macros Drop

  3. The name-value pairs defined in the macro file are added to the Add Macros dialog:

  1. If required, encrypt the macro value by clicking the Lock icon in the Value field.

    Important

    If you click the Lock icon, the following warning is displayed:

    Secure-Macro-Dialog

    Secured macros cannot be unsecured, and their values cannot be edited. If you need to change the value of a secured macro, you must delete and readd it.

    For more information, see Securing Macros.

  2. Manually enter any additional name/value pairs as desired.

  3. Click the CONTINUE button.

  1. You are returned to the Macros list:

    Macros Imported List

  2. For each macro, click the empty space in the Description column, enter a descriptive name, and press Enter.

    Macros Imported List

Method 2: Upload Macro File Dialog​

  1. Click the dropdown arrow next to the Add Macro button and select Import Macros:

    Import Macros Dropdown

  1. In the Upload Macro File dialog, drag and drop or browse and select an existing XML or JSON file:

    Upload Macro File Drop

  2. As soon as you drop or select a file, the macros are added and you are returned to the Macros list:

    Macros Imported List

  3. For each macro, click the empty space in the Description column, enter a descriptive name, and press Enter.

    Macros Imported List

Macro File Examples​

{
  "macroSet" : [ {
    "id" : 1,
    "name" : "T_AZURE",
    "macros" : {
      "macro" : [ {
        "id" : 1,
        "name" : "AZURE_CLIENT_ID",
        "value" : "",
        "encryptValue" : false,
        "description" : "Required. Credentials used to access azure services."
      }, {
        "id" : 2,
        "name" : "AZURE_CLIENT_SECRET",
        "value" : "",
        "encryptValue" : false,
        "description" : "Required. Credentials used to access azure services."
      }, {
        "id" : 3,
        "name" : "AZURE_TENANT_ID",
        "value" : "",
        "encryptValue" : false,
        "description" : "Required. Tenant ID (Directory ID) assigned by Azure Active Directory service."
      }, {
        "id" : 4,
        "name" : "AZURE_CONTAINER_NAME",
        "value" : "",
        "encryptValue" : false,
        "description" : "Required. Name of the container in azure storage account which contains data files"
      }, {
        "id" : 5,
        "name" : "AZURE_STORAGE_ACCOUNT",
        "value" : "",
        "encryptValue" : false,
        "description" : "Required. Name of the azure storage account."
      } ]
    }
  } ]
}