Using the Xtraction Import Export Utility - CA Technologies · Using the Xtraction Import Export...

©Copyright Xtraction Solutions 2014

1

Using the Xtraction Import Export Utility


2

Contents Introduction ............................................................................................................................................................................. 3

Before You Start ................................................................................................................................................................. 3

Run the Utility ..................................................................................................................................................................... 3

Exporting Folders, Filters, Dashboards, Documents and Reports ...................................................................................... 5

Importing Folders, Filters, Dashboards, Documents and Reports ...................................................................................... 9

Post Import Tasks ............................................................................................................................................................. 12

Verify Your Import ........................................................................................................................................................... 13

Options .............................................................................................................................................................................. 14

View the Log File ............................................................................................................................................................. 16

Potential Errors ................................................................................................................................................................. 17


3

Introduction

Before You Start

*** IMPORTANT NOTICE ***

Please backup your destination Xtraction database before using this utility.

Run the Utility

Double click Xport.exe in the directory where it is installed. By default C:\Program Files(x86)\Xtraction

Software\Xtraction\Tools.

Exporting: Perform this on the Originating Server

Importing: Perform this on the Destination Server

Fill in your Xtraction server details.

These will be the same as the Settings utility.

Press the Test button and verify the connection was successful.


4

The utility will be loaded and you will be presented with this initial screen.

Expand the directory structure to see the items you are interested in.

Note: If you make a change to the folders (copy a dashboard, create a new folder) you need to shut down the Import

Export utility and restart it.

The instructions to use the utility are listed

above.

The folder structure of your instance

of Xtraction is above.


5

Exporting Folders, Filters, Dashboards, Documents and Reports

The export process will take checked items and zip them up into a nominated location and zip file.

The Export process does not remove the items from the Xtraction Database. It simply takes a copy of them.

1) Use the check boxes against Folders, Filters, Dashboards, Documents and Reports to select items for Export.

2) Use the context menu to Select All or Deselect All in the current tree.

Right click on any item to see the context menu.


6

3) Use the Export Button or Right-Click and select the Export option in the context menu.

4) Verify the options selected and press OK.


7

5) Select the path for the Xtraction Data directory.

Based on the selections from the Options pop up window, you are required to provide the path to the Xtraction

Data folder. This is required so that the Xport can pick up Images and/or Templates. These are stored in the

Xtraction Data directory in sub-folders called Images and Templates.


8

6) Enter a name for the Zip File Press Save to proceed or Cancel to abort.

Pressing the Save button on this screen will start the Export process.

7) The export process is completed.


9

Importing Folders, Filters, Dashboards, Documents and Reports

This process will take a Zip file as input. The zip file must be in the format created in the Export process.

1) Select a folder by clicking the folder name. This is where you will put the Folders, Filters, Dashboards,

Documents and Reports.

2) Click the Import button.

3) Verify the options selected and press OK.


10

4) Select the path for the Xtraction Data directory.

Based on the selections from the Options pop up window, you are required to provide the path to the Xtraction

Data folder. This is required so that the Xport can pick up Images and/or Templates. These are stored in the

Xtraction Data directory in sub-folders called Images and Templates.

During an import, this path will be used to store the Images and Template. This is why we have a check box to

ask if you want duplicate items replaced.

5) An ‘Open ZIP file for Import’ window will be displayed.

6) Locate the zip file to import.

7) Press the Open button to continue or Cancel to abort the process.


11

9) The tree will be updated to show the new imported entries. All new entries will be checked for your review.

Press the Save Import button to complete the Import.

10) In order to complete the process the new entries must be saved to the Xtraction database. Click the Save Import

button above to complete the process. A window will be displayed upon completion of this step.


12

Post Import Tasks

1) Once your Import has completed, it is a good idea to restart your Xtraction application.

2) Clear the web browser cache.

3) Restart the Xtraction Task Manager Service.

4) In some cases restarting the Application Pool in IIS may be required.

Administrative Tools…Internet Information Services (IIS) Manager.

Expand the server folder.

Highlight ‘Application Pools’.

Right click on the Xtraction Application Pool and select Stop.

Right click on the Xtraction Application Pool and select Start.


13

Verify Your Import

1) Open the Xtraction web interface.

2) Navigate to the new location of your item.

3) Open your item in the Xtraction web interface and verify it works properly.


14

Options

The Options window is displayed after initiating an Import or Export. It can also be viewed through the View Menu.

Options contain three important decisions:

1) Default Owner. This is only applicable to Imports and will not affect Export. All objects (Dashboards,

Documents, Filters, etc.) are given an Owner when created in Xtraction. The Owner is a User Account. When you

perform an Export, each object takes a reference to its Owner. During the Import, if the objects Owner does not

exist in the Xtraction database, then the object must be given a new Owner. This is why we ask for a Default

Owner. The Default Owner is given to each imported object where the objects Owner cannot be found in the

Xtraction database.

2) Tree View. This affects what is shown in the Tree view as well as what can be exported. All items in the tree have

an owner. This is generally the person who created the item.

a. Both check boxes are not checked by Default. You can change this in the options dialog window or

permanently change it by setting the following configuration items:

i. <setting name="ExcludeInactive" serializeAs="String">

<value>False</value>

</setting>

<setting name="HideInactive" serializeAs="String">

<value>False</value>

</setting>

b. All items that have an Owner that is inactive will show their item name as grayed text.

c. Exclude Inactive Owner from Export; Check this box and all items that belong to an inactive Owner will

not be available for selection. They can still be seen in the tree, grayed text and without a checkbox.

Changing this setting will cause the Tree view to be rebuilt.


15

d. Hide Inactive Owner Items; Check this box and all items that belong to an inactive Owner will not be

shown in the Tree view. Changing this setting will cause the Tree view to be rebuilt.

3) Templates. Some objects such as Documents may have associated templates. Templates are located in the

Xtraction Data directory sub-folder Templates. You can include or exclude Templates in the Export. When you

export a Document that has a Template, the Template is exported too. During the Import you can choose to

include Templates. When the Document is imported the Template will be created in the Xtraction Data directory,

sub-folder Templates. You can choose to replace a Template if it already exists in the Templates folder or you can

leave it and not import the incoming Template.

4) Images. Some objects may contain Image Components. Images that are not located on the Xtraction Server such

as those that are accessed through a URL cannot be exported. Server based Images are located in the Xtraction

Data directory sub-folder Images. You can include or exclude Images in the Export. When you export a

Document that has an Image Component, the Image is exported too. During the Import you can choose to include

Images. When the Document is imported the Image will be created in the Xtraction Data directory, sub-folder

Images. You can choose to replace an Image if it already exists in the Images folder or you can leave it and not

import the incoming Image.


16

View the Log File

The logs files are located in the directory that the utility was installed.

That is usually located here:

C:\Program Files (x86)\Xtraction Software\Xtraction\Tools

There may be more than one log file in that directory.

The naming convention is as follows:

XportLog_yyyymmdd.txt

Where yyyymmdd = year, month, day


17

Potential Errors

You may receive this error when you are importing items.

If you click in one of the item check boxes instead of just highlighting it, you will get this error:


18

Clicking on OK above will bring up another message:

Click OK above.

You need to press the Cancel Import button at this time to continue.

Just go back and highlight the item instead of clicking in the box.

Date post:	02-May-2018
Category:	Documents
Upload:	hoangduong
View:	220 times
Download:	0 times