Docu51365 White Paper Type Adoption in xCP Applications

8/21/2019 Docu51365 White Paper Type Adoption in xCP Applications

1/12

White Paper

AbstractThis white paper explains adopting types from repository,editing and using them in xCP applications.

December 2013

TYPE ADOPTION IN xCP APPLICATIONSAdopting types from repository to xCP applications


2/12

Copyright 2013 EMC Corporation. All Rights Reserved.

EMC believes the information in this publication is accurate asof its publication date. The information is subject to changewithout notice.

The information in this publication is provided as is. EMCCorporation makes no representations or warranties of any kindwith respect to the information in this publication, andspecifically disclaims implied warranties of merchantability orfitness for a particular purpose.

Use, copying, and distribution of any EMC software described inthis publication requires an applicable software license.

For the most up-to-date listing of EMC product names, see EMCCorporation Trademarks on EMC.com.

VMware is a registered trademarks of VMware, Inc. in the UnitedStates and/or other jurisdictions. All other trademarks usedherein are the property of their respective owners.

Part Number h12702

2Type Adoption in xCP Applications


3/12

Table of ContentsExecutive summary 4

Audience ............................................................................................................................ 4Overview 4

Adopting types to xCP 2.x Applications ............................................................................... 4Editing and configuring Adopted Types ............................................................................... 9The Runtime behavior ....................................................................................................... 12

References 12



4/12

Executive summaryThis preliminary white paper provides detailed overview of adopting types to xCP applications.It explains adopting types from repository, editing, using them in Processes, creating pages andother required artifacts within the application, deploying them and runtime behavior of adopted

type instances.

AudienceThis white paper is intended for application designers who design applications usingxCP Designer. It assumes that reader possess basic knowledge of xCP.

OverviewType Adoption allows xCP 2.1 applications deployed in the Content Server to takeadvantage of the most important assets the content and type definitions in a

repository. Using Type Adoption, xCP 2.1 app will read or write data instances notcreated through xCP clients but adopted in the xCP Designer. Similarly, new instancesof adopted types created in xCP 2.x applications can be read or written through otherclients like DA, Webtop, Taskspace etc. Thus, Type Adoption provides interoperabilityin between older Documentum Clients like xCP 1.x, Webtop, MyD and 2.x clientapplications in accessing data instances.

Type Adoption should be considered when

You already have a good xCP1.x application running but want to upgrade to D7platform and build new apps using xCP 2.x for improved user experience withboth xCP 1.x and 2.x sharing the data.

Have to use the features in xCP2.x to fulfill the new business needs withoutany data model refactoring from xCP 1.x. Build new xCP 2.x application asreplacement for 1.x application.

Adopting types to xCP 2 x ApplicationsOnly the sub types of dm_sysobject, dm_document and dm_folder can be adopted by xCPapplication. Types are adopted by importing them from repository to xCP application. In thisprocess to connect to repository, a Design-time Environment configuration is required. To adoptthe types use the Adopt Data Type(s) option from Object Model tab.



5/12

Choosing Adopt Data Type(s) will prompt a wizard to adopt the types from repository to theapplication. This process starts with selecting Design-time Environment .



6/12

Choose the appropriate Design-time Environment from where types have to be adopted.

Clicking on Next after choosing an appropriate Design-time Environment, will take to next stepImport Data Type(s) to Target Project. Select the types to be adopted, the target project andclick on Finish to complete the adopting.



7/12

Clicking on Finish button will show the confirmation dialogue Adopt Data type[s]Confimation on which types have been adopted successfully and not adopted.



8/12

Adopted types will be seen Object Models view according to their category.



9/12

It would create object models with label value that been provided during typecreation. For example, if type loan_customer has been created with label Loan

Customer (this value stored in label_text attribute of dmi_dd_common_info objectfor type loan_customer) and when this type has been adopted to xCP Application,the object model will be created with Loan Customer as label and loan_customeras system name.

If label is not provided during type creation, it would use the default label values setby Content Server. The default values are according to Documentum super type of thetypes. For sub types of dm_sysobject, it would be Sysobject. For sub types ofdm_content, it would be Document. And for sub types for dm_folder, it would beFolder. When multiple types which dont have label values or same label valuesadopted at a time, error(s) might be shown in Problems tab of xCP Designer asmultiple object model may have same label . In such instances, designer shouldchange the object model label values in appropriate manner to fix the error.

If a type which inherits from other types in repository is adopted, all of its super typeswill also be adopted by default. For example, if the type premium_customerinherited from type privilaged_customer which in turn inherited from typecustomer, adopting the type premium_customer would result in adopting its supertypes privilaged_customer and customer.

Since xCP Designer doesnt support having DQL reserved words (mentioned in DQLReference Manual) as attribute names for types, types which contains DQL reservedwords as attribute names cant be adopted to xCP Applications unless attributenames are changed.

The Documentum fundamental types dm_sysobject, dm_document anddm_folder cannot be adopted.

Editing and configuring Adopted TypesOnce the types are adopted to the project, they are like any other types created in xCP Designer.They can be modified to add or remove attributes, relationships with other types can becreated, and type fragments can be attached. Permission sets can be applied.An object model being created in xCP Designer can be inherited from an Adopted Object Model(type). Relationships can be created from adopted types to adopted types, adopted types tothe regular types and regular types to adopted types.Picklists can be added to adopted types



10/12

And Business Events can be configured for Adopted types.

Pages for create, update and view operations, object selectors, action flows, page fragmentsand context menus can be created. If Adopted Type being Content, Import actions can beconfigured



11/12

Adopted Types can be used in Processes as packages or attachments. Real Time, Full Text andHistorical queries can be created for Adopted Types. Task List queries can be created withAdopted Types attributes in Data Set if it is being used as package.

Note: System Name of adopted type represents the actual type name from the repository and itcant be changed in the xCP application. xCP does not honor the entire data dictionary, whichincludes value assists, attribute label internationalization, constraints etc..

Deploying Adopted TypesAdopted types deployed along with other object models to the repository ondeploying the xCP Application to which they have been adopted. If the adopted typedoesnt exist in target repository, it would create the type and publish it. If theadopted type already exists in the target repository, it alters the type and publishes itif there are any changes to it. Otherwise, type in the target repository remainsunaltered. Like any other types created within xCP Designer all the rules of differentData Policies are hold good for Adopted Types as well. If Data Policies other thanMINIMAL or MAINTAIN are used, all the existing instances will be deleted. It is alwaysbest practice to use MAINTAIN data policy when deploying to avoid data loss.

From now on Business Events and Alerts will be triggered even if the instances ofadopted type is modified outside of xCP client



12/12

The Runtime behaviorOnce the Adopted Types are deployed, the existing instances of Adopted Types will behave

same as new instances created within or outside xCP clients. All the older instances will beretrieved along with newly created instance after the deployment of adopted types when a realtime query is used. They can be viewed, edited and deleted. New instances can be created.Alerts, Business Events will be triggered on such operations if they are configured. Both old andnew instances can be related with other object instances using relate action.They can be attached to Packages or Attachments during workflow actions

ReferencesDocumentum Content Server DQL Reference ManualDocumentum System Object Reference Manual


Documents

Docu51365 White Paper Type Adoption in xCP Applications