emc documentum xcp 2.x tips for application migration v1.1

!!Tips for Application Migration and Interoperability !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

Abstract This document addresses some of the common problems faced during Application migration. It covers other related topics like Type Adoption, Import types from Composer Projects, Interoperability and Reverse Interoperability.March 2014

Version 1.1

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!Copyright © 2014 EMC Corporation. All Rights Reserved.EMC believes the information in this publication is accurate as of its publication date. The information is subject to change without notice.The information in this publication is provided “as is.” EMC Corporation makes no representations or warranties of any kind with respect to the information in this publication, and specifically disclaims implied warranties of merchantability or fitness for a particular purpose.Use, copying, and distribution of any EMC software described in this publication requires an applicable software license.For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com.!

!

Tips for Application Migration and Interoperability � 2

Table of Contents Table of Contents 3

Application Migration 4

Type Adoption 7

Type Migration (Import Types from Composer Projects) 8

Interoperability 8

Reverse Interoperability 8


Application Migration Follow the procedure outlined below in order to migrate an application from xCP 2.0 to 2.1.!1. Export the application from xCP Designer 2.0: !

a. From the xCP 2.0 Designer Home screen se lec t an application and click the Export button.!

b. Select a target folder, check the Include all dependent projects checkbox and click the Finish button. !

2. If your application contains any libraries based on sub-projects you will first need to migrate them to 2.1 as follows:

a. Export the 2.0 library project used for packaging the library:I. In xCP Designer 2.0, select the project and click the Export button.II. Make sure the Export as a library checkbox is not checked.III. Click Finish.!

b. Start xCP Designer 2.1.!c. Create a new dummy application.!d. Import the project from step a. It is recommended to check the Import a copy

checkbox.!e. Select the project and click Export button.!f. Select a folder, and select the Export as a library checkbox.!g. Click Finish button.!

Repeat the previous steps for every library that contains xCP artifacts. These new JAR files can then be used a replacement library while importing an xCP 2.0 application which contains the original library.!

3. If you have other libraries such as a theme, or containing custom functions or widgets, then you need to manually edit the MANIFEST.MF file of the JAR as follows:!

a. Increment the Bundle-Version number and also update the JAR filename to match with the new version. If your Bundle-Version only has two digits then extend it to three (i.e.. 2.1.0 instead of 2.1)


b. The entry Bundle-SymbolicName must be prefixed with the value for NAMESPACE. e.g. if NAMESPACE is human, then Bundle-SymbolicName should be human.HumanizeJS.

c. If the original manifest had an entry similar to the following:Require-Bundle: xcpcore, xcpcommonsChange it to:Require-Bundle: xcp.xcpcore;bundle-version="2.1.0", xcpcomm.xcpcommons;bundle-version="2.1.0", xcpui.xcpui;bundle-version=“2.1.0"

d. Add the following line in the manifest:EMC-XCP-ExecutionEnvironment: com.emc.executionenvironment.xcp:2.1.0.RC2 As you patch your environment you will need to change the value RC2 to whatever build of designer that you are using.!

e. Make sure that there is at least one blank line at the end of the manifest file.! A sample updated MANIFEST.MF file is provided below:!

Manifest-Version: 2

Ant-Version: Apache Ant 1.8.2

Created-By: 1.6.0_32-b05 (Sun Microsystems Inc.)

Built-By: burnec3

Component-Bundle: SliderWidget

R e q u i r e - B u n d l e : x c p . x c p c o r e ; b u n d l e - v e r s i o n = " 2 . 1 . 0 " , xcpcomm.xcpcommons;bundle-version="2.1.0", xcpui.xcpui;bundle-version="2.1.0"

Bundle-Version: 2.1.0

Bundle-Name: Slider Widget

Bundle-SymbolicName: burnett.SliderWidget

NAMESPACE: burnett

EMC-XCP-ExecutionEnvironment: com.emc.executionenvironment.xcp:2.1.0.RC2

<don’t forget to leave at least one empty line at the end of the file>!4. Custom themes also need additional includes and imports at the beginning of the theme.

You can refer to the file common.scss which should be available to download alongside this white paper for details.You can either copy the entire set of imports into your themes .scss file but a better way of organising the theme is to add the file common.scss into your theme JAR file and import it from within your main .scss file.


In the example below there are three separate scss files in the JAR file:!colors.scss is a list of colour definitionscommon.scss is the list of imports that are neededeztheme is the main theme fileAt the start of eztheme.scss you add two imports:@import 'colors';@import 'common';!

5. Import the exported application to xCP Designer 2.1 as follows: !a. From the xCP Designer 2.1 home screen click the Import Application button.!b. Select the folder from Step 1.!c. Check the checkboxes next to the

application and all projects that belongs to it. !

d. Check the Import a copy checkbox.!e. Click the Next button.

!

f. If your application contains libraries, add the repackaged libraries from steps 2 and 3.!

g. Click the Finish button.!h. xCP Designer will restart in a new

workspace.!!


If you have an artifact library for which the source project is not available, then you can try following step 3 above, updating the manifest file, but it might cause issues if it contains artifacts which need to be migrated for 2.1. For example, ECM Action Flows have changed from 2.0 to 2.1, and so if such artifacts in the library are not upgraded, then they are likely to give errors during runtime.

Custom widgets might break during migration because xCP 2.1 now uses ExtJS 4.2. You will need to test and possibly update them to ensure compatibility.

When migrating an application from an early access version of the 2.1 Designer sometimes the ECM Page Fragments (Create Folder, Import and Import New Version) may not load in the corresponding action flows at runtime as there are issues in the system name generation and you many need to manually correct this.

Type Adoption 1. Type adoption allows users to adopt

ex i s t i ng ob jec t t ypes f rom a Documentum repository to xCP Designer. !

2. Using type adoption, xCP 2.1 applications can read or write data i n s t a n c e s c r e a t e d t h r o u g h Documentum clients, such as xCP 1.x, Documentum Administrator, Webtop, and TaskSpace.

3. Similarly, Documentum clients can read or write new instances of adopted types created in xCP 2.1 applications. !

4. You can adopt only subtypes of dm_sysobject, dm_document, and dm_folder data types.!

5. If adopted data type is inherited from another data type, all of the super types are also adopted.!

6. Types can be adopted only once (after which they will not get listed again for adoption)

!


Type Migration (Import Types from Composer Projects) 1. Type Migration allows users to import object types previously defined in Composer into xCP

Designer.!2. The imported type can be modified and treated exactly like any other type.

!

Interoperability The following known limitations exist:!1. xCP 2.x does not honour the entire data dictionary, which includes value assistance,

attribute label internationalisation, constraints etc.

Reverse Interoperability The following know limitations exist:!1. Business events will not be supported by D2.!2. Process variables will not be supported by D2.!3. Process initiated from xCP cannot be executed further through D2 and 1.x Clients.!4. Process Interoperability is not supported.!5. xCP 2.x processes are not interoperable with 1.x clients. That means clients like Webtop

and TaskSpace are not be able to complete workflows created in 2.x.!6. Aspects defined for an xCP type are not supported in 1.x.!!!!


emc documentum xcp 2.x tips for application migration v1.1

Software