Manage Profiles

About Profiles

As a product designer, you can create multiple environment (ENV) profiles when you define the product. A profile can be referenced by applications at specific tenants and support binding to different endpoints.

To support binding to different endpoints, an ENV profile can contain a set of variables with values. These variables are used by individual modules to replace parameterized values.

For example, the URL is http://{env}.example.ge.com, where {env} is replaced with the value specified for the env variable. If the value of the variable env is QA, then the URL would be http://qa.example.ge.com.

Profiles give you the ability to do the following:

  • Use dot notation between the variable such as widgetA.env.
  • Create multiple profiles, where each profile contains a set of variables.
  • Set a profile as the default profile so that it is applied automatically to a tenant during first-time subscription.
    Note: You must identity a profile as a default profile.
  • Dynamically update the instance of a widget during a product subscription.
  • Call desired microservices for dashboards.
During tenant provisioning, the tenant administrator, or user with upgrade permissions, has the ability to do the following:
  • Apply the correct ENV profile during the tenant provisioning so that the resolved features are provisioned for the target/subscribed tenant.
  • Change the variable value through the tenant administrator tool.
    Note: Only custom variable names and values defined during the product packaging stage can be updated by the tenant administrator. System defined variable names and values cannot be updated.

Create a Profile

As a product designer, you can create one or more profiles so that these profiles can be referenced by applications at specific tenants.

About This Task

After you create profiles, you must save and then publish the product to associate the profiles with the product for the tenant.

Procedure

  1. In the module navigation menu, select Extensibility Tool.
  2. Select Profiles.
  3. Select + Add to add a profile.
    The New Profile window appears.
  4. Complete the following fields.
    In this fieldSelect or Enter
    NameA unique name for the profile.
    Note:
    • Cannot exceed 50 characters and cannot contain spaces or special characters other than periods (.), underscores (_), or dashes (-).
    • Variable names for widget microservices must be entered in the format <widget>.<environment> where <widget> is w1, w2, w3, etc., and <environment> is dev, qa, etc.
    Set as DefaultSelect the check box to make it the default profile.
    Note: The first profile you create is specified as the default profile. You can modify this selection. Specifying the default profile applies the profile automatically to a tenant during the initial product subscription.

    You must specify at least one profile as the default profile.

  5. To add variables, select the .
  6. Complete the following fields.
    FieldDescription
    VariablesEnter the variable for the profile. Used by an individual module to replace a parameter value.
    Note:
    • Cannot exceed 50 characters and cannot contain spaces or special characters other than periods (.), underscores (_), or dashes (-).
    • Variable names for widget microservices must be entered in the format <widget>.<environment> where <widget> is w1, w2, w3, etc., and <environment> is dev, qa, etc.
    ValuesVariable values.
    Note: Cannot exceed 1,000 characters.
  7. Select Done.
  8. Select Publish.
    Important: You must publish the product to apply the profiles to the product. If you do not publish, the profiles will not persist if you navigate away from the Extensibility Tool page.

Results

The profile or profiles are stored as part of the product.

Modify a Profile

As a Product Designer, you can modify profiles to edit, add, or remove variables.

Procedure

  1. In the module navigation menu, select Extensibility Tool.
  2. Select Profiles.
  3. Select for the profile you want to modify.
    The Edit Profile window appears.
  4. Modify the following fields, if applicable.
    FieldDescription
    NameA unique name for the profile.
    Note:
    • Cannot exceed 50 characters and cannot contain spaces or special characters other than periods (.), underscores (_), or dashes (-).
    • Variable names for widget microservices must be entered in the format <widget>.<environment> where <widget> is w1, w2, w3, etc., and <environment> is dev, qa, etc.
    Set as DefaultSelect the check box to make it the default profile.
    Note: The first profile you create is specified as the default profile. You can modify this selection. Specifying the default profile applies the profile automatically to a tenant during the initial product subscription.

    You must specify at least one profile as the default profile.

  5. Choose one of the following:
    • To delete variables, select .
    • To add variables, select .
    • To modify existing variables or values, select the field.
  6. Complete or modify the following fields, if applicable.
    FieldDescription
    VariablesEnter the variable for the profile. Used by an individual module to replace a parameter value.
    Note:
    • Cannot exceed 50 characters and cannot contain spaces or special characters other than periods (.), underscores (_), or dashes (-).
    • Variable names for widget microservices must be entered in the format <widget>.<environment> where <widget> is w1, w2, w3, etc., and <environment> is dev, qa, etc.
    ValuesVariable values.
    Note: Cannot exceed 1,000 characters.
  7. Select Done.
  8. Select Publish.
    Important: You must publish the product to apply the profiles to the product. If you do not publish, modifications to profiles will not persist if you navigate away from the page.

Copy an Existing Profile to Create a New One

As a product designer, you can copy an existing profile to create a new profile.

About This Task

After you copy the profile, you can modify the name, modify or delete variables and values, and set the profile as the default profile.

Procedure

  1. In the left navigation menu, select Extensibility Tool.
  2. Select Profiles.
    Existing profiles appear in the table.
  3. Select for the profile you want to copy.
    The Edit Profile window appears and names the profile as {profile name}_copy.
  4. Modify the following fields, if applicable.
    FieldDescription
    NameA unique name for the profile.
    Note: Cannot exceed 50 characters and cannot contain spaces or special characters other than periods (.), underscores (_), or dashes (-).
    Set as DefaultSelect the check box to make it the default profile.
    Note: The first profile you create is specified as the default profile. You can modify this selection. Specifying the default profiles applies the profile automatically to a tenant during the initial product subscription.

    You must specify at least one profile as the default profile.

  5. Choose one of the following:
    • To delete variables, select .
    • To add variables, select .
    • To modify variables or values, select the variable or value you want to modify.
  6. If you are adding or modifying variables, complete or modify the following fields, if applicable.
    FieldDescription
    VariablesEnter the variable for the profile. Used by an individual module to replace a parameter value.
    Note: Cannot exceed 50 characters and cannot contain spaces or special characters other than periods (.), underscores (_), or dashes (-).
    ValuesVariable values.
    Note: Cannot exceed 1,000 characters.
  7. Select Done.
  8. Select Publish.
    Important: You must publish the product to apply the profiles to the product. If you do not publish, the profiles will not persist if you navigate away from the Extensibility Tool page.

Delete a Profile

As a product designer, you can remove an existing profile.

Procedure

  1. In the left navigation menu, select Extensibility Tool.
  2. Select Profiles.
    The profile names and their associated variables and values appear.
  3. Select for the profile you want to delete.
    Note: If you delete the default profile and other profiles remain, you must specify a profile as the default profile.
  4. Select Publish.
    Important: You must publish the product to apply the updates to the product. If you do not publish, the updates will not persist if you navigate away from the Extensibility Tool page.

Modify a Tenant Profile

As a tenant administrator, you can add or modify variables or values in the tenant profile that was assigned during product subscription.

About This Task

Note: A tenant administrator cannot modify system-level profile variable names and values. System-level profile variable names and values display as read-only on the Tenant Preferences page. Modifications must be implemented by the product owner.

Procedure

  1. Sign in to the Administration tool.
  2. In the module navigation menu, select Tenant Preferences.
    The Tenant Preferences page appears.
  3. Select Profiles.
    The current tenant profile name and its associated variables and values appear.
  4. Choose one of the following:
    • To delete a custom variable, select .
    • To add a new set of variables and values, select .
    • To modify a set of variables and values, select .
  5. If you are adding or modifying variables, complete or modify the following fields, and then select Submit.
    FieldDescription
    VariablesEnter the variable for the profile. Used by an individual module to replace a parameter value.
    Note: Cannot exceed 50 characters and cannot contain spaces or special characters.
    ValuesVariable values.
    Note: Cannot exceed 1,000 characters.
  6. Select Submit.