23 Working with Templates

Templates enable you to store application or dimension configurations in an offline file for use in other Oracle Enterprise Data Management Cloud environments. Use templates to transfer applications or dimensions and their metadata objects across environments (for example, from a test environment to a production environment) or to get a quick start in new implementations.

To use a template, first you export an application or a dimension and all of its related metadata objects in the source environment to a .json file, and then you import that template in the target environment.

Note:

Use migration to move all applications in an environment to a different environment at once. See Using Migration. Templates are used to transfer specific applications across environments.

Templates contain metadata only and do not include any data, requests, or transaction history.

Best Practice

If you are creating an application in a test environment that you plan to transfer to an existing production environment, it is a best practice to refresh your test environment with a current snapshot of your production environment first, and then create the application to be transferred. This ensures that global objects such as properties and views have the same IDs in both environments.

Considerations

  • You must be a Service Administrator to use templates.
  • You can transfer new applications or dimensions from the source to the target environment, or you can transfer applications or dimensions that already exist in the target environment. The template import process updates existing applications or dimensions in the target environment by creating objects that do not already exist and modifying existing objects for the target application or dimension. See Updating an Existing Application or Dimension using a Template.
  • You can transfer active applications only. However, archived data chain objects, such as dimensions or viewpoints, are included when you transfer an application.
  • You can transfer multiple applications in a single template file. If you are transferring at the dimension level, you cannot transfer multiple dimensions in a single template file.
  • When transferring dimensions, the application that contains the dimension must exist in the target environment.
  • To transfer an application or a dimension between environments, both environments must be on the same release version.
  • When importing a template, if a user or group exists in both the source and target environment, the following user and group references for the associated objects are imported:
    • Permissions
    • Policy users and groups
    • Subscription Assignees
    • View filters for users and groups

    If a user or group in the source environment does not exist in the target, the associated user or group reference are not transferred. A message is displayed indicating the missing users and groups in the target environment and the associated objects that were not imported.

  • Both the source and target applications or dimensions must exist in the target environment in order to import node type converters and subscriptions. Transfer both the source and target applications in the same template file, or else ensure that you import the source application or dimension for converters and subscriptions first, so that when you import the target application or dimension the converters and subscriptions get created.
  • When you import the following global objects, if the object already exists in the target environment with the same name but a different ID, the source object is renamed in the target environment to make it unique:
    • Properties
    • Views
    • Lookup Sets
    • Global Connections
  • After you export an application or a dimension to a template, you can review the contents of the template file in a .json viewer.

    Caution:

    Manually editing the template file is not supported.

To export applications or a dimension to a template:

  1. From the Tools tile, select Templates.

    Note:

    The Tools tile is visible to Service Administrators only.
  2. On the Export tab, perform an action:
    • To export applications, select an application from the left panel. Use Ctrl/Cmd+Click to select multiple applications. The applications that you select are listed in the Selected Artifacts section.
    • To export a dimension, expand the application in the left panel and select the dimension to export. You cannot select multiple dimensions in a single template file.

      Note:

      To export an attribute dimension, select the base dimension for the attribute dimension.
  3. In Template File, enter a file name with a .json extension, and then click Export.

    The template is created and downloaded to your local file system. The status of your export is displayed.

To import an application or a dimension from a template:

  1. From the Tools tile, select Templates.

    Note:

    The Tools tile is visible to Service Administrators only.
  2. On the Import tab, click Choose File.
  3. From your local file system, select a file with a .json extension, and then click Open.
  4. Optional: Click Preview to identify the objects in the template file and view the status of each. See Previewing Template Imports and Reviewing Import Results.
  5. Click Import, and then click Yes on the confirmation message.

    The template is imported, and the status of each object in the template is displayed. See Previewing Template Imports and Reviewing Import Results.