Adeptia Suite 6.2 Migration Utility Guide · 9/24/2014 · Adeptia Suite 6.2 Migration Utility...

Adeptia Suite 6.2Migration Utility Guide

Release Date: September 24, 2014

343 West Erie, Suite 440 Chicago, IL 60654, USA

Phone: (312) 229-1727 x111 Fax: (312) 229-1736

Document Information

2 Adeptia Incorporation Adeptia

DOCUMENT INFORMATION

Adeptia Inc.

Migration Utility Guide

Printed November 2012

Printed in USA

Adeptia Support Information

For support queries, please contact us at [email protected].

Access the Adeptia Web site at the following URL:

www.adeptia.com

Copyright

Copyright © 2000-2013 Adeptia, Inc. All rights reserved.

Trademarks

Adeptia™ is a trademark of Adeptia, Inc. All other trademarks and registered trademarks are the property of their respective owners.

Confidentiality

This document is the confidential and proprietary information of Adeptia. The information set forth herein represents the confidential and proprietary information of Adeptia. Such information shall only be used for the express purpose authorized by Adeptia and shall not be published, communicated, disclosed or divulged to any person, firm, corporation or legal entity, directly or indirectly, or to any third person without the prior written consent of Adeptia.

Disclaimer

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

No part of this work should be reproduced in any form or by any means—graphic, electronic, or mechanical—including photocopying, recording, taping, or storage in an information retrieval system, without prior written permission of Adeptia Inc.

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

mailto:[email protected]

http://www.adeptia.com/

Table of Contents

Adeptia Incorporation Adeptia Suite 6.1 Migration Utility Guide 3

TABLE OF CONTENTS Document Information .............................................................................................................................................. 2

Table of Contents................................................................................................................................................... 3

Preface .................................................................................................................................................................. 5

Target Audience ..................................................................................................................................................... 5

How is this guide organized? ..................................................................................................................................... 5

Conventions ............................................................................................................................................................... 6 Typographical conventions .................................................................................................................................... 6 Graphical conventions ........................................................................................................................................... 6

Contacts/Reporting problems .................................................................................................................................... 7 Sales ....................................................................................................................................................................... 7 Support .................................................................................................................................................................. 7 Latest updates and information ............................................................................................................................ 7 Adeptia Website .................................................................................................................................................... 7

Introduction ........................................................................................................................................................... 9

Need for Migration .................................................................................................................................................... 9

Adeptia Migration Utility ........................................................................................................................................... 9

Benefits of using Adeptia Migration utility .............................................................................................................. 10

Getting Started .................................................................................................................................................... 11

Prerequisites ............................................................................................................................................................ 11

Starting Migration Utility ......................................................................................................................................... 11 Starting Migration Utility ..................................................................................................................................... 11 Starting Migration Utility in Console mode ......................................................................................................... 13

Environment Promotion ...................................................................................................................................... 15

Export ....................................................................................................................................................................... 16

Promote ................................................................................................................................................................... 22 Generating XML for Retained Objects in the Target System ............................................................................... 31 Deleting an Object ............................................................................................................................................... 37

Deploy ...................................................................................................................................................................... 38

Migration ............................................................................................................................................................. 41

Online Migration ...................................................................................................................................................... 42

Off Line Migration .................................................................................................................................................... 45 Export/Backup ..................................................................................................................................................... 46 Import/Restore .................................................................................................................................................... 49

Migrating objects in version control .................................................................................................................... 55

Backup and Restore ............................................................................................................................................. 57

Table of Contents

4 Adeptia Suite 6.1 Migration Utility Guide Adeptia Incorporation

Backup ..................................................................................................................................................................... 57

Restore ..................................................................................................................................................................... 58

Installing Accelerators ......................................................................................................................................... 59

Appendix A .......................................................................................................................................................... 62

Sample Configuration Values ................................................................................................................................... 62 SQL Server Database ............................................................................................................................................ 62 HSQLDB Database ................................................................................................................................................ 62 Default Values for Additional Columns in an Upgraded Version ......................................................................... 63

Appendix B .......................................................................................................................................................... 64

Configuring Server-Cofigure.Properties File for WebSphere build ........................................................................... 64

Preface


1 PREFACE The Migration Utility guide enables you to seamlessly migrate objects in situations, such as Environment Promotion, and Migration.

Target Audience

This document is intended for those users, who want migrate objects (Activities, Objects, Process Flows, Users and Groups etc.) from one Adeptia Suite installation to another Adeptia Suite installation. For example let say you are using three Adeptia Suite environment Development, QA and Production. Initially you will create all your objects in Development environment. Once you are done with all your development work, you will have to migrate all those objects to QA environment. This document explains how you can migrate those objects using migration utility.

HOW IS THIS GUIDE ORGANIZED?

This guide is organized into the following sections:

Section Description

Preface Introduction to this document

Overview Need for migration, Adeptia Migration Utility and Benefits of using the Adeptia Migration utility

Getting Started Prerequisites, Starting Migration Utility

Environment Promotion Steps to use Environment promotion

Migration Use the Migration process to migrate objects from the currently installed version to a new upgraded version

Backup and Restore Explains how to take backup and restore.

Installing Accelerators Explains how to deploy pre-built accelerators

Appendix A Sample Configuration Values

Appendix B Configuring Server-Cofigure.Properties File For Websphere Build

Preface


CONVENTIONS

The following tables list the various conventions used in Adeptia documentation. We follow these conventions to help you quickly and easily identify particular elements, processes, and names that occur frequently in documents.

Typographical conventions

This guide uses the following typographical conventions:

Convention Description

Bold text Indicates one of the following:

Screen element

New terminology

A file or folder name

A control in an application’s user interface

A registry key

Important information

Italic text Indicates a reference or the title of a publication.

Monospaced text Indicates code examples or system messages.

Monospaced bold text Indicates system commands that you enter.

Hyperlink Indicates an Internet link to target material.

Graphical conventions

This guide uses the following graphical conventions:

Convention Description

Indicates additional information that may be of interest to the reader.

Preface


CONTACTS/REPORTING PROBLEMS

These sections present contact information for a variety of situations.

Sales

In case of any sales queries, please contact us at [email protected].

Support

For support queries, please contact us at [email protected].

Latest updates and information

For the latest updates and information, please visit us at www.adeptia.com.

Adeptia Website

Access the Adeptia Website at the following URL:

www.adeptia.com





Introduction


2 2 INTRODUCTION

NEED FOR MIGRATION

At times while working with an Adeptia product, you may come across a situation, where you need to change a process flow or an object. For this, you need to transfer the objects across multiple environments, such as change the object in the Development environment, test it in the 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 the earlier version to the upgraded version. This can be quite a cumbersome process.

ADEPTIA MIGRATION UTILITY

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

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

Migrate objects from an older version to a new upgraded version

Change the backend database

Take backup of the Adeptia Server

Apply Accelerator

This tool allows you to transfer objects in three ways:

Environment Promotion: It allows you to promote objects across environments. This is migration at the user level, where you can select a group and promote all its objects such as Events, Activities, Process Flows, Users and Groups, to another environment. In environment promotion logs data and transaction states are not transferred to new environment.

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

Apply Accelerator: It allows you to apply the Accelerators. For example: Netsuite, Salesforce and EDI Accelerators.

Whenever you migrate objects from one environment to another, all the activated Events get de-activated in new environment. You need to activate those events again.

To learn how to omit version control fields while migrating objects, please refer to the

MIGRATING OBJECTS IN VERSION CONTROL section.

Introduction


BENEFITS OF USING ADEPTIA MIGRATION 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 rolled back.

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

Getting Started


3 GETTING STARTED

PREREQUISITES

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

Java Runtime Environment (JRE) 1.6

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. In other databases, the kernel is not required to be running, however if it is running, it will not affect the migration utility.

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

STARTING MIGRATION UTILITY

You can run the Migration utility on:

Server

Desktop

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

It is recommended that you run the utility on the Adeptia Server, as some 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.

Migration Utility can be started in GUI Mode or in the Console mode.

Starting Migration Utility

Steps to start the Migration Utility

1. To start migration utility bundled with Adeptia Suite, go to ./bin folder where Adeptia Suite is installed.

For Windows OS double click the MigrationUtility.exe file. The Adeptia Migration wizard is displayed (see Figure 1).

For Linux OS, type the following command:

./migrationutility.sh -console

Getting Started


Figure 1: Adeptia Migration Utility Screen

2. Click Next. The following screen is displayed (see Figure 2).

Figure 2: Select the build environment

Select the Standalone Build if the Adeptia Server is installed in standalone mode and select WebSphere Build in case the Adeptia Server is deployed on WebSphere Application Server.

In case you are using Migration Utility for WebSphere build, you need to do some changes related to backend database in Server-Configure.Properties file. To know how to change

Getting Started


Server-Configure.Properties file, refer to section Appendix B.

3. Select the build environment and click Next. The Select Action screen is displayed (see Figure 3).

Figure 3: Select Action screen

4. Select the appropriate radio button and click Next. The subsequent screens are displayed based on the selected option. If you select Environment promotion option, refer to Environment Promotion section. If you select the Migration option, refer to the Migration section.

Starting Migration Utility in Console mode

Using Migration Utility in console mode is similar to that of using it in GUI mode with minor differences. Just the initial startup is explained in this section.

Steps to start the Migration Utility in Console mode

1. Open the command prompt and change to the ServerKernel folder.

2. Run the following command to start it in console mode. The Migration Wizard starts (see Figure 4).

migrationutility.bat –console

Getting Started


Figure 4: Adeptia Migration Utility Screen

3. Select the appropriate option to go to the next step. For example in the above screen, to select STANDALONE BUILD, type 1 and press ENTER (see figure below).

Environment Promotion


4 ENVIRONMENT PROMOTION You can use Environment Promotion to transfer objects of selected groups from one environment to another. This implies that you need to select a group and then transfer the objects of that selected group.

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

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

Steps to promote objects using Environment Promotion

Environment Promotion is a three-step process.

1. Select the Environment Promotion radio button on the Select Action screen and click Next. This displays the Environment Promotion Actions screen (see Figure 5).

Figure 5: Environment Promotion Actions screen

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



Table 1: Environment Promotion Actions

Database Server JDBC Driver

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

Promote Allows you to select objects from exported zip file, compare it with the target system and generate another zip file for the changes you want to update to the target system.

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

EXPORT

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

Steps to export objects

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

Figure 6: Select Source System Install Directory

In case you have selected WebSphere Build, you need to select the AdeptiaSharedLibrary folder in the above step.



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

Figure 7: Select Group

3. This screen displays a list of all the groups in the Adeptia Server. Select the checkbox 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 8).



Figure 8: Select the Action

If you select the Process Flow Objects radio button in the Select Action screen then follow the 5 to 6 steps.

If you select the All Objects radio button in the Select Action screen then follow the 7 to 8 steps.

5. Select the objects that you want to export. You can either export all objects of the selected groups or only all process flows and their associated objects. Click the appropriate radio button. If you have selected multiple groups in the Select Group screen and you select the Process Flow Objects option in this screen, then all objects associated with all Process Flows are exported. It will not allow you to select few process flows. However, if you have selected only one group in the Select Group screen, then selecting the Process Flow Objects option, will display the Select Process Flow screen (see Figure 9).



Figure 9: Select Process Flows

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

7. If you select the All Objects radio button in Select Action screen, the Select Services screen is displayed (see Figure 10). On the Select Services screen you can select all services or only the required services to export. To select all services, click the Select All button. To select the individual services select the checkbox against the required services.

Figure 10: Select Service



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

When you export a project then, the export file does not include the activities outside of the project even if you are using it in the process flow of that project. You need to explicitly export all the dependent activities separately.

8. On the Select Filtering Criteria screen, select the filter column, comparison criteria, and comparison value in the Specify filter criteria, Specify comparison criteria, and Specify comparison value fields respectively.

Figure 11: Select Filtering Criteria

If in the Specify comparison criteria drop-down list, you select the < list item then the wizard

will include all the objects in the export file that are less than the date specified in the Specify comparison value field.

If in the Specify comparison criteria drop-down list, you select the > list item then the wizard

will include all the objects in the export file that are greater than the date specified in the Specify comparison value field.

Table 2: Services and their name which have changed

Current Service Name Old Service Names

Data Mapping Mapping Transformation



Current Service Name Old Service Names

Custom Plugin Scripted Service

Database Event DBEvent

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

Figure 12: Select Target Directory

10. Click Next to start the export process. The progress of this process is displayed in the View Logs screen (see Figure 13).



Figure 13: View Export Logs

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

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

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

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

PROMOTE

This step is performed on the target system.

Pre-Requisite

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

Steps to Promote objects

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



Figure 14: Select Source Location

2. Click Next. This displays the Select Target Directory screen. Click Browse to select the directory, where the target system on which the Adeptia Server is installed (see Figure 15).

Figure 15: Select Target System Install Directory




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

Figure 16: Select Group

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

You can select one or more groups.

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

Figure 17: Generating Compare Selected Objects Process

5. Once the process is complete, the Compare Objects screen is displayed (see Figure 18).



Figure 18: Compare Objects (Process Flow Objects)

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



Figure 19: Compare Objects (All Objects)

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

6. The Compare Objects screen displays objects in a tree structure, which shows a comparison between the source and target objects at both the activity and field levels. It displays legends at the activity and field levels, which highlight the comparison and indicate whether the activity or field will be updated or not. 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 the table below.

Table 3: Legends on the Compare Objects screen

Legend Service Name Description

Source and target objects are different. Once the source objects are promoted, the target objects will be updated.

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



Legend Service Name Description

New record will be inserted from the source end to the target end, as the target database has additional parameters.

No source data exists for the particular target field.

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

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

7. You can view the changes between the source and target end by right-clicking each field/activity, and selecting View Changes option (see Figure 20).

Figure 20: Select View Changes option



8. The View Difference screen is displayed (see Figure 21).

Figure 21: View Difference

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

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

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

10. Click Next. The Select Retain XML Location screen is displayed. Click Browse to select the location where the xml file for the objects to be retained, is stored (see Figure 22).



Figure 22: Select Retain XML Location

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

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

Figure 23: Enter username



12. Click Next. The Select Target location screen is displayed. Click Browse to select the target location where you want to save the zip file created in the Promotion process (see Figure 24).

Figure 24: Select Target Location for Promoted Objects

13. Click Next to start the Promote process. The progress of this process is displayed in the View Promoted Logs screen (see Figure 25).

Figure 25: View Promoted Logs



This screen displays all logs and confirms whether the promote operation is successful or not. If it is successful, a message stating, “Promoting objects completed successfully” is displayed in the View Promoted Logs screen and as a popup window, and a zip file of the promoted objects is created. In case of failure, it displays an error message in the View Promoted Logs and as a popup window, and rollbacks the entire operation.

14. Click View PDF Report to view a list of all records that will be updated and inserted in the target system in the Deployment state.

A record is inserted at the target end, when data at the source and target end differ.

The Report feature is available only in the Promote step.

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

Figure 26: View PDF Report

16. Click Close to close this screen and return to the View Promoted Logs screen.

17. Click Finish to complete the promote process and exit the Migration utility.

Generating XML for Retained Objects in the Target System

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



different. You do not want to overwrite the connection parameters at the target end. The Adeptia migration utility allows you to retain the objects by creating an xml of the objects.

1. Click Generate Retain XML on the Select Retain XML Location screen to select the objects to be retained. This displays the process in the running state (see Figure 27).

Figure 27: Generate Retain List Process

2. Once the process is complete, the Retain List is generated (see Figure 28).

Figure 28: Retain List

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

Service Level

Field Level

You can retain objects at both the Service and Field Levels but at a time 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 to retain all objects of the Mail Target service. So, instead of individually retaining each object, you can retain the entire Mail Target service. This implies that when the data is transferred, the Mail Target service at the source end will be ignored, and not transferred.

Steps to retain objects at Service level

1. Select the checkbox against the service that you want to retain.

You can expand the service by clicking [+] against the service. All fields 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 select Specific Activity option (see Figure 29).

Figure 29: Select Specific Activity Option



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

Figure 30: Retain Activity Query Builder

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

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

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

5. Click Insert. This displays the activity name and ID in the Query Information field (see Figure 31).

Figure 31: Activity Name Displayed in the Query Information Field



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

You can remove an activity listed in this field, by selecting the activity and pressing <Delete> on the keyboard.

6. Click Done to complete the query and return to the previous screen (refer to Figure 29).

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

Retaining Objects at Field Level

At times, you may want to retain values of a specific field only. For example, while transferring data, you want to retain the UserID and Password values of the Mail Target activity. You can retain these fields using the Migration tool. Thus, when data is transferred, values in the UserID and Password fields will be ignored at the source end and not overwritten at the target end.

Steps to retain objects at Field level

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

Figure 32: Fields associated with a Service



2. Select the checkbox of the field that you want to retain. This will retain the field for all objects of the selected service (see Figure 33).

Figure 33: Select Field

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

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

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

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

5. Click Insert. This displays the activity name and ID in the Query Information field (refer to Figure 31).

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

You can remove an activity listed in this field, by selecting the activity and pressing <Delete> on the keyboard.



6. Click Done to complete the query and return to the previous screen (refer to Figure 29).

7. Click Generate Retain XML. This generates the xml file for the retained activity. This implies that when transferring data, the field values of the specified activity will be ignored at the source end and not overwritten at the target 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 retain this value of the target side, the changed value is extracted from the target and transferred to the source, thus implying that the values are same at the source and target end. For example, if the File Path field of the File Source service is changed, then the updated value is extracted from the target end and transferred to the source end of the File Path field. This field is now displayed in the Compare Objects screen

with the legend.

Deleting an Object

While comparing the objects, you can delete an object.

Steps to delete an object

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

Figure 34: Select Delete Option



2. 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 flows and activities is deleted. If you delete an object at the Process Flow level, then all process flows and its objects are deleted. If you delete an object at the Activity level, then the entire activity along with its fields is deleted.

DEPLOY

The Deploy step allows you to apply the promoted changes to target system.

Steps to Deploy objects

1. Select the Deploy radio button on the Environment Promotion Actions screen and click Next. The Select Source data location screen is displayed. Click Browse to select the zip file that was created in the Promote process (see Figure 35)


2. Click Next. This displays the Select Target Directory screen. Click Browse to select the target system on which the promoted zip is to be deployed (see Figure 36).





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

Figure 37: Enter username



4. Click Next. This displays the Logs Details screen (see Figure 38).

Figure 38: View Deployed Logs

This screen displays all logs and confirms whether the deployment operation is successful or not. If it is successful, a message stating, “Deployment of selected objects completed successfully” is displayed in the View Deployed Logs screen and as a popup window, and the selected objects are deployed. In case of failure, it displays an error message in the View Deployed 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.

Migration


5 MIGRATION You can use the Migration process to migrate objects from the currently installed version to a new upgraded version. This process also allows you to take a backup of all objects and configuration 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 of Adeptia Server 4.5, you want to upgrade to this new version. After installing it, you need to transfer all data from Adeptia Server 4.4 to Adeptia Server 4.5. To do this, you can use the Migration process.

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

Steps to migrate objects using Migration

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

Figure 39: Migration Actions

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

Table 4: Migration Actions

Action Description

Migration


Action Description

Online Migration Allows you to migrate objects from the source system database to the target system database. The source and target databases should be in running mode when using this action.

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

ONLINE MIGRATION

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 this process. For example, if the earlier version of Adeptia Server is on HSQL database, and the upgraded version is on SQL Server, you can use this process to transfer the objects.

Steps to migrate objects using online migration:

1. Select the Online migration radio button on the Migration Actions screen and click Next. The Configuration Settings screen for Source Database is displayed (see Figure 40).

Figure 40: Configuration Settings for Source Database

2. Select the source database type from the Database Type drop-down list.

3. Enter the name of the source database server in the Server Name field.

4. Enter the port number of the source database in the Port No. field.

Migration


5. Enter the name of the source database in the Database Name field.

6. Enter the username and password for accessing the source database, in the UserName and Password fields respectively.

7. Click Next. This displays the Configuration Settings screen for the Target Database (see Figure 41).

Figure 41: Configuration Settings for Target Database

Refer to Error! Reference source not found. for sample configuration values for SQL Server and HSQL databases.

8. Enter the target database information and click Next. The Select Objects screen is displayed (see Figure 42). This screen displays a list of all the tables of the Adeptia Server.

Migration


Figure 42: Select Tables

9. Select 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 the dt_properties tables and are listed in case of the SQL Server database only. It is recommended 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 you need the log, as these are big size tables and slow down the migration process considerably.

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

10. Click Next. This displays the View Logs screen (see Figure 43).

Migration


Figure 43: View Logs

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

11. Click Finish. This completes the migration process.

When you migrate to an upgraded version, the Migration tool takes care of all the new fields at the target end, and inserts default values for these fields. These values are displayed in the View Logs screen. Refer to Appendix A for more details on the default values. To change these values, you need to manually update them using the Manage section in the Adeptia Server.

OFF LINE MIGRATION

The Offline Migration process is used for migrating objects when the source database to target database, when the databases are not connected at the same time. It is used to migrate objects as well as take backup.

Steps to migrate objects using offline migration

1. Select Offline migration radio button on the Migration Actions screen and click Next. This displays the Offline Actions screen (see Figure 44).

Migration


Figure 44: Offline Actions screen

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

Table 5: Offline Actions

Action Description

Export/Backup Without Logs Creates a zip file containing all source database objects and configuration files but without logs

Export/Backup with Logs Creates a zip file containing all source database objects and configuration files with logs.

Import/Restore Import all source database objects and configuration files from the zip file to the target system.

Export/Backup

Steps for offline migration (Export/Backup)

1. Select Export/Backup Without Logs or Export/Backup With Logs radio button on the Offline Actions screen and click Next. This displays the Select Source Database screen. Click Browse to select the source system where the Adeptia Server is installed (see Figure 45).

If you do not want to migrate the Logs, it is recommended to use Export/Backup Without Logs option.

Migration


Figure 45: Select Source System


2. Click Next. The Select Target Location screen is displayed.

Migration


Click Browse to select the target location where the exported zip file will be saved (see Figure 46).

Figure 46: Select Target Location

3. Click Next. This displays the View Backup Logs screen (see Figure 47).

Figure 47: View Backup Logs

This screen displays all logs and confirms whether the export operation is successful or not. If it is successful, a message stating “Backup completed successfully” is displayed in the View Backup Logs screen and as a window popup, and a zip file is created. In case of failure, it displays an error message in the View Backup Logs screen and as a window popup, and rollbacks the entire operation.

Migration


Import/Restore

Steps for offline migration (Import/Restore)

1. Select the Import/Retain radio button on the Offline Actions screen and click Next. This displays the Import Actions screen (see Figure 48).

Figure 48: Import Actions screen

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

Table 6: Import Actions

Action Description

All Migrates Database object, Data Files and configuration file.

Database Objects includes Activities, Process Flows, Users and Groups etc.

Data Files includes Data Dictionary XSDs, Custom Methods and WSDL etc.

Configuration Files includes Server-Configure.Properties, and Launcher.properties etc.

If you select All and click Next, two options are displayed. Those options are given below:

Skip Configuration File: Select this option if you want to migrate only Database Objects and Data Files and not the Configuration Files.

Include Configuration Files: Select this option if you want to migrate all Database Objects, Data Files and Configuration Files.

Migration


Action Description

Only Database Migrates only Database objects. Data Files and Configuration file are not migrated using this option.

Only Configuration File

Migrates only Configuration Files. Database Objects and Data Files are not migrated using this option.

In case you have selected WebSphere Build, you can only use Only Database option.

2. Select the required option and click Next. This displays the Select Source Data Location screen (see Figure 49).


Migration


3. Click Browse to select the zip file created in the Export process and click Next. The Select Target Location screen is displayed (see Figure 50).


4. Click Browse to select the directory, where the target system of the Adeptia Server is installed and click Next.


5. Screen which is displayed next depends on the option that you have selected in Select Action screen.

a. In case you have select All, all objects are deployed at the target environment.

b. In case you have selected Only Database option, then the next screen displays the list of all the tables of the Adeptia Server (see Figure 51).

Migration


Figure 51: Select Objects Screen

Select 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 the dt_properties objects are listed in case of the SQL Server database. It is recommended not 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 then deselect the log objects such as (AU_Log and AU_TransactionData) as it slows down the migration process.

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

c. In case you select Only Configuration Files option then the next screen displays the list of all the configuration files for all objects of the Adeptia Server. (See Figure 52)

Migration


Figure 52: Select Configuration Files

Select the checkbox(s) against the files that you want to restore.

You can select one or more files.

6. Click Next. This displays the View Restore Logs screen (see Figure 53).

Figure 53: View Restore Logs

Migration


This screen displays all logs and confirms whether the import operation is successful or not. If it is successful, a message stating, “Selected database tables restored successfully” is displayed in the View Restore Logs screen and as a popup window. In case of failure, it displays an error message in the View Restore Logs screen and as a popup window.

Once the migration process is complete, you can start the target environment.

Before starting the target environment, it is advised to manually compare server-configuration properties and server-configuration-bak properties files to check the selected configuration parameters.

Migrating objects in version control


6

MIGRATING OBJECTS IN VERSION

CONTROL

Versioning refers to the process of assigning unique version numbers to unique states of the activities and objects. These numbers are generally assigned in increasing order and correspond to new developments in a group or project. While migrating objects in version control we can omit the version control fields if required.

This can be done through a configuration file migration.propeties which further has the following configurable properties:

migration.export.omitVersionControlFields

migration.import.omitVersionControlFields

By default the value of these properties is set as false. This means by default, the version control fields will not be omitted while exporting or deploying objects in version control.

Steps to Omit the Version Control Fields while Exporting and Deploying Objects in Version Control:

1. Go to <Adeptia Suite Installation folder>\AdeptiaServer\ServerKernel\MigrationUtility folder.

2. Open the migration.properties file.

3. Set the value of migration.export.omitVersionControlFields property as true while exporting objects in version control.

To learn how to export objects, please refer to the Export section.

4. Set the value of migration.import.omitVersionControlFields property as true while deploying objects in version control.

To learn how to deploy objects, please refer to the Deploy section.

5. Save this file.

Migrating objects in version control


It is recommended that whenever you migrate version control objects to target environment, then it shall not have version control enabled in it.

Backup and Restore


7

BACKUP AND RESTORE

It is always recommended to take the backup of Adeptia Suite on a certain interval so that you can restore the objects incase drive on which Adeptia Suite is running gets damaged.

This section explains the steps to take the backup of objects. (activities, process flows, User, Groups and configuration file etc).

BACKUP

Using Migration Utility can be used to take the backup of all objects of Adeptia Server.

createbackup.bat (for windows) and createbackup.sh (for linux and solaris) is provided in the <InstallFolder>\ServerKernel folder. When you execute this file, it creates a zip file, which contains the backup of objects. Name of the zip file will be backup_<Date>_<Time>.zip.

A file backup.properties is provided in <InstallFolder>\ServerKernel\MigrationUtility. This file is used to define following parameters:

Folder where zip file is created

Whether to backup the optional file or not

KernelApplication.log and WebrunnerApplication.log are the optional files. These file contains logs of Kernel and WebRunner.

Default backup.properties is given in Figure 54

Figure 54: Sample backup.properties file

By default the zip file is created in the folder where Adeptia Suite is installed. For example if Adeptia Suite is installed in C:\Program Files\AdeptiaSuite\AdeptiaServer-5.0 then the backup is created in C:\Program Files\AdeptiaSuite\AdeptiaServer-5.0.

If you want to create the backup file in any other folder, then edit the <InstallFolder>\ServerKernel\MigrationUtility\backup.properties file and specify the path where you want to create the backup zip. You can specify any absolute path.

Use only forward slash (/) in the path.

Backup and Restore


By default optional files are not included in the backup. If you want to include optional files in the backup then edit the backup.properties file and change the value of optional.files from no to yes.

Steps to backup the objects

1. Make sure that the Kernel is running.

2. In case you want to create the backup in folder other than the default folder, edit the backup.properties file and specify the path where you want to create the backup zip.

3. Go to <InstallFolder>\ServerKernel folder in execute the createbackup.bat file.

On Linux or Solaris, execute createbackup.sh file using following command.

./createbackup.sh

RESTORE

To restore the backup you need to use Migration Utility’s Offline Migration option. For detailed information, refer to Import/Restore section of this guide.

Installing Accelerators


8 INSTALLING ACCELERATORS Accelerators are the pre-build solutions that are provided for specific purposes. These accelerators are in the form zip file. Adeptia provides following accelerators:

EDI Accelerator

HL7 Accelerator

Netsuite Accelerator

Salesforce Accelerator

Migration Utility provided an option to install these accelerators on Adeptia Suite in few simple steps.

Pre-requisites

Kernel should be running before installing the accelerator.

Steps to install Accelerators

1. Select the Install Accelerators radio button on the Select Action screen and click Next. This displays Select Zip Location screen (see Figure 5).

Figure 55: Select the Accelerator zip



2. Click Browse and select the zip of the accelerator that you want to install and click Next. The Select Target System screen is displayed (See Figure 56).

Figure 56: Select Target system Install Directory

3. Select the folder where Adeptia Suite is installed. For example C:\Program Files\AdeptiaSuite \AdeptiaServer-5.0\. Click Next.

4. In case any configuration change is required in Adeptia Suite, the next screen displays those Parameters, where you can enter their values.

For example if you install Netsuite accelerators, login credentials of Netsuite need to be configured in Adeptia Suite (See Figure 57).



Figure 57: Configure the Login Credentials

5. Enter the required information and select Next. It starts the installation of accelerator. (see Figure 58 ).

Figure 58: Accelerator Installation Completed

6. Click OK to close the confirmation dialog box.

You can also view the installation logs.

7. To save the installation logs, click Save Logs.

Appendix A


9

APPENDIX A

SAMPLE CONFIGURATION VALUES

SQL Server Database

Table 7: Sample Configuration Values for SQL Server Database

Field Description

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 8: Sample Configuration Values for HSQL Database

Field Sample Value

Server Name Machine name

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

2477 for BPM Logs (Default Value)

Database Name 2476: Blank

2477: Blank

UserName 2476: sa

Appendix A


Field Sample Value

2477: sa

Password 2476: Blank

2477: sa

Default Values for Additional Columns in an Upgraded Version

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

Field Type Default Value

NOT NULL Numeric: 0

Text: Empty String

Boolean: False

NULL Database specific NULL

Appendix B


10 APPENDIX B

CONFIGURING SERVER-COFIGURE.PROPERTIES FILE FOR WEBSPHERE BUILD

In case you are using Migration Utility for WebSphere build, you need to do some changes in ./AdeptiaSharedLibrary/config/server-configure.properties file as shown below:

<Group hide="true" name="Database Configuration"> <Property comment="JDO Database Driver Url" dynamic="no" name="abpm.jdo.driver">oracle.jdbc.driver.OracleDriver</Property> <Property comment="JDO Database Connection Url" dynamic="no" name="abpm.jdo.url">jdbc:oracle:thin:@<HostName>:<Port>:<DatabaseName></Property> <Property comment="JDO Database UserName" dynamic="no" name="abpm.jdo.username"><UserId></Property> <Property comment="JDO Database Password" dynamic="no" encrypt="n" name="abpm.jdo.password"><Password></Property>

where:

<HostName> : Name or IP Address of the machine where backend Database Server is running.

<Port>: Port on which the backend Database Server is running.

<DatabaseName>: Name of the database which is being used for backend database.

<UserId>: User Id of the backend database.

<Password>: Password of the backend database.

Appendix B


TABLE OF FIGURES

Figure 1: Adeptia Migration Utility Screen .................................................................................................................. 12

Figure 2: Select the build environment ....................................................................................................................... 12

Figure 3: Select Action screen...................................................................................................................................... 13

Figure 4: Adeptia Migration Utility Screen .................................................................................................................. 14

Figure 5: Environment Promotion Actions screen ....................................................................................................... 15

Figure 6: Select Source System Install Directory ......................................................................................................... 16

Figure 7: Select Group ................................................................................................................................................. 17

Figure 8: Select the Action ........................................................................................................................................... 18

Figure 9: Select Process Flows ..................................................................................................................................... 19

Figure 10: Select Service .............................................................................................................................................. 19

Figure 11: Select Filtering Criteria ............................................................................................................................... 20

Figure 11: Select Target Directory ............................................................................................................................... 21

Figure 12: View Export Logs......................................................................................................................................... 22

Figure 13: Select Source Location ................................................................................................................................ 23

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

Figure 15: Select Group ............................................................................................................................................... 24

Figure 16: Generating Compare Selected Objects Process ......................................................................................... 24

Figure 17: Compare Objects (Process Flow Objects) ................................................................................................... 25

Figure 18: Compare Objects (All Objects) .................................................................................................................... 26

Figure 19: Select View Changes option ....................................................................................................................... 27

Figure 20: View Difference .......................................................................................................................................... 28

Figure 21: Select Retain XML Location ........................................................................................................................ 29

Figure 22: Enter username .......................................................................................................................................... 29

Figure 23: Select Target Location for Promoted Objects ............................................................................................. 30

Figure 24: View Promoted Logs ................................................................................................................................... 30

Figure 25: View PDF Report ......................................................................................................................................... 31

Figure 26: Generate Retain List Process ...................................................................................................................... 32

Figure 27: Retain List ................................................................................................................................................... 32

Figure 28: Select Specific Activity Option .................................................................................................................... 33

Figure 29: Retain Activity Query Builder...................................................................................................................... 34

Figure 30: Activity Name Displayed in the Query Information Field ........................................................................... 34

Figure 31: Fields associated with a Service .................................................................................................................. 35

Figure 32: Select Field .................................................................................................................................................. 36

Figure 33: Select Delete Option ................................................................................................................................... 37



Figure 36: Enter username .......................................................................................................................................... 39

Figure 37: View Deployed Logs .................................................................................................................................... 40

Figure 38: Migration Actions ....................................................................................................................................... 41

Figure 39: Configuration Settings for Source Database ............................................................................................... 42


Figure 40: Configuration Settings for Target Database ............................................................................................... 43

Figure 41: Select Tables ............................................................................................................................................... 44

Figure 42: View Logs .................................................................................................................................................... 45

Figure 43: Offline Actions screen ................................................................................................................................. 46

Figure 44: Select Source System .................................................................................................................................. 47

Figure 45: Select Target Location ................................................................................................................................ 48

Figure 46: View Backup Logs ....................................................................................................................................... 48

Figure 47: Import Actions screen ................................................................................................................................. 49



Figure 50: Select Objects Screen ................................................................................................................................. 52

Figure 51: Select Configuration Files ........................................................................................................................... 53

Figure 52: View Restore Logs ....................................................................................................................................... 53

Figure 53: Sample backup.properties file .................................................................................................................... 57

Figure 54: Select the Accelerator zip ........................................................................................................................... 59

Figure 55: Select Target system Install Directory ........................................................................................................ 60

Figure 56: Configure the Login Credentials ................................................................................................................. 61

Figure 57: Accelerator Installation Completed ............................................................................................................ 61

Date post:	18-Aug-2020
Category:	Documents
Upload:	others
View:	0 times
Download:	0 times

Adeptia Suite 6.2 Migration Utility Guide · 9/24/2014 · Adeptia Suite 6.2 Migration Utility...

Documents