Importing Definitions

Definitions can be imported into a scheduler from either a file containing exported definitions, or by directly connecting to another Scheduler. If the definitions already exist in the target environment, they can optionally be updated. If they do not exist, they can optionally be inserted.

ID’s are only unique within the scheduler where they exist. UIDs are unique across schedulers.

When updating or inserting the items, the item names can be changed, and items referenced in the item can be redirected to a different environment in the target environment. For example, an import file that contains a task along with its referenced agent definition, can be imported into the target system with the included agent definition, or with the task pointing to a redirected agent that already exists in the system.

Importing from a file

Select the folder under Authoring where the new items in the exported file will be placed.

From the context menu or from the list menu select the Import from File menu option which will display the following dialog:

Select the file containing the exported items and then press OK. The Import Dialog is displayed.

Importing directly from another Scheduler

Select the folder under Authoring to synchronize with another Scheduler.

From the context menu or from the list menu, select the Import from Scheduler option which will display the following dialog:

Select Scheduler Fields

Field Description
Scheduler Select the scheduler from the drop-down list that will be used for synchronizing items in the current folder. All scheduler connections defined in Scheduler Properties will be displayed in this list. See Scheduler Connections
Filter Options

Only items matching this criterion will be included in the import dialog. The following options are available:

  • All Items – Will include all items in the folder
  • Only new items – Will only include new items
  • Only modified items – Will only include items that have been modified with a newer modified date.
  • Only new and modified items – Will include all new items and any items that have been modified with a newer modified date.
Name Filter Only items containing this string will be included in the import dialog.

Select the scheduler and filtering options and then press OK. The Import Dialog is displayed.

Import Dialog

The Import Definitions dialog displays all items which can be imported.

The Import Definitions dialog box displays containing the items contained in the exported file.

The Import Definitions dialog box is split vertically into two panes:

Left Pane:

The left pane displays a list of the items contained in the export. The list is displayed in a tree view where the root items are items that were explicitly exported, or items that were included as references.

Child items are references within the root item that may not be included in the list. For the root item to be imported, references must exist in the target environment, or they must exist in the exported file and be selected for import. References can also be redirected to a different item in the target system. If a reference for an item has not been resolved, the item is flagged with an error as shown in the following image:

In the example, Job B doesn’t exist in the target system and is not selected to be included in the import. Therefore, Daily Process cannot be imported until that reference has been resolved.

If the item has been selected for import, and all references for the item are resolved, a green checkmark is displayed with the item as show in the following image:

The user is also warned if the item being imported is older than the existing item in the target. A yellow clock icon is displayed as shown in the following image:

Following is a description of the import columns:

Field Description
Source Name Name of the item included in the export file for root items. For child nodes, this is the name of the references for the child’s parent node.
Type Type of the item.
Action Action that will be performed on the item. This could be Insert, Insert as New, Update or blank.
Target Exists Displays YES if the item in the export file already exists in the target system.
Target Name The name that will be given to the item being imported for an insert, or if the item already exists in the target, it is the name of the item in the target system. In most cases this will be the same name as the Source name unless it already exists in the target and has been renamed in the target.
Target Folder The folder in the target system where the item will either be inserted or updated.

From the context menu on the list, or from the list menu, the following actions are available:

Action Description
Select All Selects all items in the list for import.
Un-select All Un-selects all items in the list.
Restore Changes Reverts any changes to the selected item.
Restore All Changes Reverts any changes to all items in the list.
Change Name Displays a dialog where the name for the item being imported can be changed. Only available for root nodes.
Insert as New Only available for root nodes where the item already exists in the target scheduler. Changes the item being imported from an update to an insert. This will give the item a new UID, and any items in the import that reference this item, will have their reference redirected to this new item.
Replace Reference Only available for item reference. Displays a lookup dialog where the reference can be redirected to a different item in the target scheduler.
Replace Reference (All Items) Only available for an item reference. Displays a lookup dialog where the reference can be redirected to a different item in the target scheduler. Any references of this same item will be replaced in all items in the import. For example, if you had two tasks that both referenced the same agent, replacing the reference with this menu option would redirect the reference in both tasks.

Import Criteria

Before any item can be imported, these criteria must be met.

Criteria

Description

The definition must exist in the file being imported

Any items whose details are found in the import file will have a checkmark available by them so that they can be selected for import. Items that do not have the checkmark by them are displayed as a reference only for the items that are included in the file.

Referenced definitions are an option when exporting definitions.

The item must have no missing references

Any referenced definitions must either exist in the current system, or they must be selected for import. If neither of these conditions is met, there is an option to change the reference to a definition of the same type that exists in the current system. This option is available on the right pane of the dialog box.

The name must be unique

The name of the items being imported must be unique within the folder where they are being inserted or updated. If there is already a definition with a name of one on the items being imported, the name of the item being imported must be changed before the import can occur. This option is available on the right pane of the dialog box.

User must have modify rights for the items

For any items that already exist in the current server (action of import), the user performing the import must have modify rights for that item which will be updated.

User must have access rights to referenced items

For any references for any of the items being imported, the user performing the import must have access rights to that item. For any referenced items the user does not have access to, the reference must be changed to one the user does have access to.

Any items that do not meet these criteria are flagged in the import list. When you select an item that does not meet the criteria the details of which criteria that are not met are displayed on the right pane.

Right Pane:

In the right pane, details about the currently selected item are displayed. This section can be collapsed so that more columns in the list can be viewed: