Configuration Transfer Tools (CTT)

 

Content

Overview

Exporting Features

Exporting SDCs

Exporting SDIs

Working with Transfer Packages

CTT ANT Tasks
 

Exporting Items from the Web Page Designer

Overview of Node Hierarchy Export

Exporting Pages

Exporting Page Types, Elements, Gizmo Types, Step Definitions, and Layouts

Exporting Gizmos

Exporting Workflow Definitions

Importing Items

 

Overview

Top ../images/arwup.gif (846 bytes)

The Configuration Transfer Tool (CTT) is a set of integrated tools distributed throughout LabVantage:

 To export SDCs and SDIs...

Use the "Export" sidebar operation on the SDC List page and SDI List pages, respectively. For simple transfers with few RI implications (such as when transferring Actions), use this with the "Adhoc" option. For simple transfers with more complex RI considerations, (such as when transferring Protocols), use this with the "Export Script" option. Both of these options are described in Exporting Features, Exporting SDCs, and Exporting SDIs.

To import data, use the Import page on the target as described in Importing Items.
To export anything in the database (SDCs, SDIs, tables, table columns), or export a large number of items...

Create a Transfer Package using System Admin → System Tools → Transfer Package, as described in Working with Transfer Packages. This excels at transferring collections of data.

To import data, use the Import page on the target as described in Importing Items.

To export Web Page Designer items (Pages, Page Types, and Elements)...

Use the "Export" button on the relevant List page in the Web Page Designer, as described in Exporting Items from the Web Page Designer.
To deal with projects that require data synchronization and other procedural activities...

Develop an ANT script to run from the source system and another for the target system. Execute the scripts from System Admin → System Tools → Run Ant. If you are familiar with ANT, this is described in CTT ANT Tasks and the CTT ANT Task Reference.
To import any exported item from the LabVantage interface...

Use System Admin → System Tools → Import, as described in Importing Items.
To compare SDCs between two databases...

Use the Compare Configurations Tool in System Admin → System Tools → Compare Configurations.
To modify system-wide options...

Use the System Configuration Transfer Options in System Admin → System → Configuration.
To view events logged during the transfer...

Use System Admin → System Tools → Transfer Log.

You must export from and import to the same DBMS.

For example, if you export files from an Oracle DBMS, you must import them back into Oracle. Similarly, if you export from an MS SQLServer DBMS, you must import them back into SQLServer. You can not transfer files between Oracle and SQLServer.

You must export from and import to the same LabVantage version.

For example, if you export files from a LabVantage 8.0.0 database, you must import them into another LabVantage 8.0.0 database.

You can export only from the local machine.

 

Exporting Features

Top ../images/arwup.gif (846 bytes)

Exporting is more complex than importing. When setting up an export, you specify what you want to export, how to export it, and how it will be imported. After you complete the export, you just do the import... and the export file does what you told it to do.

Here's an overview of export features, listed in the order of how complex each feature is to use (complexity is proportional to power):

1.

Export

The "Export" operation in List pages is used to export selected SDCs and SDIs. It works with an RSet containing a list of selected items. Note that exporting an SDC in a given component development mode excludes columns from different components.

When you export an SDC, there are no options. When you export an SDI, there are two Export options... "Adhoc" and "Export Script":
Adhoc

"Adhoc" lets you define a single set of options for exporting SDIs for an SDC (a la carte). This generates an XML file called an "Export Package", which contains data produced by the export, as well as directives concerning how the data will be imported into the target database. This is what you will be importing, i.e., the deliverable.

Example:

Workitem SDC

 

Workitem-A; Workitem-B; Workitem-C

 

 

Export Roles

 

 

Force Update

 

 

Sync Data Model

Adhoc exports are good for quick, simple transfers that do not require a great deal of control over the export process. However, without adequate data model knowledge, Adhoc exports may lead to RI issues on import. For more complex exports requirring high degrees of control, Export Scripts are more suitable (below).
Export Script

"Export Script" lets you define multiple sets of options for exporting SDIs. This generates an XML file called an "Export Script" (also a deliverable), which contains the definition of how to export SDIs for an SDC. Unlike "Adhoc", this is reusable. For example, you can run an Export Script from a button, or in a Transfer Package (next item).

An "Export Script" defines how a given SDI (or set of SDIs) for an SDC is exported. The set of SDIs is defined by the [export.rsetid] property. An Export Script contains a set of "Export Steps" that define the data to be exported. This data may be tables for the current SDC and/or other SDC/SDI data.

For a given SDC, you define an Export Script in the SDC Maintenance page for the relevant SDC.

Example:

Workitem SDC

 

Export Script

 

 

Full Workitem-A

 

 

Export Workitem_A

 

 

Export Parameter Lists in Workitem_A

 

 

Export Parameters in Workitem_A

 

 

Partial Workitem-B

 

 

Export Parameters in Workitem_B

 

 

Force Update

 

 

Partial Workitem-C

 

 

  

Export Specifications in Workitem_C

 

 

  

Sync Data Model
2.

Transfer Package

A "Transfer Package" can export anything in the database, and define how to do each export. For SDIs, a Transfer Package can also run Export Scripts. Use this to transfer a large number of items.

A "Transfer Package" defines an export for a set of data, and comprises a set of Export Steps that define the data to be exported. This data may be SDC/SDI data and/or specific tables. The data that is exported is defined in the "Transfer Steps" in the form of queries, categories, keyids and keyfiles. The Transfer Package also defines the location of the export file(s). A Transfer Package contains one or more "Transfer Steps" that define the export of an SDI and/or table.

Example:

Transfer Package

 

Transfer Item 1

 

Action SDC

 

 

Export KeyId1 List from AddSDI Action

 

 

Run Export Script 007

 

Transfer Item 2

 

WebPageProperty table

 

 

Export properties for WebPage-A, WebPage-B, WebPage-C

 

 

Run Export Script 008

 

Transfer Item 3

 

User SDIs having the "Tech" Role

 

 

Export Departments for these Users

 

Transfer Item 4

 

 

SDIDataItem table

 

 

  

Export Transform Value and KeyId1 List
3.

Ant Script

Ultimately flexible, this lets you build and run an Ant script to export anything in the database. As an extension of the Transfer API, a set of Ant Tasks is provided for use when writing the script.

 

Exporting SDCs

Top ../images/arwup.gif (846 bytes)

Export SDC Wizard Overview

 

Click the Export operation on the SDC List. The Export Wizard guides you through the process.

Wizard Flow:

1.   Review Selections
2.   Set files options.
3.   Run export.

Export SDC Wizard Detail

 
1.

Review Selections

Review

Review your changes before proceeding.
2.

Set File Options

Option Description
Enter the name of the export file This is the name of the exported zip file. The maximum file size is set by the "Maximum Download File Size" in System Configuration → Miscellaneous Options → File Management.
Log import This creates a log on the target database (TransferLog table). You can define this as a system-wide setting using the System Configuration Transfer Options. Also, logs can be imported using the "Import Logs" option in the SiteMap.
Requires ESig . . . During the import, you can require an ESig operation. You can define this as a system-wide setting using the System Configuration Transfer Options.
Check for file modifications on import Setting this option will direct the import process to check if the file has been changed.

Note that all files will be checked if the target database 'blocks' changed files. You can define this as a system-wide setting using the System Configuration Transfer Options.

Note that all files will generate a checksum element independent of this option.
Create an ANT file This creates an ANT file to use in an ANT import script. Essentially, the ANT file mimics the manual export process.
3.

Run Export

Export Complete indicates the export was successful. The file is downloaded through the browser to its specified download location.

 

Exporting SDIs

Top ../images/arwup.gif (846 bytes)

Export SDI Wizard Overview

 

Click the Export operation on the SDI List. The Export Wizard guides you through the process.

Wizard Flow:

1.   Review Selections
2.   Set export options.
3.   Set file options.
4.   Run export.

Export SDI Wizard Detail

 
1.

Review Selections

Review

Review your changes before proceeding.

2.

Set Export Options

Export Script

"Standard Export Scripts" for each SDC are defined in the relevant SDC Maintenance page's "Export Scripts" detail as shown in SDCs → Supporting Functions → Exports, and you can determine the behavior of the script by examining it as shown. In general, most OOB scripts provide a basic level of export capability, although more comprehensive export is available for some SDCs. See Enhanced SDI Export Scripts for more information.

Adhoc Export

Data are always added to the Export Package from the "primary" table. Additionally, these options are available:

NOTE:   Exporting details of SDCs does not export the referenced items themselves. The appropriate foreign keys (referenced items) must exist on the target system in order for the import to succeed. See Export FK related tables below.
NOTE:   Records from the SDINote and SDIAttribute tables are automatically included.
Export Options Description
Detail tables Detail tables are D-type links defined by the SDC you are exporting.
SDIxxx detail tables SDI detail tables are associated with other SDCs. They are not defined in the SDC you are exporting.
Roles

Categories

 Roles and Categories export data in the SDIRole and CategoryItem tables, as well as data in the parent Role and Category tables.
FK related tables Foreign key tables contain data from foreign key-related SDCs. They are F-type links defined by the SDC you are exporting.

Foreign key exports use relationships defined in SDCLink and SDCDetailLink tables. For example, if the Param SDC is added as a foreign key link for the ParamListItems detail table, the Parameters for a Parameter List are exported when the foreign key link is set.
Security details Controls whether or not these Security details are exported:
•Security columns (securitydepartment, securityuser and securityset)
•Security SDIXXX tables (sdisecuritydepartment and sdisecurityset)
•FK links to Department, User and LV_SecuritySet
Flush Options Description
SDI Flushes the entire SDI from the target before any new records are imported.

In order to use this option, the import must be done in the LabVantage application. The import cannot be done using a CTT Ant Task, as this option uses the DeleteSDI Action (which allows all SDC Rules associated with the delete process to be honored).
Detail tables Detail table records on the target system will be flushed before they are imported ensuring true synchronization.
SDIxxx detail tables SDI detail table records on the target system will be flushed before they are imported.
Child SDIs Deletes any child SDC records that are associated with the SDI being imported.

In order to use this option, the import must be done in the LabVantage application. The import cannot be done using a CTT Ant Task, as this option uses the DeleteSDI Action (which allows all SDC Rules associated with the delete process to be honored).

Child SDC records are identified by finding all SDCs with a foreign key link with a delete rule of "delete" back to the SDC being imported, i.e.,

SELECT sdcid FROM sdclink WHERE linksdcid = '[currentSDC]' AND linktype='F' AND deleteflag = 'D'
Roles

Categories

 Roles and Categories records on the target system will be flushed before they are imported.
Other Options Description
Force update When importing, if an item exists on the target, this overwrites the existing entry; otherwise, it ignores the update.
NOTE: Tests have revealed that exporting a Specification of version "Current" with the "Force update" option set has the following effect:

When you import the Specification and the existing overwritten Specification is also "Current", the existing overwritten Specification will be set to "Active".
Force null update When importing, if an item exists on the target, this overwrites the existing entry only if it is NULL; otherwise, it ignores the update.
Exclude audit columns All columns are transferred unless this option is set. This excludes these columns from the export: CreateBy, CreateDt, CreateTool, ModBy, ModDt, ModTool, AuditSequence, and TraceLogId.
Sync data model When importing, this also transfers the data model for the SDC, thus synchronizing the target with the source. Note that updating the target tables results in a subsequent increase in import time.
NOTE: To prevent recursive exports, the export mechanism checks if data has already been exported in the current export package. This means that the same SDI will not appear more than once in the same export file.
However, exercise caution when trying to export the same SDI with varying levels of detail (such as first with primary only, then next with detail tables). In this case, the second export will not occur.
3.

Set File Options

These are the same options as SDC exports.
4.

Run Export

This is the same as SDC exports.

Enhanced SDI Export Scripts

 

An ongoing effort is underway to provide more comprehensive export of SDIs, especially when they can be associated with many other SDIs. The Export Scripts for the SDCs listed below currently provide enhanced export capability:

SDC Associated SDIs that are also exported:
Workitem Parameter Lists (WorkItemItem), Specifications (WorkItemItem), Workflows (SDIWorkflowRule), Forms (SDIFormRule), referenced Workitem Groups (WorkItemItem), and Child Test Methods.
ProtocolSDC Product and Plan.

 

Working with Transfer Packages

Top ../images/arwup.gif (846 bytes)

Transfer Package Overview

 

A "Transfer Package" defines an export for a set of data, and comprises a set of Export Steps that define the data to be exported. This data may be SDC/SDI data and/or specific tables. The data that is exported is defined in the "Transfer Steps" in the form of queries, categories, keyids and keyfiles. The Transfer Package also defines the location of the export file(s).

You can use "Transfer Package Properties" to generalize your Transfer Package. Embed them in your Transfer Package by enclosing them in square brackets, e.g., [export.dir]. They will be evaluated when the transfer package is executed.

You can use these properties like variables and modify them when a Transfer Package is run. These properties cannot include or reference other properties.

A Transfer Package contains one or more "Transfer Steps" that define the export of an SDI and/or table. SDI and table exports assume a default filename unless explicitly defined. Transfer Steps define export and import order... this is significant when RI considerations are involved.

Transfer Package Procedures

 
1.

Create Transfer Package

Create a Transfer Package using System Admin → System Tools → Transfer Package → Add.
2.

Specify Transfer Steps

    After saving the Transfer Package, the detail lets you add the "Transfer Steps":

Add Property

Specify a Property Id and Value.

Add SDI

This defines SDI exports.

Specify the SDC Id, Filename, and one of the following "Export criteria":

Export CriteriaDescription
By KeyidList of SDI Key Ids.
By CategoryCategory associated with each SDI.
By QueryExplicit query with from, where and order by clauses.
By RSetThis is applicable only to export scripts and is not used in this interface.
Key FileText file containing a list of SDI Key Ids.
Export OptionsDescription
Export Script

Adhoc

The Export Options are the same as the SDI Export Options.
Import OptionsDescription
Standard Keys

Alternate Keys

 These options determine which key columns are used during the import for determining whether inserts or updates are performed.
•"Standard Keys" performs inserts/updates on the standard set of key columns as provided OOB.
• "Alternate Keys" performs inserts/updates on an alternate set of key columns, which you select using the dropdown. This option is intended to be used on SDCs that have automatically-generated keys and an alternate set of columns that uniquely identify any given record.

Add Table

This defines table exports. Specify the Table Id and SQL statement:

Add Column

You can add a column only to a table or an SDI. The options are the same as the SDI Export Options.

Edit and Edit Script

"Edit" lets you edits the dialogs shown above. "Edit Script" lets you edit the XML.

Order Buttons

The up-arrow and down-arrow let you order the Transfer Steps. Remember that since Transfer Steps define export and import order, be aware of possible RI considerations.
3.

Run the Transfer Package

The "Run Transfer" button runs the export defined by the Transfer Package. The resulting wizard lets you review and update property values.

The file options are the same options as SDC exports.

 

CTT ANT Tasks

Top ../images/arwup.gif (846 bytes)

This option provides the most power for defining exports, and is ideal for projects where a structured, repeatable process is required.

CTT ANT Tasks extend the standard ANT library of tasks. These scripts can be run from within LabVantage. Export wizards generate ANT scripts that can be combined into larger scripts. An added benefit is that these can be good learning aids.

Develop one ANT script to run from the source system, and another for the target system.

LabVantage provides a wizard-driven utility to run ANT, accessible through System Admin → System Tools → Run Ant.

Reference

 

For a description of CTT ANT Tasks, see the CTT ANT Task Reference.

 

Exporting Items from the Web Page Designer

Top ../images/arwup.gif (846 bytes)

Overview of Node Hierarchy Export

 

As an example, exporting a Page produces the following results:

When exporting items from the Web Page Designer, the export files retain node hierarchies. For example, exporting a Page produces the following results:
Exported Item Exported Files
 

Collapsed Structure of SampleMaintExport.xml
All Nodes in Page Hierarchy Exported

<exportpackage>

<sdi sdcid="WebPage">

<table tableid="webpage">

<table tableid="webpageproperty">

<table tableid="webpagepropertytree">

</sdi>

<propertytree propertytreeid="Generic" exists="merge" notexists="add">

<propertytree propertytreeid="MaintenanceForm" exists="merge" notexists="add">

<propertytree propertytreeid="advancedtoolbar" exists="merge" notexists="add">

<propertytree propertytreeid="maint" exists="merge" notexists="add">

<propertytree propertytreeid="templateselector" exists="merge" notexists="add">

</exportpackage>

No Nodes Exported

<exportpackage>

<sdi sdcid="WebPage">

<table tableid="webpage">

<table tableid="webpageproperty">

<table tableid="webpagepropertytree">

</sdi>

</exportpackage>

 Expanded Structure of SampleMaintExport.xml with All Nodes in Page Hierarchy Exported

The numbers at the left segregate sections of the code.

 <exportpackage>
1.

COMMENT: SDC definition

<sdi sdcid="WebPage">

2.

COMMENT: WebPage table definition

<table tableid="webpage">

<tabledef tableid="webpage">

COMMENT: One column definition exists for each column in the table. Column "webpageid" shown for example.

<coldef columnid="webpageid" datatype="C" pkflag="Y" nnflag="Y" columnlength="20" columntype="S" />

</tabledef>

<row forceupdate="Y">

COMMENT: One column value exists for each column in the table. Column "webpageid" with value "Sample Maint" shown for example.

<col name="webpageid" forceupdate="Y">SampleMaint</col>

</row>

</table>

3.

COMMENT: WebPageProperty table definition

<table tableid="webpageproperty">

<tabledef tableid="webpageproperty">

<coldef columnid="webpageid" datatype="C" pkflag="Y" nnflag="Y" columnlength="20" columntype="S" />
<coldef columnid="propertyid" datatype="C" pkflag="Y" nnflag="Y" columnlength="80" columntype="S" />
<coldef columnid="propertyvalue" datatype="C" pkflag="N" nnflag="N" columnlength="4000" columntype="S" />

</tabledef>

</table>

4.

COMMENT: WebPagePropertyTree table definition

<table tableid="webpagepropertytree">

<tabledef tableid="webpagepropertytree">

<coldef columnid="webpageid" datatype="C" pkflag="Y" nnflag="Y" columnlength="20" columntype="S" />
<coldef columnid="propertytreeid" datatype="C" pkflag="Y" nnflag="Y" columnlength="20" columntype="S" />
<coldef columnid="elementid" datatype="C" pkflag="Y" nnflag="Y" columnlength="80" columntype="S" />
<coldef columnid="valuetree" datatype="T" pkflag="N" nnflag="N" columnlength="0" columntype="S" />
<coldef columnid="extendnodeid" datatype="C" pkflag="N" nnflag="N" columnlength="80" columntype="S" />
<coldef columnid="usersequence" datatype="N" pkflag="N" nnflag="N" columnlength="0" columntype="S" />

</tabledef>

<row>

COMMENT: One row exists for each propertytreeid (Generic, MaintenanceForm, advancedtoolbar, maint, and templateselector). "Maintenance Form " shown as an example.

<col name="webpageid">SampleMaint</col>
<col name="propertytreeid">MaintenanceForm</col>
<col name="elementid">pagedata</col>
<col name="valuetree">[webpagepropertytree/SampleMaint_MaintenanceForm_pagedata_valuetree.xml]</col>
<col name="extendnodeid">EditPage</col>
<col name="usersequence">2</col>

</row>

</table>

5.

COMMENT: If you export all nodes in the Page hierarchy, there will be one definition for each propertytree. "MaintenanceForm" shown as an example.

<propertytree propertytreeid="MaintenanceForm" exists="merge" notexists="add">

<nodelist>

COMMENT: One definition for each node. Edit Page shown as an example.

<node nodeid="EditPage" collapseancestor="false" includeancestor="true" includedescendsnts="false" extendsnodeid="EnterpriseLIMS" locked="false" exists="merge" notexists="add">

<propertylist exists="replace" notexists="add">

COMMENT: One definition for each property in propertylist. "Includes" shown as an example.

<property id="includes" type="collection">

<collection />

</property>

</propertylist>

</node>

</nodelist>

</propertytree>

 </exportpackage>

As another example, a full export on an Element (all nodes) outputs a defnitiontree file (containing the definition of each Property List), and a valuetree file (containing the definitions for each node, similar to section 5 above). The file containing all nodes (maintexportfull.xml in the example below) contains the definition and value for each row in the PropertyTree table.

Exported Item Exported Files
 

As you would expect, exporting only the "CustomMaintElement" node would result in a single XML file containing the values for that node, again similar to section 5 above

In addition to these examples, each of the many export options (described below) generates files that supply the level of detail required to import the file. 

Exporting Pages

 

Click the Export button on the Page List.

The Export Wizard guides you through the process.

Wizard Flow:

1. Review Selections.
2. Set export options.
3. Set file options.
4. Run export.
1.

Review Selections

Review

Review your changes before proceeding.

2.

Set Export Options

When "Export Page Type, Element and Layout nodes heirarchies (Notes)" is checked the following additional options are available.

 
Option If the item (Element, Page Type or Layout) exists on the target system do you want to:

 

Description This determines treatment of Property Lists defining Elements, Page Types, and Layouts associated with the Page:
• Ignore the node without making modifications to it

All nodes in the target item remain unchanged.

• Replace the target node and discard any modifications made there

All nodes in the exported items replace all of the target's nodes. 

OptionExport Roles and Export Categories
DescriptionExporting Roles or Categories exports the link from the Page to the Roles and Categories, not the Roles and Categories themselves. The import will succeed only if the source Roles and Categories exist on the target system. If you are unsure whether the Roles and Categories exist on the target system, do not choose either of these options.
OptionExport PageType, Element and Layout node hierarchies
Description

When checked, exports all nodes as shown in the example SampleMaintExport.xml above. This also offers these override options:

If an Element, Page Type, or Layout node exists on the target system do you want to:

• Ignore the node without making modifications to it

All nodes in the target item remain unchanged.

• Replace the target node and discard any modifications made there

All nodes in the exported items replace all of the target's nodes. 

OptionDo not export the Generic Layout (sitemap)
DescriptionIn general, you will not want to modify the entire sitemap of the target system when importing a page. Leaving this option checked will ensure that any Generic Layout nodes do not get exported.
3.

Set File Options

These are the same options as SDC exports.

4.

Run Export

This is the same as SDC exports.

Exporting Page Types, Elements, Gizmo Types, Step Definitions, and Layouts (Collectively known as Property Trees)

 

Click the Export button on the relevant List page.

The Export Wizard guides you through the process.

1.

Review Selections

Review

Review your changes before proceeding.

2.

Choose Export Type:

 
a.

Full

This will export the PropertyTree including all nodes and the definition. If the Property Tree already exists on the target system, you have the following options:

Option (Custom) nodes and nodes you have created will get Replaced on the target.
All other nodes will get added only if they are missing.
Description All customizations on the source system will be replicated on the target system but the OOB Product properties on the target system will be left intact. This is the preferred option, particularly when transferring between potentially different versions of the product so as not to destroy the integrity of the target system.
OptionReplace all target nodes
DescriptionThis will replace the entire node hierarchy on the target system, including all OOB Product properties.

Review

Review your changes before proceeding.

Set File Options

These are the same options as SDC exports.

Run Export

This is the same as SDC exports.

 
b.

Definition

This will export only the property definition of the Property Tree. This is useful when a new property has been added to the definition that needs to be transferred to a target system, but where pproperty values themselves need not be transferred.

Review

Review your changes before proceeding.

Set File Options

These are the same options as SDC exports.

Run Export

This is the same as SDC exports.

 
c.

Nodes:

By default, only (Custom) nodes and nodes that you have created yourself will be replaced on the target system. All Product nodes on the target system will be left intact.

The alternative strategy is to apply either of the following two options to ALL nodes that you select:

Option Ignore the node without making modifications to it
Description All nodes in the target item remain unchanged.
OptionReplace the target node and discard any modifications made there
DescriptionAll nodes in the exported items replace all of the target's nodes.
  

Choose the nodes to export:

  

Set File Options

These are the same options as SDC exports.

  

Run Export

This is the same as SDC exports.

 
d.

For Property Exports:

Option If a property exists on the target system do you want to:
Description This determines what happens when the exported Property and target Property have the same identifier:
• Ignore the target property

Leave the target Property unchanged.

• Replace the target property

Replace the target Property with the exported Property. 

  

Choose the Properties to export:

  

Set File Options

These are the same options as SDC exports.

  

Run Export

This is the same as SDC exports.

Exporting Gizmos

 

Click the Export button on the Gizmo List page.

The Export Wizard guides you through the process.

1.

Review Selections

Review

Review your changes before proceeding.

2.

Set Export Options

When "Export Gizmo Node Dependencies" is checked the following additional options are available.

 
Option If the Gizmo (GizmoDef) exists on the target system do you want to:

 

Description This determines treatment of the Gizmo definitions:
• Ignore the GizmoDef without making modifications to its definition

All nodes in the target item remain unchanged.

• Replace the GizmoDef with the new definition

All nodes in the exported items replace all of the target's nodes. 

OptionExport Roles and Export Categories
DescriptionExporting Roles or Categories exports the link from the Gizmo, not the Roles and Categories themselves. The import will succeed only if the source Roles and Categories exist on the target system. If you are unsure whether the Roles and Categories exist on the target system, do not choose either of these options.
OptionExport Gizmo Node Dependencies
Description When checked, exports all nodes as shown in the example SampleMaintExport.xml above. This also offers these override options:

If an Gizmo node exists on the target system do you want to:

• Ignore the node without making modifications to it.

All nodes in the target item remain unchanged.

• Replace the target node with the new definition

All nodes in the exported items replace all of the target's nodes.

Note that this option replaces all referenced Gizmo nodes on the target system for the selected Gizmos. If this is not what you want to do, export nodes individually using the Gizmo Types property tree export wizard as shown in Exporting Page Types, Elements, Gizmo Types, Step Definitions, and Layouts.

3.

Set File Options

These are the same options as SDC exports.

4.

Run Export

This is the same as SDC exports.

Exporting Workflow Definitions

 

Click the Export button on the Workflow Definitions List page.

The Export Wizard guides you through the process.

1.

Review Selections

Review

Review your changes before proceeding.

2.

Set Export Options

When "Export Task Defs" is checked the following additional options are available.

When "Export StepDef Node Dependencies" is checked the following additional options are available.

 
Option If the WorkflowDef exists on the target system do you want to:
Description This determines treatment of the Workflow definitions:
• Ignore the WorkflowDef without making modifications to its definition

All nodes in the target item remain unchanged.

• Replace the WorkflowDef with the new definition

All nodes in the exported items replace all of the target's nodes. 

OptionExport Roles and Export Categories
DescriptionExporting Roles or Categories exports the link from the Gizmo, not the Roles and Categories themselves. The import will succeed only if the source Roles and Categories exist on the target system. If you are unsure whether the Roles and Categories exist on the target system, do not choose either of these options.
Option Export Task Defs
Description Tasks may take some of their properties from Step Definitions. When checked, this takes all node hierarchies from the referenced Step Definitions as well. This also offers these override options:
• Ignore the TaskDef without making modifications to its definition

All nodes in the target item remain unchanged.

• Replace the TaskDef with the new definition

All nodes in the exported items replace all of the target's nodes. 

OptionExport StepDef Node Dependencies
Description Tasks may take some of their properties from Step Definitions. When checked, this takes all node hierarchies from the referenced Step Definitions as well. This also offers these override options:

If an StepDef node exists on the target system do you want to:

• Ignore the node without making modifications to it.

All nodes in the target item remain unchanged.

• Replace the target node with the new definition

All nodes in the exported items replace all of the target's nodes.

Note that this option replaces all referenced StepDef nodes on the target system for the selected Workflows. If this is not what you want to do, export nodes individually using the Step Definition property tree export wizard as shown in Exporting Page Types, Elements, Gizmo Types, Step Definitions, and Layouts.

3.

Set File Options

These are the same options as SDC exports.

4.

Run Export

This is the same as SDC exports.

 

Importing Items

Top../images/arwup.gif (846 bytes)

Import Wizard Overview

 

Regardless of what you exported, all imports are done through System Admin → System Tools → Import.

Wizard Flow:

1. Choose file.
2. Parse file.
3. Run import.

Import Wizard Detail

 
1.

Choose File

OptionDescription
Specify format of input file Format of the import file:
FormatDescription
CMTZIP file generated by CMT Transfer.
CTTXML or ZIP file (zip contents are automatically extracted).
Data FileImports a file for use as a Data File Definition.
Choose the file to importClient-side file to import (zip contents are automatically extracted). The maximum file size is set by the "Maximum Upload File Size" in System Configuration → Miscellaneous Options → File Management.
Commit scope
(CTT only)		 Determines when data found in the import file are committed. In general, the broader the commit scope, the larger the transaction. However, a broader commit scope reduces the need for correct SDI ordering (for RI).
ScopeCommits data...Comments
RowAfter each row. This is slow, but it is useful for finding RI errors.
TableAfter each table.This assumes the correct order of tables for RI.
SDIAfter each SDI block.This assumes the correct order of SDIs for RI.
FileAfter each file.This assumes the correct order of files for RI, but this can lead to large transactions.
ImportAt the end of all imports.There is no assumption of order, but this can lead to very large transactions.
Verbose log
(CTT only)		Maximizes log contents.
Ignore missing Objects
(CTT only)		Allow imports with unrecognized objects (such as additional columns not in the target database) to be imported without error. This is applicable only when the Sync data model export option is not selected.
Ignore sequence checks
(CTT only)		Ignores the implicit sequence checks and corrections/updates that are made in the target database to avoid clashes between sequence values found in the import data and existing sequence values in the target database.
NOTE: Use this option at your own risk. Sequence values being imported may clash with existing sequences in the target database, either immediately or in the future.
Regenerate Keys
(CTT only)		 When importing SDIs that have Automatically-Generated Keys, this option updates the imported SDI key to match the current sequence in the target database.

For example, if you import Sample S-090415-00001, this option has the following effect:

Option not set:If S-090415-00001 is not found in the target database, it will be inserted. If found, the imported key will be updated according to the forceupdate and forcenullupdate settings specified for the export (see Set Export Options).
Option set:If the latest Sample in the target database is S-090415-00011, the imported key is updated to S-090415-00012.
NOTE: The SDIData, SDIDataItem, SDIWorkItem, and SDINote tables (which are imported with surrogate key sequences) are automatically protected against a clash in the target's sequence numbers. All incoming records with a sequence are given the next sequence from the import database.
Select Message Type
(Data File only)		Message Type for the imported file.
Process the file asynchronously
(Data File only) 		By default, "Process the file asynchronously" is unchecked and "Validate only" is disabled. Clicking "Next" after uploading the file advances to the next step in the wizard.

Checking "Process the file asynchronously" adds the import to the ToDo List for asynchronous processing immediately after clicking "Next". All subsequent wizard steps are skipped.

When "Process the file asynchronously" is checked, the "Validate Only" option is enabled (below).

Validate only
(Data File only) 		When "Process the file asynchronously" is checked, checking "Validate only" only validates the file and does not actually run the processing rules for the file.
2.

Parse File

For CTT Imports (left):

Enter notes for the log if desired. An import analysis is shown.

For Data File Imports (right):

The preview page is displayed if "Process the file asynchronously" is not checked. The wizard starts a validation check on the file synchronously. The validation check is set to run for 30 seconds. If the file to too large, the validation check returns a partial validation log.

A list of validation errors/warnings is displayed in the next page. In case only warnings appear, the "Next" button is enabled and you can proceed with processing by clicking "Next". You can optionally process asynchronously at this point.

If validation errors exist, the wizard prohibits processing. Only a "Finish" button is displayed.

3.

Run Import

CTT Import is above left. Data File Import is above right. For Data Files, the Process Log is displayed when processing synchronously.

 During an import, the CTT does not remove these SDI details from the target database if they did not exist on the exported database:
•D-type links (such as ParamListItem).
•Reverse foreign-key links where the child is an SDC.