Template Objects and Settings

The following table lists the expected behavior for all of the objects and settings in a template when applications or dimensions are exported from the source environment, and then imported and either added or updated in the target environment (depending on if the application or dimension already exists in the target environment).

When the application or dimension being imported already exists in the target environment, the application or dimension is updated with the information in the template file. (See Updating an Existing Application or Dimension using a Template). During the update, the following actions are possible depending on the object type:

  • Overwrite: The settings or parameters in the target application or dimension are overwritten with the settings or parameters from the template file. For example, if the template file contains a different name for an application than the target application, the name is overwritten with the name from the template.
  • Merge: New objects in the template file are added to an existing set of those objects in the target application or dimension, and the existing set of objects are retained. For example, if the template file contains a new dimension and node type, those objects are added to the existing dimensions and node types in the target application.
  • Retain: The object, setting, or parameter in the target application or dimension is retained even if a new one exists in the template. This is primarily used when the object is not included in the template file. For example, top node filters for subscriptions are retained in the target application because they are not included in the template file.
  • Replace: The object, setting, or parameter in the target application or dimension is replaced with those from the template file.

Table 27-1 Expected Behavior when Applications or Dimensions are Exported, Added, or Updated Using a Template

Object or Setting When an Application or Dimension is Exported: When an Application or Dimension is Added: When an Application or Dimension is Updated:
Applications Active applications are exported.

Note: The Disable Workflow setting at the application level is not exported.

New applications are added.

General application parameters such as name, description, and external system type and label (Universal applications only) as well as application registration information and application blockout periods for existing applications are overwritten.

Properties

For sequence properties, the last sequence value is not exported from the source environment. Sequence values in the target system will be generated based on the sequence in the target environment (or the sequence Starting Value if that sequence has not been incremented). See Working with Sequence Properties.

Property is created.

Property overrides are set for the application.

If a target property already exists with the same name but a different ID, the source property is renamed in the target environment to make it unique.

New properties are merged and ordered at the end of the property list.

The following property attributes are overwritten:

  • Labels
  • Descriptions
  • Base parameters
  • Application and node type overrides
  • Sort order
  • Required flag
Lookup Sets Only lookup sets that are used by properties or node type converters for the application are exported.

When you export a dimension, all lookup sets that are used by the application that contains that dimension are exported to the template file.

Lookup sets are created.

Lookup values are set for the application.

If a target lookup set already exists with the same name but a different ID, the source lookup set is renamed in the target environment to make it unique.

New lookup sets are merged.

General lookup set parameters, such as name and description, and lookup values are overwritten.

Global Connections
  • Only global connections that are used by extracts for the application are exported.
  • For security reasons, the location, identity name, user name, and password of a global connection are not exported.

Source global connections in the template file are matched to global connections in the target environment.

If a target connection already exists with the same name but a different ID, the source connection is renamed in the target environment to make it unique.

After the global connection is created in the target environment, you must edit it to add the location, identity name, user name, and password. See Creating Global Connections.

New global connections are merged.

General global connection parameters such as name and description are overwritten.

The location and credentials of the global connections in the target applications are retained, because that information is not included in the template.

Application Connections For security reasons, the location, identity name, user name, and password of a global connection are not exported.

You must modify the application registration in the target environment to add the location, identity name, user name, and password for the connection.

New application connections are merged.

General application connection parameters such as name and description are overwritten. Primary flag is also overwritten if the template has it set on a different connection than the target, or retained if the template does not have it set on a connection and the target does.

The location and credentials of the application connections in the target applications are retained, because that information is not included in the template.

Views Only views that contain viewpoints for the selected application are exported, and only the viewpoints for the selected application are exported.

Active and archived views are exported.

If a target view already exists with the same name but a different ID, the source view is renamed in the target environment to make it unique.

For view filters, if a source user or group does not exist in the target environment, the view filter is not imported and a message is displayed indicating the missing user or group.

New views, viewpoints, and permissions are merged.

General view parameters such as name and description are overwritten.

Show on Views page setting: If the filter type is the same, new users and groups are merged. If it is different, the target is overwritten with the filter from the template.

Time labels When you export an application, all of the time labels in the views for that application are exported.  

New time labels are merged.

General time label parameters such as name are overwritten.

Dimensions Active and archived dimensions are exported.

Attribute dimensions for the base dimension are exported.

Active and archived dimensions are created.

Attribute dimensions are created.

New dimensions are merged.

New attribute dimensions are merged.

General dimension or attribute parameters such as name and description as well as import and export options are overwritten.

Node Types

Active and archived node types are exported.

The following objects are exported for each node type:

  • Properties and property overrides
  • Node type converters
  • Custom validations
  • Permissions and policies

Node types are created for each dimension, along with the following objects:

  • Properties are added to each node type, and property overrides are set for each node type.
  • Node type converters are created if both the source and target applications exist in the target environment.

    Tip:

    When migrating applications with node type converters, migrate the source application for the converter first so that when you migrate the target application for the converter, the node type converter is created.
  • Custom validations are created for each node type.
  • Permissions and policies are created for each node type if the source user or group exists in the target environment.

New node types, node type converters, and custom validations are merged.

General node type parameters such as name and description are overwritten.

Hierarchy Sets

Active and archived hierarchy sets are exported.

The following objects are exported for each hierarchy set:

  • Custom validations
  • Permissions and policies

Hierarchy sets are created for each dimension, along with the following objects:

  • Custom validations are created for each hierarchy set.
  • Permissions and policies are created for each hierarchy set if the source user or group exists in the target environment.

New hierarchy sets, node types, and custom validations are merged. Matching child node types are updated.

General hierarchy set parameters such as name and description, as well as the Shared Nodes and Custom Order settings are overwritten.

Node Sets

Active and archived node sets are exported.

Caution: Top nodes are not imported.

Top nodes are not imported.

New node sets and node types for lists are merged.

General node set parameters such as name and description are overwritten.

Top nodes are retained because they are not included in the template file.

Viewpoints

Active and archived viewpoints are exported.

Normal and time labeled viewpoints are exported.

Only viewpoints for the selected application are exported.

 

New viewpoints are merged.

General viewpoint parameters such as name and description, as well as allowed actions, time labels, and editable properties are overwritten.

Compare Profiles Compare profiles for applications or dimensions containing the From or To viewpoint in the profile are exported.

Note: The From and To node parameters in a compare profile are not exported.

Compare profiles are created when both the From and To viewpoints exist in the target environment.

New compare profiles are merged.

Compare parameters such as name and description, as well as the compare scope and node filters are overwritten.

Queries

Saved public and private queries are exported when you export the application or dimension that contains the queries.

The Selected Node parameter is not exported.

Public queries are imported. Private queries are imported only if the user exists (by username) in the target system.

New public queries are merged. New private queries are merged only if the user exists (by username) in the target system.

General query parameters such as name, description, and code are overwritten.

Private queries that were promoted to public in the source will be promoted to public in the target.

If the viewpoint for a query does not exist in the target, the query is not imported.

Selected Node parameters for existing queries are retained in the target environment.

Subscriptions Subscriptions for target viewpoints are exported.

Note: If you are exporting an application that contains viewpoints that are the source of a subscription, the subscription is not exported.

Caution: Top node filters for subscriptions are not exported.

Subscriptions are created only if both the subscription source and target applications exist in the target environment.

Tip: When migrating applications with subscriptions, migrate the source application for the subscription first so that when you migrate the target application, the subscription is created.

Top node filters for subscriptions are not imported.

Source and target viewpoints are matched to identify existing subscriptions in target.

  • New subscriptions for viewpoint combinations that do not exist in the target are merged.
  • Existing subscriptions in the target are updated.

General subscription parameters such as name and description, as well as options, action and condition filters, and inclusion properties are overwritten.

Top node filters are retained.

Default assignees are retained. Alternate assignees are merged.

Bindings    

New non-mapping bindings are merged. Existing mapping bindings in the target application are replaced, because only one mapping binding is supported for each dimension.

General binding parameters such as name and description, as well as settings, keys, and mapping keys are overwritten.

Extracts Public and private extracts are exported.

Public extracts are imported. Private extracts are imported only if the user exists (by username) in the target system.

New public extracts are merged. New private extracts are merged only if the user exists (by username) in the target system.

General extract parameters such as name and description, as well as columns, filters, and options are overwritten.

Private extracts that were promoted to public in the source will be promoted to public in the target.

Custom Validations    

Overwritten

Constraints When exporting applications, application, dimension, and node type constraints are exported. When exporting dimensions, only dimension constraints are exported.  

New constraints are merged.

Existing constraints are overwritten.

Policies

Note: When you import a template, select Replace Policy Groups to replace existing policy groups in your target environment with the policy groups from the source template. See Working with Templates.

Policy users and groups are exported for the following objects:
  • Selected application
  • Dimensions in the selected application
  • Node types in the selected application
  • Hierarchy sets in the selected application
If a source user or group exists in the target environment, policy users and groups are imported.

If a source user or group does not exist in the target environment, the policy user or group is not imported and a message is displayed indicating the missing user or group and the associated object.

New policies and policy groups are merged.

General policy parameters such as name and description, as well as policy filters are overwritten.

Policy groups for existing policies are retained by default. When the Replace Policy Groups option is used, existing policy groups are replaced instead of retained.

Permissions

Note: When you import a template, select Replace Permissions to replace existing permissions in your target environment with the permissions from the source template. See Working with Templates.

Permissions and data access are exported for the following objects:
  • Selected application
  • Dimensions in the selected application
  • Node types in the selected application
  • Hierarchy sets in the selected application
  • Views with viewpoints in the selected application
If a source user or group exists in the target environment, permissions and data access are imported.

If a source user or group does not exist in the target environment, the permissions and data access are not imported and a message is displayed indicating the missing user or group and the associated object.

New permissions are merged.

Existing permissions and data access in the target are retained by default. When the Replace Permissions option is used, existing permissions and data access are replaced instead of retained.