CWCM. CWCM: XSL Migration. Version /07/ of 9

Transcription

1 CWCM CWCM: XSL Migration Version /07/ of 9

2 DOCUMENT HISTORY Version Date Author Description Action (*) Confidentiality Pages /04/2010 IDS Creation C High /12/2010 IDS Aligned version history U High /07/2012 IDS Changed to template EC 2012 U High NA (*) Action: C= Creation, I=Insert, U=Update, R=Replace, D=Delete 2 of 9

3 TABLE OF CONTENTS 1. Description 4 2. The new implementation of the crumbtrails Context Introduction Impact of the new object model Adapting your XSL files to the new implementation of the crumbtrails Cases 1 and 2: XSL templates and Java methods Case 3: using your own DQL queries Conclusion 7 3. The category external IDs Context Adapting your XSL files 8 4. Annex 1: excerpts from UM.custom.xslbestpractices 9 3 of 9

4 1. DESCRIPTION This document has two objectives. The first one is to describe how and when to migrate your XSL files in order to take into account the modification of the implementation of the crumbtrails. The second one is to include recommendations for the migration of category r_object_id s which are hard coded in your XSL files, to category external IDs. 4 of 9

5 2. THE NEW IMPLEMENTATION OF THE CRUMBTRAILS 2.1 Context Introduction In order to accommodate the addition of new languages to the CWCM system by the data center, the CWCM object model was updated. These modifications were performed in the context of the work package 70 ( Data Model Migration ). Before the implementation of this new object model the crumb trail for language XX was stored in attribute crumb_xx. As many attributes crumb_xx exist as languages. In the new object model two new repeating attributes are available on the eu_subsite objects: eu_crumbtrail_lang: contains a list of languages. eu_crumbtrail: contains the crumb trails. The language of the crumb trail on position j is stored in the attribute eu_crumbtrail_lang on position j. When the crumb trails on a subsite are updated the attributes crumb_xx, eu_crumbtrail_lang and eu_crumbtrail are updated in order to keep the values synchronized between the old and new attributes: when a crumbtrail is added, modified or removed (in the new implementation), its counterpart in the old implementation is also added, modified or removed when it is possible to do so Impact of the new object model With the introduction of CWCM V3 the old attributes are discarded, and it will be no longer possible to use them. Until then, the old and the new attributes will co-exist in the object model. Therefore, you should adapt your XSL files to remove the dependencies on the old object model, i.e. explicit DQL queries on the crumb_xx attributes of eu_subsite. In the next section we will explain if you have to adapt your XSL files and how to adapt them, if necessary. 2.2 Adapting your XSL files to the new implementation of the crumbtrails The breadcrumb for an XML document is displayed in the way specified in its associated XSL file. There are basically three ways to display the bread crumb: 1. with one of the XSL templates that display the breadcrumb, like the XSL template crumbtrail. Refer to the UM.custom.xslbestpractices manual for more information; 2. with your own XSL template that calls one of the crumbtrail Java methods, like getcrumbtrailxml and getsubsiteattributesxml. Refer to the UM.custom.xslbestpractices manual for more information; 3. with your own XSL template that uses one or several DQL queries to fetch the crumbtrails information. You must adapt you XSL files if the crumbtrail information is retrieved with a DQL query. 5 of 9

6 2.2.1 Cases 1 and 2: XSL templates and Java methods In this section we will list the crumbtrail related Java methods which you can continue to use for the retrieval of crumb trail information. We will also mention in which XSL template and in which common XSL file these methods are located. Please note we will mention only the location of the methods in the common XSL files at the root of the domains (unless explicitly stated otherwise). If you are only using the Java methods or XSL templates listed in this section to retrieve the crumb trail information you can continue to use your XSL files and no migration is required getcrumbtrailxml methods The method getcrumbtrailxml and its variants are safe to use: getcrumbtrailxml($eu_document_proxy, maxdepth, maxlength) getcrumbtrailxml($eu_document_proxy, maxdepth, maxlength, validateindex) where validateindex is a Boolean value (true or false) getcrumbtrailxml(($eu_document_proxy, maxdepth, maxlength, testmode) where testmode is a string. These methods are used in the following XSL templates which are also safe to use: the XSL template "crumbtrail" in /xsl-common/ec.europa.eu/header_footer_europa.xsl the XSL template "crumbtrail" in /xsl-common/europa.eu/header_footer_europa.xsl the XSL template "crumbtrail" in /xsl-common/publications.europa.eu/header_footer_europa.xsl the XSL template "crumbtrail" in /xsl-common/ the XSL template "crumbtrail" in /xsl-common/ the XSL template "crumbtrail" in /xsl-common/header_footer_europa.xsl getcrumbtrail methods The method getcrumbtrail and its variants are safe to use: java:com.fujitsu.eu.wcm.presentation. CrumbTrail.getCrumbTrail($CRUMB, themaxdepth, themaxlength, thecurrentdocid, thedoclanguage, thesessionid) and 6 of 9

7 java:com.fujitsu.eu.wcm.presentation. CrumbTrail.getCrumbTrail($CRUMB, currentdocid, doclanguage, sessionid) $CRUMB is an instance of the class com.fujitsu.eu.wcm.presentation.crumbtrail These methods are used in the following XSL templates which are also safe to use: the XSL template "breadcrumb" in /xsl-common/ buildsubsiteattributes method The method buildsubsiteattributes and its variants are safe to use: getsubsiteattributesxml($eu_document_proxy) and getsubsiteattributesxml($eu_document_proxy, folderpath) The method and its variants are not explicitly used in one of the common XSL files Case 3: using your own DQL queries If your XSL templates are fetching the crumb trail information with some DQL or XDQL queries on the crumb_xx attributes for one or several languages, you must adapt your XSL files. If you don t adapt your XSL files your web site will probably stop working when CWCM V3 is rolled out. Eventually, no HTML renditions or wrong HTML renditions are generated and published. To migrate your XSL files you should replace all DQL or XDQL queries on the crumb_xx attributes of eu_subsite in your XSL files by one of the Java methods or XSL templates in section Cases 1 and 2: XSL templates and Java methods on page 6. The amount of migration work depends on the way how your XSL files process the results of the DQL or XDQL query. 2.3 Conclusion In practice, you should adapt your XSL files only in the following case: One or several XSL templates uses one or several DQL or XDQL queries to retrieve the crumb_xx attributes of your subsites. 7 of 9

8 3. THE CATEGORY EXTERNAL IDS 3.1 Context In some situations it is necessary to hard code a category s r_object_id in your XSL style sheets. For instance, consider the following example, which defines an XSL variable for the category s r_object_id: <!-- ID of category FOCUS --> <xsl:variable name="category_id_focus "> cef</xsl:variable> The use of the hard-coded category r_object_id makes the portability of the XSL style sheets between docbases difficult. As the Documentum repository assigns the r_object_id automatically and implicitly, the r_object_id of the category in the target docbase will certainly differ. As an implication, the XSL style sheet must be updated to reflect the new category s r_object_id, when the XSL is copied to another docbase, like a copy from the wcmplay docbase to the wcmcom docbase. The CWCM supports the encoding of a so-called external ID for a category, which is a string representing a logical identifier for the category and which you can provide. The CWCM system will check whether the external IDs of categories are unique inside one category linkgroup. Instead of using the category s r_object_id to refer to a category you should use the category s external ID to reference the category. We will explain the migration steps in the next paragraph. 3.2 Adapting your XSL files To use the external ID of a category instead of encoding directly the r_object_id, a new XSL method is provided; getlinkobjectids. It will retrieve the r_object_id of the category from its external ID. If we provide for the category in the previous example the external EXTID_FOCUS, and assume that the linkgroup lg_id of this category is 12345, we replace the definition of the variable category_id_focus with the following construction: <! Use the EXTERNAL ID category FOCUS to retrieve its r_object_id --> <xsl:variable name=" category_id_focus " select="java:getlinkobjectids($eu_document_proxy, 12345:EXTID_FOCUS )"/> The parameter of this java extension function represents the identifier of the category: the lg_id ( in this example) and the external id ( EXTID_FOCUS ) of the requested category separated by colon :. For more details related to the usage of the getlinkobjectids java extension function, see its description in the manual UM.custom.xslbestpractices. 8 of 9

9 4. ANNEX 1: EXCERPTS FROM UM.CUSTOM.XSLBESTPRACTICES The document UM.custom.xslbestpractices contains several XSL templates and methods related to crumbtrails: The template crumbtrail The method getcrumbtrailxml The method getsubsiteattributesxml 9 of 9