Adeptia Migration Utility User Guide

8/14/2019 Adeptia Migration Utility User Guide

1/60

MMiiggrraattiioonn UUttii ll ii ttyy

UUsseerr GGuuiiddee

VVeerrss iioonn 33..00

Release Date December 12, 2007

Adeptia Inc.

443 North Clark Ave,

Suite 350Chicago, IL 60610, USAPhone: (312) 229-1727


2/60

Copyright

Copyright 2000-2007 Adeptia, Inc. All rights reserved.

Trademarks

The Adeptia logo and Manage, Automate and Optimize Business Processes are trademarks ofAdeptia, Inc.

Statement of Conditions

Adeptia, Inc. provides this publication "as is" without warranty of any kind, either express orimplied. In no event shall Adeptia be liable for any loss of profits, loss of business, loss of use ordata, interruption of business, or for indirect, special, punitive, incidental, or consequentialdamages of any kind.

No part of this work covered by copyright herein may be reproduced in any form or by anymeansgraphic, electronic or mechanicalincluding photocopying, recording, taping, or storagein an information retrieval system, without prior written permission of the copyright owner.

This publication is subject to replacement by a later edition. To determine if a later edition exists,contact www.adeptia.com .

Contact Information

In case of any queries, please contact us at:

Contact For Email ID

Sales [email protected]

Support [email protected]

For more information, you can visit us at www.adeptia.com
http://www.adeptia.com/mailto:[email protected]:[email protected]://www.adeptia.com/http://www.adeptia.com/mailto:[email protected]:[email protected]://www.adeptia.com/


3/60

Adeptia Migration Utility User Guide 2

Table of Contents

1 INTRODUCTION ................................................................................................................................ 3

NEED FOR MIGRATION .............................................................................................................................. 3

ADEPTIA MIGRATION UTILITY................................................................................................................... 3

BENEFITS OF USING ADEPTIA MIGRATION UTILITY ................................................................................ 4

2 GETTING STARTED .......................................................................................................................... 5

PRE-REQUISITES ........................................................................................................................................ 5

STARTING ADEPTIA MIGRATION UTILITY ................................................................................................ 5

3 ENVIRONMENT PROMOTION .................................................................................................... 7

EXPORT ....................................................................................................................................................... 8PROMOTE .................................................................................................................................................. 13

Generating XML for Retained Objects in the Target System ......................................... 21

Deleting an Object.......................................................................................................................... 29

DEPLOY ..................................................................................................................................................... 31

4 MIGRATION ....................................................................................................................................... 34

ONLINE MIGRATION ................................................................................................................................ 35

OFF LINE MIGRATION.............................................................................................................................. 38

Export/Backup ................................................................................................................................. 39

Import/Restore ................................................................................................................................ 41

5 PATCH UPDATE ............................................................................................................................... 48

APPLY PATCH............................................................................................................................................ 49

REMOVE PATCH ........................................................................................................................................ 52

6 APPENDIX A ...................................................................................................................................... 55

SAMPLE CONFIGURATION VALUES ......................................................................................................... 55

SQL Server Database .................................................................................................................... 55

HSQLDB Database.......................................................................................................................... 55

Default Values for Additional Columns in an Upgraded Version ................................... 55

7 TABLE OF FIGURES ....................................................................................................................... 57

8 TABLE OF TABLES .......................................................................................................................... 59


4/60


1INTRODUCTION

NEED FORM IGRATIONAt times while working with an Adeptia product, you may come across a situation, where youneed to change a process flow or an object. For this, you need to transfer the objects acrossmultiple environments, such as change the object in the Development environment, test it inthe QA environment and finally apply the changes in the Production environment. Alternately,when an upgrade of an Adeptia product is released, you need to migrate all the data from theearlier version to the upgraded version. This can be quite a cumbersome process, as once youtransfer the objects, you cannot rollback the action.

ADEPTIAM IGRATION UTILITY

Adeptia offers a Migration utility which facilitates you to seamlessly migrate objects in allsituations. It is a comprehensive tool which enables you to:

Promote objects across environments (for example, Development environment toQA environment, or QA environment to Production environment)

Migrate objects from an older version to a new upgrade version Change the backend database Take backup of the Adeptia Server

This tool allows you to transfer objects in three ways:

Environment P romotion: It allows you to promote objects across environments.This is migration at the user level, where you can select a group and promote allits objects such as Events, Activities, Process Flows, Users and Groups, to anotherenvironment. In environment promotion logs data and transaction states are nottransferred to new environment.

Migration: It allows you to migrate objects across versions. This is migration atan advanced level, where you can transfer all objects of all groups in the currentlyinstalled version to a new upgraded version. Additionally, it also facilitates you totake a backup of all objects and configuration files in the current installation andrestore them whenever required.

Patch Update: It allows you to update the patch over existing Adeptia Server. Itreplaces the files which are in patch and change the backend database as per thequery written in patch.

After migration all Events are de-activated in new environment.


5/60


BENEFITS OF USINGADEPTIAM IGRATION UTILITY

The benefits of using the Adeptia Migration utility are outlined as:

Provides an automated means of object transfer across environments and versions Provides options of transferring all objects or selected objects based on a group,

objects within a group or even fields within an object

Maintains an Audit log of all actions performed in the object transfer Rollbacks the entire operation if an error occurs. If the migration is successful, it

cannot be rollbacked.

Allows you to take a backup of all objects so that they can be restored wheneverrequired.


6/60


2GETTING STARTED

PRE-REQUISITESThe pre-requisites of using the Migration utility are outlined as:

Java Runtime Environment(JRE) 1.5 The database of the Adeptia Server should be running. In case of HSQLDB, you need to

ensure that the kernel is running, as it activates the backend database of the server. Inother databases, the kernel is not required to be running, however if it is running, it willnot affect the migration utility.

Ensure that no objects are created or modified during the Migration process

STARTINGADEPTIAM IGRATION UTILITY

You can run the Migration utility on:

Server Desktop

The Migration utility is either bundled with the Adeptia Server or it can be downloaded orpurchased separately. To run it on a desktop, you need to copy the utility explicitly on thedesktop.

It is recommended that you run the utility on the Adeptia Server, assome parts of the utility can be run on the Server only.

When you run the utility, the system creates a log file in the same location as the utility file.Each time you run the utility; this log is appended.

Steps to s ta r t t he Adep t i a M i g ra t i on U t i l i t y

1. Double-click the Migration utility file (MigrationUtilityv3.0.exe). The AdeptiaMigration wizard is displayed (see Figure 2.1).


7/60


8/60


3ENVIRONMENT PROMOTION

You can use Environment Promotion to transfer objects of selected groups from oneenvironment to another. This implies that you need to select a group and then transfer theobjects of that selected group.

For example, a project is in Production stage, and a few enhancements are requested by theclient. To incorporate these enhancements, the project will have to be transferred acrossvarious environments. The objects of the project will be changed in the Developmentenvironment. Once the changes are done, they will be internally tested, before the project issent to the QA environment, where it is thoroughly tested again. Once the QA team is done, itwill send the project to the Production environment.

Instead of transferring the entire project, which could take time, you can just transfer theobjects that have been changed. The Migration utility allows you to create a zip file of all thechanged objects and promote them across the three environments.

Steps to p rom o te ob j ec ts usi ng Env i ronm en t P romo t i on

Environment Promotion is a three-step process.

1. Select the Environment Promotion radio button on the Select Action screenand click Next. This displays the Environment Promotion actions screen (seeFigure 3.1).

Figure 3.1: Environment Promotion Actions screen

This screen displays the three steps used in the Environment Promotion. These are outlined inthe table below.


9/60


Table 3.1: Environment Promotion Actions

Action Description

Export Allows you to export objects from the sourcefile to a zip file.

Promote Allows you to select objects from exported zipfile, compare it with the target system andgenerate another zip file for the changes youwant to update to the target system.

Deploy Allows you to apply the promoted changes tothe target system.

EXPORTThis step is performed on the source system where the Adeptia Server is installed.

Steps to expo r t ob j ec ts

1. Select the Export radio button on the Environment Promotion Actions screenand click Next. The Select Source System screen is displayed. Click Browseto select the directory where the Adeptia Server is installed (see Figure 3.2)

Figure 3.2: Select Source System Install Directory

2. Click Next. This displays the Select Group screen (see Figure 3.3).


10/60


Figure 3.3: Select Group

3. This screen displays a list of all the groups in the Adeptia Server. Check thecheckbox against the group, whose objects you want to export.

You can select one or more groups.

4. Click Next. The Select Objects screen is displayed (see Figure 3.4).

Figure 3.4: Select the Action

5. Select the objects that you want to export. You can either export all objects ofthe selected groups or only all process flows and their associated objects.


11/60


Click the appropriate radio button. If you have selected multiple groups in theSelect Group screen and you select the Process Flow Objects option in thisscreen, then all objects associated with all Process Flows are exported.

However, if you have selected only one group in the Select Group screen, thenselecting the Process Flow Objects option, will display the Select Process Flowscreen (see Figure 3.5).

Figure 3.5: Select Process Flows

6. This screen displays a list of all the process flows for the selected group.Check the checkbox against the process flow that you want to export.

If you select All Objects option in Selec t th e Act ion screen, the SelectServices screen is displayed (see Figure 3.6). In Select Services screenyou can select all services or only the required services to export. Toselect all services click Select All button. To select the individualservices check the checkbox against the required services.


12/60


Figure 3.6: Select Service

Some service names have changed across the version and because ofthat some service may be shown multiple times with different names.Following table shows those services and their name.

Table 3.2: Services and their name which have changed

Current Service Name Old Service Names

Data Mapping Mapping Transformation

Custom Plugin Scripted Service

Database Event DBEvent

7. Click Next. The Select Target directory screen is displayed. Click Browse toselect the target location where you want to save the zip file (see Figure 3.7).


13/60


Figure 3.7: Select Target Directory

8. Click Next to start the export process. The progress of this process isdisplayed in the View Logs screen (see Figure 3.8).

Figure 3.8: View Export Logs

This screen displays all logs and confirms whether the export operation is successful ornot. If it is successful, a message stating Export completed successfully is displayed inthe View Export Logs screen and as a popup window, and a zip file of the exported objectsis created. In case of failure, it displays an error message in the View Export Logs screenand as a popup window, and rollbacks the entire operation.


14/60


Clicking Clear Logs clears all logs in the View Export Logs screen, butnot in the back end.

Clicking Save Logs saves all logs in the View Export Logs screen.

9. Click Finish to complete the export process and exit the Migration utility.

PROMOTEThis step is performed on the target system.

Pre-Requ is i te

The exported zip file must be available on the target system on which the AdeptiaServer is installed.

Steps to P rom o te ob j ec ts :

1. Select the Promote radio button on the Environment Promotion Actions screenand click Next. The Select Source Location screen is displayed. Click Browseto select the zip file that was created in the Export process (see Figure 3.9).

Figure 3.9: Select Source Location

2. Click Next. This displays the Select Target Directory screen. Click Browse toselect the directory, where the target system on which the Adeptia Server isinstalled (see Figure 3.10).


15/60


Figure 3.10: Select Target System Install Directory

3. Click Next. This displays the Select Group screen (see Figure 3.11).

Figure 3.11: Select Group

4. This screen displays a list of all the groups in the Adeptia Server. Check thecheckbox against the group whose objects you want to promote.

You can select one or more groups.

5. Click Compare Selected Objects to compare the source and target objects.It displays the process in running state (see Figure 3.12).


16/60


Figure 3.12: Generating Compare Selected Objects Process

6. Once the process is complete, the Compare Objects screen is displayed (seeFigure 3.13).

Figure 3.13: Compare Objects (Process Flow Objects)

If you had selected the All Objects option in Select the Action screen in the Export process,then the Compare Objects screen will be displayed as below.


17/60


Figure 3.14: Compare Objects (All Objects)

Objects of the selected groups are displayed in this screen. Theunselected groups are ignored and not listed.

7. The Compare Objects screen displays objects in a tree structure, which showsa comparison between the source and target objects at both the activity andfield levels. It displays legends at the activity and field levels, which highlightthe comparison and indicate whether the activity or field will be updated ornot. It also displays the Advanced Properties of the object at the field level.The legends are displayed at the bottom of the screen and are outlined in thetable below.

Table 3.3: Legends on the Compare Objects screen

Legend Description

Source and target objects are different. Once thesource objects are promoted, the target objects will


18/60


be updated.

Source and target objects are the same. Thus,promotion is not required in this case.

New record will be inserted from the source end tothe target end, as the target database has additionalparameters.

No source data exists for the particular target field.

When the source and target objects are different, they need to be updated at thetarget end. This is done by comparing the Activity ID of the objects at the source andtarget end. If they match, then the objects are updated, else not.

You can delete an object from the Compare Objects screen. Refer tothe Deleting an Object screen.

8. You can view the changes between the source and target end by right-clickingeach field/activity, and selecting View Changes option (see Figure 3.15).

Figure 3.15: Select View Changes option


19/60


9. The View Difference screen is displayed (see Figure 3.16).

Figure 3.16: View Difference

10.This screen displays the Source and Target columns, which show the actualvalue of the attribute at the source and target ends. You can change the valuein the Source Data column and click Update. This saves the modified valueand updates it at the target end. The Target column is non-editable. So, tochange a target object, you need to change its source object.

At times, the Source and Target columns are displayed as empty. If theSource column is empty, it indicates that the fields are blank at thesource end. The Target column is empty if there is no object at thetarget end.

11.Click Close to close this screen and return to the Compare Objects screen.Similarly, click Close to close this screen and return to Select Group screen.

12.Click Next. The Select Retain XML Location screen is displayed. Click Browseto select the location where the xml file for the objects to be retained, isstored (see Figure 3.17Error! Reference source not found.).


20/60


Figure 3.17: Select Retain XML Location

If you are starting the Migration tool for the first time, or you want toedit the existing xml file, refer to the Generating XML for RetainedObjects in the Target System section.

13.Click Next. This displays a screen, where you need to enter your name in thespecified field. This is just to keep track of who approved the promoted objects(see Figure 3.18).

Figure 3.18: Enter username


21/60


14.Click Next. The Select Target location screen is displayed. Click Browse toselect the target location where you want to save the zip file created in thePromotion process (see Figure 3.19).

Figure 3.19: Select Target Location for Promoted Objects

15.Click Next to start the Promote process. The progress of this process isdisplayed in the View Promoted Logs screen (see Figure 3.20).

Figure 3.20: View Promoted Logs

This screen displays all logs and confirms whether the promote operation is successful ornot. If it is successful, a message stating, Promoting objects completed successfully isdisplayed in the View Promoted Logs screen and as a popup window, and a zip file of the


22/60


promoted objects is created. In case of failure, it displays an error message in the ViewPromoted Logs and as a popup window, and rollbacks the entire operation.

16.Click View PDF Report to view a list of all records that will be updated andinserted in the target system in the Deployment state. A record is inserted atthe target end, when data at the source and target end differ.

The Report feature is available only in the Promote step.

17.Save the PDF report and then open it to view its details (see Figure 3.21).

Figure 3.21: View PDF Report

18.Click Close to close this screen and return to the View Promoted Logs screen.19.Click Finish to complete the promote process and exit the Migration utility.

GENERATING XML FORRETAINED OBJECTS IN THE TARGET SYSTEM

While promoting objects, you may want to retain a few objects at the target end. Forobjects that are specific to the environment, or configuration objects such as User ID, youdo not want to promote and overwrite them at the target end. For example, whenpromoting data from the Development environment to the Production environment, theDatabase Info objects may vary. The objects are the same, but their connection


23/60


24/60


3. This list displays all the objects of the Adeptia Server in a tree-like structure. Ithas two levels:

Service Level Field Level

You can retain objects at both the Service and Field Levels but at atime you can retain object either at service label or field label.

Retaining Objects at Service Level

You can retain an entire service from being transferred. For example, you may want toretain all objects of the Mail Target service. So, instead of individually retaining eachobject, you can retain the entire Mail Target service. This implies that when the data istransferred, the Mail Target service at the source end will be ignored, and not transferred.

Steps to re ta in ob j ec ts a t Serv ice leve l

1. Check the checkbox against the service that you want to retain.You can expand the service by clicking [+] against the service. Allfields associated with the activity are displayed. However, they are de-active and cannot be selected.

2. To retain a specific activity of the service, right-click the service and selectSpecificActivity option (see Figure 3.24).


25/60


Figure 3.24: Select Specific Activity Option

3. This displays the Retain Activity Query Builder screen (see Figure 3.25).


26/60


Figure 3.25: Retain Activity Query Builder

4. Specify the criteria on the basis of which the service will be ignored, byentering the activity name and ID in their respective fields.

You can either enter values in both the Activity Name and Activity IDfields, or in one field only. However, it is mandatory to enter value inone field.

If you do not remember the ID of an activity, you can refer to theProduction environment or go to the Manage section of the AdeptiaServer.

5. Click Insert. This displays the activity name and ID in the Query Informationfield (see Figure 3.26).


27/60


Figure 3.26: Activity Name Displayed in the Query Information Field

You can specify one or more activities in this screen. All the specifiedactivities are listed as comma separated values in the QueryInformation field.

You can remove an activity listed in this field, by selecting the activityand pressing on the keyboard.

6. Click Done to complete the query and return to the previous screen (refer toFigure 3.24).

7. Click Generate Retain XML. This generates the xml file for the retainedservice. This implies that when transferring data, the selected service for thespecified activities will be ignored at the source end and not overwritten at thetarget end.

Retaining Objects at Field Level

At times, you may want to retain values of a specific field only. For example, whiletransferring data, you want to retain the UserID and Password values of the Mail Targetactivity. You can retain these fields using the Migration tool. Thus, when data istransferred, values in the UserID and Password fields will be ignored at the source end and

not overwritten at the target end.

Steps to re t a in ob jec t s a t Fie ld leve l

1. Click [+] to expand the activity whose field you want to retain. A list of allfields associated with the service is displayed (see Figure 3.27).


28/60


29/60


Figure 3.28: Select Field

3. To retain the field for a specific service, right-click the field and select SelectActivity option. This displays the Retain Activity Query Builder screen.

4. Specify the criteria on the basis of which the activity will be ignored, byentering the activity name and ID in their respective fields.

You can either enter values in both the Activity Name and Activity IDfields, or in one field only. However, it is mandatory to enter value inone field.

If you do not remember the ID of an activity, you can refer to theProduction environment or go to the Manage section of the AdeptiaServer.

5. Click Insert. This displays the activity name and ID in the Query Informationfield (refer to Figure 3.26).

You can specify one or more activities in this screen. All the specifiedactivities are listed as comma separated values in the QueryInformation field.

You can remove an activity listed in this field, by selecting the activityand pressing on the keyboard.


30/60


6. Click Done to complete the query and return to the previous screen (refer toFigure 3.24).

7. Click Generate Retain XML. This generates the xml file for the retainedactivity. This implies that when transferring data, the field values of thespecified activity will be ignored at the source end and not overwritten at thetarget end.

The objects that are changed at the Field level are displayed in the

Compare Objects screen with the legend. And if you want to retainthis value of the target side, the changed value is extracted from thetarget and transferred to the source, thus implying that the values aresame at the source and target end. For example, if the File Path field ofthe File Source service is changed, then the updated value is extractedfrom the target end and transferred to the source end of the File Pathfield. This field is now displayed in the Compare Objects screen with

the legend.

DELETING AN OBJECTWhile comparing the objects, you can delete an object.

Steps to de le te an ob j ec t

1. Right-click the object you want to delete in the Compare Objects screen, andselect the Delete option (see Figure 3.29).


31/60


Figure 3.29: Select Delete Option

The selected object is deleted from the list.

You can delete objects at the Service, Process Flow and Activity levels.However, you can update only at the Field level.

If you delete an object at the Service level, then the entire service along with its process flowsand activities is deleted. If you delete an object at the Process Flow level, then all processflows and its objects are deleted. If you delete an object at the Activity level, then the entireactivity along with its fields is deleted.


32/60


33/60


Figure 3.31: Select Target System Install Directory

3. Click Next. This displays a screen, where you need to enter your name in thespecified field. This is just to keep track of who deployed the objects (seeFigure 3.32).

Figure 3.32: Enter username4. Click Next. This displays the View Deployed Logs screen (see Figure 3.33).


34/60


Figure 3.33: View Deployed Logs

This screen displays all logs and confirms whether the deployment operation is successful ornot. If it is successful, a message stating, Deployment of selected objects completedsuccessfully is displayed in the View Deployed Logs screen and as a popup window, and theselected objects are deployed. Incase of failure, it displays an error message in the ViewDeployed Logs screen and as a popup window, and rollbacks the entire operation.

5. Click Finish to complete the deploy process and exit the Migration utility.


35/60


4M IGRATION

You can use the Migration process to migrate objects from the currently installed version to anew upgraded version. This process also allows you to take a backup of all objects andconfiguration files from the current installation and restore them whenever required.

For example, you are currently using Adeptia Server 4.4 on your system. With the release ofAdeptia Server 4.5, you want to upgrade to this new version. After installing it, you need totransfer all data from Adeptia Server 4.4 to Adeptia Server 4.5. To do this, you can use theMigration process.

You can use the Migration process to insert objects from the sourcedatabase to the target database. However, you cannot update theobjects in the target database.

Steps to m i g ra te ob j ec ts us i ng M i g ra t i on

1. Select the Migration radio button on the Select Action screen and click Next.This displays the Migration actions screen (see Figure 4.1).

Figure 4.1: Migration Actions

This screen displays the migration actions, which are outlined in the table below.

Table 4.1: Migration Actions

Action Description

Online Migration Allows you to migrate objects from the sourcesystem database to the target systemdatabase. The source and target databases


36/60


should be in running mode when using thisaction.

Offline Migration Allows you to create a zip file containing allsource objects and configuration files. This zipfile is henceforth used for Export/Import,Backup/Restore of the source objects and files.

ONLINE M IGRATION

Online Migration can be run on any desktop. It facilitates you to migrate objects from the

source database to the target database. Both these databases need to be connected for thisprocess. For example, if the earlier version of Adeptia Server is on HSQL database, and theupgraded version is on SQL Server, you can use this process to transfer the objects.

Steps to m i g ra te ob j ec ts us i ng on l i ne m i g ra t i on :

2. Select Online migration radio button on the Migration Actions screen and clickNext. The Configuration Settings screen for Source Database is displayed (seeFigure 4.2).

Figure 4.2: Configuration Settings for Source Database

3. Select the source database type from the Database Type drop-down menu.4. Enter the name of the source database server in the Server Name field.5. Enter the port number of the source database in the Port No. field.6. Enter the name of the source database in the Database Name field.


37/60


38/60


Figure 4.4: Select Tables

10.Check the checkbox(s) against the tables that you want to migrate.You can select one or more tables.

All tables that are prefixed with ABPM are quartz tables. These tables and thedt_properties tables and are listed in case of the SQL Server database only. It isrecommended not to migrate these tables, as the migration process is likely to fail in

such a case, as all tables in the source and target databases should be the same.Similarly, please migrate the log tables (AU_Log and AU_TransactionData), only if youneed the log, as these are big size tables and slow down the migration processconsiderably.

You need to be careful while migrating tables, as if an error occurs, itcannot be undone. Additionally, if the migration process fails, you haveto rollback the entire operation.

11.Click Next. This displays the View Logs screen (see Figure 4.5).


39/60


Figure 4.5: View Logs

This screen displays all logs and confirms whether the export operation is successful or not. Ifit is successful, a message stating, Selected tables exported successfully is displayed in theView Logs screen and as a popup window. Incase of failure, it displays an error message in theView Logs screen and as a popup window, and rollbacks the entire operation.

12.Click Finish. This completes the migration process.When you migrate to an upgraded version, the Migration tool takescare of all the new fields at the target end, and inserts default valuesfor these fields. These values are displayed in the View Logs screen.

Refer to Appendix A for more details on the default values. To changethese values, you need to manually update them using the Managesection in the Adeptia Server.

OFF LINE M IGRATIONThe Offline Migration process is used for migrating objects when the source database to targetdatabase, when the databases are not connected at the same time. It is used to migrateobjects as well as take backup.

Steps to m i g ra te ob j ec ts us i ng o f f l i ne m i g ra t i on

1. Select Offline migration radio button on the Migration Actions screen and clickNext. This displays the Offline actions screen (see Figure 4.6).


40/60


Figure 4.6: Offline Actions screen

This screen displays the Off Line migration actions, which are outlined in the table below.

Table 4.2: Offline Actions

Action Description

Export/Backup Creates a zip file containing all sourcedatabase objects and configuration files.

Import/Restore Import all source database objects andconfiguration files from the zip file to the target

system.

EXPORT/ BACKUP St e p s f o r o f f l i n e m i g r a t i o n ( E x p or t / B ac k u p ) :

1. Select Export/Backup radio button on the Offline Actions screen and clickNext. This displays the Select Source Database screen. Click Browse to selectthe source system where the Adeptia Server is installed. (see Figure 4.7).


41/60


Figure 4.7: Select Source System

2. Click Next. The Select Target Location screen is displayed. Click Browse toselect the target location where the exported zip file will be saved (see Figure4.8).

Figure 4.8: Select Target Location3. Click Next. This displays the View Backup Logs screen (see Figure 4.9).


42/60


Figure 4.9: View Backup Logs

This screen displays all logs and confirms whether the export operation is successful ornot. If it is successful, a message stating Backup completed successfully is displayed inthe View Backup Logs screen and as a window popup, and a zip file is created. In case offailure, it displays an error message in the View Backup Logs screen and as a windowpopup, and rollbacks the entire operation.

IMPORT/ RESTORE

St e p s f or o f f l i n e m i g r a t i o n ( I m p o r t / Re st o r e ) :

1. Select Import/Retain radio button on the Offline Actions screen and clickNext.This displays the Import actions screen (see Figure 4.10).


43/60


Figure 4.10: Import Actions screen

This screen displays the Importmigration actions, which are outlined in the table below.

Table 4.3: Import Actions

Action Description

All Includes Database object and configurationfile. It is used for migrating objects in thesame version only.

Only Database Includes Database objects only

Only Configuration File Includes configuration files only

2. Select the All radio button, when both the source and target databases havethe same version of the Adeptia Server. For example, when migrating objectsfrom Adeptia Server 4.5 to Adeptia Server 4.5, click this option.

3. Select the Only Database radio button, when the source and target databaseshave different versions of the Adeptia Server. For example, when migratingobjects from Adeptia Server 4.4 to Adeptia Server 4.5, click this option. Thisdisplays the Select Source location screen. Click Browse to select the zip filecreated in the Export process (see Figure 4.11).


44/60


Figure 4.11: Select Source Location

4. Click Next. The Select Target Location screen is displayed. Click Browse toselect the directory, where the target system of the Adeptia Server is installed(see Figure 4.12).

Figure 4.12: Select Target System Install Directory5. Click Next. The Select Objects screen is displayed (see Figure 4.13). This

screen displays a list of all the tables of the Adeptia Server.


45/60


Figure 4.13: Select Objects screen

6. Check the checkbox(s) against the objects that you want to restore.You can select one or more objects.

All objects that are prefixed with ABPM are quartz tables. These tables and thedt_properties objects are listed in case of the SQL Server database. It is recommendednot to restore these objects as the migration process is likely to fail in such a case, as all

tables in the source and target databases should be the same. If they are different thendeselect the log objects such as (AU_Log and AU_TransactionData) as it slows down themigration process.

You need to be careful while migrating objects, as if an error occurs, itcannot be undone. Additionally, if the migration process fails, you haveto rollback the entire operation.

7. Click Next. This displays the View Restore Logs screen (see Figure 4.14).


46/60


Figure 4.14: View Restore Logs

This screen displays all logs and confirms whether the import operation is successful or not. Ifit is successful, a message stating, Selected database tables restored successfully isdisplayed in the View Restore Logs screen and as a popup window. Incase of failure, it displaysan error message in the View Restore Logs screen and as a popup window, and rollbacks theentire operation.

8. Select the Only Configuration Files radio button on the Import Actions screen,when you want to restore the configuration files only. This displays the SelectSource location screen (refer to Figure 4.11).

9. Click Browse to select the zip file created in the Export process.10.Click Next. The Select Target Location screen is displayed (refer to Figure

4.12).

11.Click Browse to select the directory, where the target system of the AdeptiaServer is installed.

12.Click Next. The Select Configuration Files screen is displayed (see Figure4.15). This screen displays a list of all the configuration files for all objects ofthe Adeptia Server.


47/60


Figure 4.15: Select Configuration Files

13.Check the checkbox(s) against the files that you want to restore.You can select one or more files.

14.Click Next. This displays the View Logs screen (see Figure 2.15).

Figure 4.16: View Logs

This screen displays all logs and confirms whether the import operation is successful or not. Ifit is successful, a message stating, Selected configuration files restored successfully isdisplayed in the View Logs screen and as a popup window. Incase of failure, it displays an


48/60


error message in the View Logs screen and as a popup window, and rollbacks the entireoperation.

Once the migration process is complete, you can start the Adeptia Server 4.5.

Before starting Adeptia Server 4.5, it is advised to manually compareserver-configuration properties and server-configuration-bak propertiesfiles to check the selected configuration parameters.

Please ensure that the password has been changed to indigo1.


49/60


5PATCH UPDATE

For Adeptia Server, patches are released from time to time to update the existing installation.Patch is basically a ZIP file which contains changed file and SQL script to change the backenddatabase. Patch update option of the migration utility is used to update the patch on theexisting installation. When a patch is applied, it replaces the changed file and changes thebackend database. You can also remove the patch, which you have applied.

Before applying patch, make sure that the Kernel and Web Runner arestopped. Once you have finished the process, you need to start theKernel and the Web Runner.

Steps to t r ans fe r ob j ec ts us i ng Pa tch Upda te

1. Select the Patch Update radio button on the Select Action screen and clickNext. This displays the Patch Update actions screen (see Figure 5.1).

Figure 5.1: Patch Update Actions

This screen displays the patch update actions, which are outlined in the table below.

Table 5.1: Patch Update Actions

Action Description

Apply Patch Allows you to transfer objects from one servicepack to another.

Remove Patch Allows you to rollback the Apply Patch processand replace all database files with the older


50/60


version.

You can run the Patch Update process on SQL Server only.

APPLYPATCH

Apply patch allows you to apply the patch on currently installed Adeptia Server.

Steps to t r ans fe r ob j ec ts us i ng App l y Pa tch : 1. Select Apply Patch radio button on the Patch Update Actions screen and click

Next. The Select Patch File Location screen is displayed. Click Browse to theselect the directory where the patch file (zip file containing all the changes) issaved (see Figure 5.2).

Figure 5.2: Saved Patch File

2. Click Next. This displays the Select Target Directory screen. Click Browse toselect the target system on which you want to save the patch file (see Figure5.3).


51/60


52/60


Figure 5.6: Enter Recovery File Name6. Select the directory where you want to save the recovery file and enter the

name of the recovery file in the File name field.

The Recovery File is also created as a zip file. Recovery file keeps thebackup of existing files, which will be replaced by patch update.

7. Click Save. This displays the View Apply Patch Logs screen (see Figure 5.7).


53/60


Figure 5.7: View Apply Patch Logs

This screen displays all logs and confirms whether the Apply Patch process is successful or not.If it is successful, a message stating, Apply Patch of selected objects completed successfullyis displayed in the View Apply Patch Logs screen and as a popup window, and the selectedobjects are updated to the service pack. In case of failure, it displays an error message in theView Apply Patch Logs screen and as a popup window, and rollbacks the entire operation.

8. Click Finish to complete the Apply Patch process and exit the Migration utility.

REMOVE PATCH

Remove Patch allows you to rollback the changes done by patch update. When you apply apatch, it asks you to create a recovery file. If you have created a recovery file, you canremove the patch, which you have applied. When you remove a patch, migration utility asksyou to select the recovery file, which you have created during patch update process and thenroll back all the changes done by patch update. It also rolls back the changes done in thebackend database.

Steps to reve r t ob j ec ts us i ng Remove Pa tch :

1. Select Remove Patch radio button on the Patch Update Actions screen andclickNext. The Select Recovery Patch File Location screen is displayed. ClickBrowse to the select the directory where the recovery patch file (zip file) issaved (see Figure 5.8).


54/60


Figure 5.8: Saved Recovery Patch File

2. Click Next. This displays the Select Target Directory screen. Click Browse toselect the target system on which you want to save the recovered patch file(see Figure 5.9).

Figure 5.9: Select Target System

3. Click Next. This displays the View Remove Patch Logs screen (see Figure5.10).


55/60


Figure 5.10: View Remove Patch Logs

This screen displays all logs and confirms whether the Remove Patch process is successful ornot. If it is successful, a message stating, Remove Patch of selected objects completedsuccessfully is displayed in the View Remove Patch Logs screen and as a popup window, andthe selected objects are updated to the service pack. In case of failure, it displays an errormessage in the View Remove Patch Logs screen and as a popup window, and rollbacks theentire operation.

4. Click Finish to complete the Remove Patch process and exit the Migrationutility.


56/60


6APPENDIXA

SAMPLE CONFIGURATIONVALUES

SQLSERVERDATABASE

Table 6.1: Sample Configuration Values for SQL Server Database

Field Sample Value

Server Name IP Address or Machine name

Port No.: 1433 (Default Value)

Database Name Name of the database

UserName Name of the user

Password Password

HSQLDB DATABASE

Table 6.2: Sample Configuration Values for HSQL Database

Field Sample Value

Server Name Machine name

2476 for BPM Objects (Default Value)Port No.:

2477 for BPM Logs (Default Value)

2476: BlankDatabase Name

2477: Blank

2476: saUserName

2477: sa

2476: BlankPassword

2477: sa

DEFAULTVALUES FORADDITIONAL COLUMNS IN AN UPGRADEDVERSION


57/60


Table 6.3: Default Values for Additional Columns in an Upgraded Version

Field Type Default Value

Numeric: 0

Text: Empty String

NOT NULL

Boolean: False

NULL Database specific NULL


58/60


7TABLE OF FIGURES

Figure 2.1: Adeptia Migration Utility screen ..................................................................... 6

Figure 2.2: Select Action screen .................................................................................... 6

Figure 3.1: Environment Promotion Actions screen...........................................................7

Figure 3.2: Select Source System Install Directory ...........................................................8

Figure 3.3: Select Group ..............................................................................................9

Figure 3.4: Select the Action......................................................................................... 9

Figure 3.5: Select Process Flows.................................................................................. 10

Figure 3.6: Select Service........................................................................................... 11

Figure 3.7: Select Target Directory .............................................................................. 12

Figure 3.8: View Export Logs ...................................................................................... 12

Figure 3.9: Select Source Location............................................................................... 13

Figure 3.10: Select Target System Install Directory ........................................................ 14

Figure 3.11: Select Group........................................................................................... 14

Figure 3.12: Generating Compare Selected Objects Process............................................. 15

Figure 3.13: Compare Objects (Process Flow Objects)..................................................... 15

Figure 3.14: Compare Objects (All Objects)................................................................... 16

Figure 3.15: Select View Changes option ...................................................................... 17

Figure 3.16: View Difference ....................................................................................... 18

Figure 3.17: Select Retain XML Location ....................................................................... 19

Figure 3.18: Enter username....................................................................................... 19

Figure 3.19: Select Target Location for Promoted Objects................................................ 20

Figure 3.20: View Promoted Logs................................................................................. 20

Figure 3.21: View PDF Report...................................................................................... 21

Figure 3.22: Generate Retain List Process ..................................................................... 22

Figure 3.23: Retain List .............................................................................................. 22

Figure 3.24: Select Specific Activity Option ................................................................... 24

Figure 3.25: Retain Activity Query Builder..................................................................... 25

Figure 3.26: Activity Name Displayed in the Query Information Field................................. 26

Figure 3.27: Fields associated with a Service................................................................. 27

Figure 3.28: Select Field............................................................................................. 28

Figure 3.29: Select Delete Option ................................................................................ 30

Figure 3.30: Select Source Location ............................................................................. 31


59/60



Figure 3.32: Enter username....................................................................................... 32

Figure 3.33: View Deployed Logs................................................................................. 33Figure 4.1: Migration Actions ...................................................................................... 34

Figure 4.2: Configuration Settings for Source Database................................................... 35

Figure 4.3: Configuration Settings for Target Database ................................................... 36

Figure 4.4: Select Tables ............................................................................................ 37

Figure 4.5: View Logs ................................................................................................38

Figure 4.6: Offline Actions screen ................................................................................ 39

Figure 4.7: Select Source System ................................................................................ 40

Figure 4.8: Select Target Location................................................................................ 40

Figure 4.9: View Backup Logs ..................................................................................... 41Figure 4.10: Import Actions screen .............................................................................. 42

Figure 4.11: Select Source Location ............................................................................. 43


Figure 4.13: Select Objects screen............................................................................... 44

Figure 4.14: View Restore Logs ................................................................................... 45

Figure 4.15: Select Configuration Files.......................................................................... 46

Figure 4.16: View Logs............................................................................................... 46

Figure 5.1: Patch Update Actions ................................................................................. 48

Figure 5.2: Saved Patch File........................................................................................ 49Figure 5.3: Select Target System................................................................................. 50

Figure 5.4: Apply Patch Process................................................................................... 50

Figure 5.5: Generate Recovery File Popup..................................................................... 50

Figure 5.6: Enter Recovery File Name........................................................................... 51

Figure 5.7: View Apply Patch Logs ............................................................................... 52

Figure 5.8: Saved Recovery Patch File .......................................................................... 53

Figure 5.9: Select Target System................................................................................. 53

Figure 5.10: View Remove Patch Logs .......................................................................... 54


60/60

8TABLE OF TABLES

Table 3.1: Environment Promotion Actions ...................................................................... 8

Table 3.2: Services and their name which have changed................................................. 11

Table 3.3: Legends on the Compare Objects screen........................................................ 16

Table 4.1: Migration Actions........................................................................................ 34

Table 4.2: Offline Actions ........................................................................................... 39

Table 4.3: Import Actions ........................................................................................... 42

Table 5.1: Patch Update Actions .................................................................................. 48

Table 6.1: Sample Configuration Values for SQL Server Database..................................... 55

Table 6.2: Sample Configuration Values for HSQL Database............................................. 55

Table 6.3: Default Values for Additional Columns in an Upgraded Version .......................... 56

Documents

Adeptia Migration Utility User Guide