Framework Dependencies in the Transfer Tool
This article describes how the transfer tool handles dependencies within the Ometa framework. This article may offer more insights on why certain items were automatically included in an import, or why certain warnings appear.
Important
The import and export wizards will handle all dependencies automatically.
Overview of Required Dependencies
Below is an overview of the dependencies for each type of framework content the transfer tool currently accounts for.
Note
The dependencies will cascade down to ensure all content is exported and imported correctly. For example, importing a view will have a dependency to the profile, which in turn has a dependency to the template.
Master Data
| Imported Type | Dependency Type | Description |
|---|---|---|
| Profile | Template | Profile requires the template to exist with the same fields. |
| Url Mapping | Profile | The profile of the url mapping is used to retrieve the credentials for authentication when creating a site. |
| Method Job | Method | As you know, a job to execute a method needs a reference to a method. |
| Synchronization | Method | For the different processing actions. |
| Synchronization | Profile | For the different processing actions. |
| Synchronization | View | For the source and destination views. |
| Realtime Key | Method | The method settings for the realtime key require a method. |
| Realtime Key | Profile | Necessary for the execution of the configured method. |
| Task Definition | Employee | For the owner, or assigned employees. |
| Task Definition | Role | For the owner, or assigned roles. |
| Task Definition | Method | The method defined for the end actions, or the method settings for system task definitions. |
| Task Definition | Profile | The profile for the end actions, or the method settings for system task definitions. |
| Task Template | Task Definition | The task definitions used for the steps in the task template. |
| Case Action | Dcs Method | The dcs method used for the case action. |
| Case Action | Grouped Action | The grouped action used for the case action. |
| Grouped Action | Dcs Method | The dcs methods used in the grouped actions. |
| Dcs Method | Method | The method used in the dcs method definition. |
| Dcs Method | Profile | The profile used for the dcs method definition. |
Objects
| Imported Type | Dependency Type | Description |
|---|---|---|
| Object | Service Endpoint | The master data definition of service endpoints when using service endpoints on an object. |
| Object Field | Object Field | For relational input / output fields. |
| Method | Method | Audit trailing before and after actions |
| Method | Method | The configured data extensions. |
| Method | Template | The templates configured for the method. |
| Method Field | Object Field | For the input field relations. |
| View | View | The creation, update or single record views used in the imported view or configured multi views. |
| View | Profile | The profiles used in the main method settings, data extensions, view functions and audit trailing. |
| View | Method | The main method and view functions. |
| Read View | View | For configured context listeners. |
| Read View | Context Manager | For configured context listeners. |
| Read View | Chart | For configured context listeners. |
| View Field | View | When using a input data source on an input field that uses another view. |
| Context Manager | Method | For context manager functions that use a method. |
| Context Manager | Profile | For context manager functions that use a method, and possible audit trailing profiles necessary for the method. |
| Context Manager | View | Required when the context managers has linked views configured. |
| Context Manager Field | View | When using an data source on a field that uses another view. |
Lifecycles
| Imported Type | Dependency Type | Description |
|---|---|---|
| Lifecycle | Object | The object configured for the lifecycle. |
| Lifecycle | Url Mapping | The configured url mapping for the lifecycle, only used when a new lifecycle is imported, otherwise the existing url mapping is retained. |
| Lifecycle Property | Method | The method used in the changed event settings, or the control method settings of the lifecycle property. |
| Lifecycle Property | Profile | The profile for the event changed settings or the control method settings. |
| Lifecycle Property | View | The view for the reference view settings of the lifecycle property. |
| Lifecycle Property | Object Field | The underlying object field for the lifecycle property. |
| State Action | Dcs Method | The method used in the state action. |
| State Action | Grouped action | The grouped action used in the state action. |
| State Permission | Role | The role the permission was created for. |
| State Permission | SP Group | The SP group used in the permission. |
| State Task | Employee | The configured owner employee, or assigned employees. |
| State Task | Role | The configured owner role, or assigned roles. |
| State Task | Task Definition | The original task definition for the state task. |
| State Task | Task Template | The original task template for the state task. |
| State Transition Action | Dcs Method | The method used in the state transition action. |
| State Transition Action | Grouped Action | The grouped action used in the state transition action. |
| State Transition Permission | Role | The role the permission was created for. |
Import Validations
To ensure correct configuration upon importing framework objects, the transfer tool validates the content to import before any content is imported.
In order to fix these warnings, one of the following actions can be taken:
- Include the configuration that would be invalid to be imported as well. If the affected item is already included in the import itself, verify that its configuration is valid on the solution where the export was taken.
- Exclude the item that caused the warning.
- Ignore the warning and continue. This is not advised as the import is likely to fail due to invalid object configurations.
Validations for Master Data
Below are the validations done onto master data, however these validations can be ignored and fixed after the import is done if the affected item was not imported itself with invalid configuration.
| Imported Item | Affected Item | Change | Ignorable | Explanation |
|---|---|---|---|---|
| Method | Method Job | Added Data Extension(s) | Yes, but running the method job will fail. | The method settings for the method job will miss profile configuration for the data extension(s). |
| Method | Method Job | Changed template(s) | Yes, but running the method job will fail. | The profile configured on the method job is not valid for the template configured on the method. This can also occur in its data extension profile configurations. |
| Method | Synchronization | Added Data Extension(s) | Yes, but running the synchronization will fail. | The method settings for the synchronization will miss profile configuration for the data extension(s). This includes the configured processing actions. |
| Method | Synchronization | Changed template(s) | Yes, but running the synchronization will fail. | The profile configured on the synchronization is not valid for the template configured on the method. This can also occur in its data extension and configured processing actions. |
| Method | Realtime Key | Added Data Extension(s) | Yes, but using the realtime key will fail. | The method settings for the realtime key will miss profile configuration for the data extension(s). |
| Method | Realtime Key | Changed template(s) | Yes, but using the realtime key will fail. | The profile configured on the realtime key is not valid for the template configured on the method. This can also occur in its data extension. |
Validations for Objects
Below are the validations done for objects, the import will fail if the affected item's object is saved at any point.
| Imported Item | Affected Item | Change | Ignorable | Explanation |
|---|---|---|---|---|
| Method | Method | Removed method fields | Yes, but the field relation will be removed. | The field relations rely on the affected method rely on the method fields of the imported item. Importing the method with fewer method fields may cause an invalid field relation. |
| Method | View | Added Data Extension(s) | No | The main method settings for the view or view functions will miss profile configuration for the data extension(s). |
| Method | View | Removed method fields | No | View fields must have a method field. |
| Method | View | Changed template(s) | No | The profile configured on the view is not valid for the template configured on the method. This can also occur in data extension profile configuration. This validation includes view functions for read views. |
| Method | Charts | Removed method fields | No | The series field of the chart must refer to a method field on the method. |
| Method | Charts | Changed template(s) | No | The profile configured on the chart is not valid for the template configured on the method. This can also occur in data extension profile configuration. |
| Method | Circular Charts | Removed method fields or changed field type | No | The legend field of the chart must refer to a method field on the method. The series field may not be a text field. |
| View | View Field | Changed view type | No | The input data source must be a multi record view. |
| View | View Field | Removed view fields | No | The view fields used in the key format and display format of input data sources must exist. |
| View | Read View | Changed view type | Only for context setters | The usage for the view must match the view type (e.g. Creation View must link to a Create view). The configured context listeners for views should also remain a read view. |
| View | Update View | Changed view type | No | The view types for the configured single record view and multi record view for inline editing must remain of type single record and multi record respectively. |
| View | Context Manager Field | Changed view type | No | The data source must be a multi record view. |
| View | Context Manager Field | Removed view fields | No | The view fields used in the key format and display format of data sources must exist. |
| Object | System Objects | / | No | Any dependency to system objects or their methods, views,.. must be already present on the imported framework installation. The transfer tool does not import system objects. |
| Method | Dcs Method | Added Data Extension(s) | No | The main method settings for the view or view functions will miss profile configuration for the data extension(s). |
| Method | Dcs Method | Changed template(s) | No | The profile configured on the dcs method is not valid for the template configured on the method. This can also occur in data extension profile configuration. |
| Method | Task Definitions | Added Data Extension(s) | No | The main method settings for the dcs method will miss profile configuration for the data extension(s). |
| Method | Task Definitions | Changed template(s) | No | The profile configured on the task definitions is not valid for the template configured on the method. This can also occur in data extension profile configuration. |
| Method | View | Added Data Extension(s) | No | The main method settings for the task definitions will miss profile configuration for the data extension(s). |
Validations for Lifecycles
| Imported Item | Affected Item | Change | Ignorable | Explanation |
|---|---|---|---|---|
| Lifecycle | Case(s) | Removed lifecycle state(s) with cases | No | Lifecycle states that still have cases on them may not be removed as this would lead to invalid cases. Ensure that no cases are in a removed state before importing. |