Jump to: navigation, search

Parameter Group Templates

Parameter Group Templates are sets of Operational Parameters that can be deployed to one or more tenants, and are defined by the Service Provider. A parameter can be grouped into more than one Group Template. You can also group sets of parameters into sections within a Parameter Group Template to enable you to create Parameter Group Sections within your parameter groups.

This screen displays a list of all defined Parameter Group Templates for which you have the required role privileges to view. To refresh the list at any time, click Refresh. Click a Parameter Group Template in the list, and its properties are displayed to the right of the list.

You can filter the contents of this list in several ways:

  • Type the name or partial name of the Parameter Groupt Template, In Use, or Tenant in the Quick Filter field.
  • Click the Tenant Filter button (the icon with the circle and horizontal bar) to open the Tenant filter panel. In this panel, click the checkbox(es) beside the tenants that you want to select. Use the Quick Filter field in this panel to filter the tenant list.
  • You can sort the Parameter Group Templates in the list by clicking on a column head. Clicking a column head a second time reverses the sort order.

You can perform the following tasks in this screen:


Creating Parameter Group Templates

The Service Provider creates Parameter Group Templates, and assigns Operational Parameters to them.

To create a Parameter Group Template:

  1. In the header, go to Operations > Operational Parameters > Group Templates.
  2. On the Parameter Group Template List panel, click New.
  3. On the New panel that is displayed to the right of the Parameter Group Template List panel, enter the properties (including adding parameters) of the new template.
  4. Optionally, you can click the Add Section button to add the Parameter Group Template to a section in the Parameter Group Template list. A new panel opens to the right. Perform the actions below:
    • In the new panel, type the name for the new section in the Name field.
    • Type the key name for the new section in the Key Name field.
    • Important
      These fields must be unique in the Parameter Group Template.
  5. Click Save to save the new Parameter Group Template, or click Cancel to cancel the new template and not save it in the database.


Modifying Parameter Group Templates

Changes that you make to a Parameter Group Template are not propagated to Parameter Groups that use that template.

  1. In the header, go to Operations > Operational Parameters > Group Templates.
  2. On the Parameter Group Template List panel, select the Parameter Group Template that you want to modify.
  3. On the <Parameter Group Template name> panel that is displayed to the right of the Parameter Group Template List panel, modify the properties of the Parameter Group Template, as required.
  4. When you are finished modifying the Parameter Group Template, click Save to save your changes, or click Cancel to cancel your changes and leave the Parameter Group Template unchanged.


Deleting Parameter Group Templates

You cannot delete a Parameter Group Template that is currently deployed.

  1. In the header, go to Operations > Operational Parameters > Group Templates.
  2. On the Parameter Group Template List panel, select the Parameter Group Template that you want to delete.
  3. On the <Parameter Group Template name> panel that is displayed to the right of the Parameter Group Template List panel, click Delete.
  4. In the Confirm Deletion dialog box, do one of the following:
    1. To remove the Parameter Group Template from the database, click OK.
    2. To keep the Parameter Group Template and not remove it from the database, click Cancel.


Managing the List of Operational Parameters in a Parameter Group Template

In a Parameter Group Template, you can manage the list of Operational Parameters in the following ways:

[+] Adding Operational Parameters to a Parameter Group Template


[+] Change the order of the Operational Parameters in the list of Selected Parameters


[+] Removing Operational Parameters from a Parameter Group Template


Deploying Parameter Group Templates

The Service Provider deploys Parameter Group Templates to tenants. At this point, the Parameter Group Template becomes a Parameter Group and is associated with a Routing Strategy.

  1. In the header, go to Operations > Operational Parameters > Group Templates.
  2. On the Parameter Group Template List panel, select the Parameter Group Template that you want to deploy.
  3. On the <Parameter Group Template name> panel that is displayed to the right of the Parameter Group Template List panel, click Deploy.
  4. In the Parameter Group Deployment panel, provide the following information:
    1. Parameter Group Name — The name that is assigned to this Parameter Group.
    2. Tenant — The tenant to which this Parameter Group belongs.
    3. Application — The Routing Strategy that will be used by this tenant and is associated with this Parameter Group. Click Search to select from a list of Routing Strategies.
  5. Click Next.
  6. In the Tenant panel, select the name of the tenant(s) to which you want to deploy the Parameter Group.
  7. Click Next.
  8. In the Parameter Group Deployment panel, specify the application(s) that you want to enable on this parameter group by clicking Add.
  9. In the Designated Applications panel, select the name of the application(s) that you want to add.
  10. Click Next.
  11. Preview the deployment in the Summary. If you are satisfied with the deployment, click Finish. To make changes, click Previous.
  12. Click Close.
Important
You can modify a Parameter Group Template after it has been deployed. For example, you can add, remove, re-order, and/or modify the parameters in an already deployed Parameter Group Template. Once saved, you can synchronize the changes and all Parameter Groups of the Parameter Group Template will be updated to the current structure.
This page was last edited on July 17, 2020, at 15:59.
Comments or questions about this documentation? Contact us for support!