CrownPeak Translation Model Framework. Version 0.91

Transcription

1 CrownPeak Translation Model Framework Version 0.91

2 2014 CrownPeak Technology, Inc. All rights reserved. No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopy, recording, or any information storage and retrieval system, without permission from CrownPeak Technology. Document History Author/Editor Date Reason for Change Version Greg Aimone 12/10/2013 Draft 0.90 Jason Yoo 3/10/2014 Add TMF Configurations 0.91 CrownPeak Technology 2

3 Table of Contents CrownPeak Translation Model Framework Overview... 4 Translation Model Framework Benefits... 4 Business Process Guide for the TMF Configuration... 5 Configuring the TMF... 5 Core Configuration... 6 Backend Configurations... 9 Using TMF to Manage Content Notes and Additional Information Implementation Guidelines CrownPeak Technology 3

4 CrownPeak Translation Model Framework Overview The Translation Model Framework (TMF) is a collection of templates created and managed by CrownPeak Professional Services that provides the CrownPeak authoring community the ability to manage multi-lingual content within a site, or localization activities across sites. CrownPeak subscribers that have any of the following needs, should consider leveraging the CrownPeak TMF in their next initiative: Managing sites of a multi-lingual nature (i.e. English and Spanish versions of the US site) Managing sites with similar content and structure, that will be localized for each regional deployment (North America site, Canada site, Mexico site) Managing content that has a single point of origination, with requirements to derive and deploy multiple versions of the content. The CrownPeak Translation Model Framework provides features that enable content teams to effectively leverage their investment in CrownPeak to meet these challenges. Translation Model Framework Benefits The TMF feature: Can be added to any existing CrownPeak configuration at any time. Enables effective collaboration between content owners. Provides notifications when master content has changed. Provides authors the ability to review change in the master content, for incorporation into their derived content set. Provides the ability to selectively send content out to a translation service. Can be used with a variety of translation services, or supports localization by regional content owners. CrownPeak Technology 4

5 Business Process Guide for the TMF Configuration The Translation Model Framework can be configured to support many different processes. Before starting the configuration, it is beneficial to solidify the scope of the configuration. What will the master content be? Will it be the US-English site for the corporate site? How will the content be translated/localized? Is it the whole site, or just parts of the site? Are there URL considerations for these sites (mysite.com/us-en mysite.com/us-es vs. mysite.com/en mysite.ca/en mysite.ca/fr) How will the translation/localization happen? Will in-region personnel provide the translation, or will an external service be involved? If a service will be involved, is there an existing business relationship between the customer and the translation service provider, or will contracts need to be established? If a service will be involved, will they exchange content electronically (as do all the Service Providers listed in the CrownPeak marketplace)? Can the standard workflow be extended to support the translation process? For example, all DRAFT content can be selectively (or automatically) sent out for translation as a part of the workflow steps. When localized content is received, the workflow can advance requesting review. How will the process for the initial content migration be different from ongoing content updates? For example, all of the US EN content Configuring the TMF Once the Business Process is understood CrownPeak will confirm the TMF Design with the customer. CrownPeak will confirm the workflow configuration changes for Translation states CrownPeak will confirm the alerts/notification configuration for authors CrownPeak will confirm the extent of the template changes for Translation formats CrownPeak will confirm the extent of the publishing packages and jobs for processing Translation files CrownPeak will work directly with the translation service provider to Confirm Inbox/Outbox file processing Confirm XML formats for Inbox/Outbox processing CrownPeak will add the TMF templates into the configuration from the Professional Services Library. CrownPeak will configure the TMF per project specifications, and will conclude with the User Training and Acceptance Testing Once the Business Process is understood, configuring the TMF will be configured in the following way: TMF Library - The following classes need to be created in /System/Library/ directory. Please make sure to create CrownPeak Technology 5

6 TMFGeneralFunctions.cs first since most of the core functions live in TMFGeneralFunctions.cs and other library files are using them. TMFGeneralFunctions.cs TMFInput.cs TMFOutput.cs TMFPostInput.cs TMFPostSave.cs Core Configuration TMF Library Create TMF configuration folders/files in /System/Translation Model Framework directory - Templates, Models, and Assets are core configuration that power the TMF. _Assets JS, CSS, Images _Templates TMF Configuration Folders CrownPeak Technology 6

7 TMF Assets Auto Link Locales (input.aspx, output.aspx) Country Sites Config (input.aspx, post_input.aspx) Global TMF Config (input.aspx, post_input.aspx, post_save.aspx) Languages (input.aspx, post_input.aspx) Locale Config (input.aspx, post_input.aspx) Relationship Config (input.aspx, post_input.aspx) Templates Config (input.aspx) Translation Rules (input.aspx, post_input.aspx) _Models CrownPeak Technology 7

8 TMF Templates Model Template Path Country Site /System/Translation Model Framework/_Templates/Country Sites Config Language /System/Translation Model Framework/_Templates/Languages Locale /System/Translation Model Framework/_Templates/Locale Config Relationship /System/Translation Model Framework/_Templates/Relationship Config Translation Rule /System/Translation Model Framework/_Templates/Translation Rules Note: The latest version of the library classes/templates are available on Diageo instance. TMF library will be part of the CrownPeak Services Library soon. Setup Global Configuration (/System/Translation Model Framework/Global) Countries and Languages need to be pre-defined in order to add in each site. Country Sites Languages CrownPeak Technology 8

9 Backend Configurations There must be a _TMF folder in the site directory. _TMF folder should contain the following folders: TMF Directory Folders Country Sites Config - Countries are not just limited to "countries", but in fact can be used to define any geographical region, such as state (CA, NY, etc), continent (North America, Europe), political regions (Middle East, Indian SubContinent), etc. Globally configured countries will be available in this folder. Languages Config - Languages describe the language(s) available for the TMF to manage. Globally configured languages will be available in this folder. Locales Config - A locale is a relationship of a Language and Country, and more importantly the actual content in the CMS to be identified as belonging to that Locale. Relationships Config - TMF stores information about master/derived relationships and master history for each asset. There is no need to manually create or change any assets in this folder. CrownPeak Technology 9

10 TMF Config Auto Link Locale - This asset allows administrators to perform initial TMF setup and create relationships between selected locales based on the CMS Folder Structure. The TMF will loop through all the assets in the Source Locale folder, search for matching assets in Destination Locale folder and create relationship if matching asset is found. Templates Configuration - This configuration asset allows you to select which templates and fields will be processed by the TMF. Folder Model Country Sites Config /System/Translation Model Framework/_Models/Country Site Languages Config /System/Translation Model Framework/_Models/Language Locales Config /System/Translation Model Framework/_Models/Locale Relationships Config /System/Translation Model Framework/_Models/Relationship Note: The listed models should be applied to each folder. Asset in TMF Config Folder Template Auto Link Locale /System/Translation Model Framework/_Templates/Auto Link Locale Templates Configuration /System/Translation Model Framework/_Templates/Templates Config Install TMF For the TMF to work properly, input/output/output_changes/post_input/post_save template files must contain TMF include code. input.aspx - TMFInput.LoadInput(asset, context); output.aspx - TMFOutput.LoadOutput(asset, context); output_changes.aspx - TMFOutput.LoadMasterAssetChanges(asset); post_input.aspx - TMFPostInput.LoadPostInput(asset, context); post_save.aspx - TMFPostSave.LoadPostSave(asset, context); (Optional) Configuring Translation Service Provider CrownPeak Technology 10

11 CrownPeak Technology 11

12 Using TMF to Manage Content Once the configuration is complete, CrownPeak will conduct user training as a part of User Acceptance testing. CrownPeak will review the TMF in the context of the business process, confirming the proper operations for: Country/Region Configuration Language Configuration Locale Configuration, and Content Folders and Owners Workflow Alerts Integrations with the Translation Service Provider Applying Changes to the Master Content Approving Translated Content Declining Translated Content Declining a request to Translate Content Any issues or additional changes requested will be processed as a part of the final configuration tuning. Once the User Acceptance Testing is completed, normal operations will commence, the configuration project will end, and operations will be supported by CrownPeak s Absolute Service team. Notes and Additional Information More information can be found: The Translation Model Framework whitepaper Using the TMF webinar recording Implementation Guidelines In general, a TMF project takes about hours to configure from a business process specification. Gathering the business requirements may take as much as 16 hours depending on documentation levels required. UAT and tuning the configuration may add 16 hours to an existing UAT, or may require 24 hours for a stand-alone configuration as: 8 hours of training, 16 hours of support across a 5 day UAT window. CrownPeak Technology 12