Wednesday, November 7, 2012

Arabic RTL eInput Kit


 Overview

What is a Kit?

An kit is an add-on or a modification of an EMC2 Documentum xCelerated Composition Platform (xCP) solution. This modification can be a new functionality, an enhancement, a bug fix or a change in the presentation. These are considered to be Xerox Emirates intellectual property. An example of an kit includes but not limited to:
·         A code snippet or a configuration batch
·         An add-on to a Documentum client application
·         An application
·         A language pack to an application with alignment handling

eInput Arabic RTL Kit

eInput Arabic RTL Kit is a reconstruction of eInput 2.1 web application. This release includes an Arabic language pack of localized strings as well as a change in the alignment of the interface. If the chosen language of the application at run time is Arabic, the alignment will be set to RTL, otherwise LTR. This kit includes two components: the “eInput” stand-alone Arabized project and a WDK component to handle accessing the application.

Bill of Materials

The Kit will be found in a zip file called “eInput_arabic_RTL.zip”. The compressed file will contain the following:

Artifact                         File Name
Installation Guide          arabic_eInput_installation_and_configuration_guide.pdf
eInput application files  eInput_ar.zip
WDK component           eInput_wdk.zip


Table 2 - Bill of Materials

 

Installation

Compatibility Issues

This release was developed for eInput 2.1 running on a Captiva 6.5 Server. The WDK component can be used with any eInput version while the release is specific for eInput 2.1 only. Deployment of the kit in other contexts might succeed but has not been tested by the development team and therefore won’t be supported.

Installation Scope

Depending on the functional requirements of the user, the kit can be used partially or fully. The two main components of this kit are scoped as follows:

Component
Scope
eInput_ar
The modified web application to give the user the ability to set the language by accepting a parameter value.
eInput_wdk
A simple WDK component that will show the application inside a Documentum client.
Table 3 - Installation Components
Note: The second component is dependent on the first but not vice versa.

Deployment

In order to deploy the kit and have the Arabic language functionality you need to do the following:
1.     Deploy the eInput_ar project on the application server.
a.     Extract the contents of the zip file.
b.    Navigate through the web applications of your application server.
c.     Copy and overwrite the folder “eInput” with the folder provided from the extracted zip folder.
d.    Delete the application server’s cached data (i.e “tomcat -> work -> catalina”)
e.     Restart the application server.
2.     Deploy the WDK component in your Documentum client application.
For further information on how to deploy customized WDK components please refer to the document: EMC Documentum Web Development Kit

   

 Configuration

Configuring Language Manually

The modified web application expects a parameter of name “lang” and value “en” or “ar” representing English language or Arabic language respectively. So the address has been updated to meet the following syntax:
http://<dns>:<port>/eInput/scan.jsp?lang=<language>
Where language is “ar” or “en”.
In case the parameter “lang” was passed another value or was not even passed at all, the application will use English as the default language and will set the alignment to LTR.

WDK Component Configuration

You will need to provide the server address passed in the iFrame and make it point to the application server at which eInput is deployed.



 Known Issues

Open Issues

The user should not consider updating the software unless there is a supported Arabic Kit to the newer version. In the case of updating to a non-supported version, the language Kit will be lost but the WDK component will be expected to work properly after proper configuration.

Digital Asset Manager Arabic Language Kit


What is a Kit?

A Kit is an add-on or a modification of an EMC2 Documentum xCelerated Composition Platform (xCP) solution. This modification can be a new functionality, an enhancement, a bug fix or a change in the presentation. These are considered to be Xerox Emirates intellectual property. An example of a Kit includes but not limited to:
·         A code snippet or a configuration batch
·         An add-on to a Documentum client application
·         A language pack to an application with alignment handling

Digital Asset Manager (Arabic) Kit

This Kit includes a pack of Arabic language localized strings (NLS) files. Adding the pack to the Digital Asset Manager application will give the user the ability to view the application with Arabic labels. This pack is similar to any other language pack provided by EMC2 or a third party.

Bill of Materials

The Kit will be found in a zip file called “dam_ar.zip”. The compressed file will contain the following:

Artifact                         File Name
Installation Guide          Digital_asset_manager_arabic_pack_deployment_guide
Nls files                       dam_NLS_files.zip

Compatibility Issues

This pack was created to serve an Arabized presentation of DAM 6.7 and has gone through a circle of testing and quality assurance. The usage of this pack with other versions might but not supposed to work.

Deployment

1.     Extract the language pack zip file to a temporary directory.
2.     Copy and overwrite the extracted folder to “dam” folder under the web applications folder of your application server.
3.     Stop the application server and delete the cache on it.
4.     Navigate to the folder “wdk” under the dam folder.
5.     In a text editor, open the app.xml file and add the following locale under <supported_locales> :
<locale>ar_AE</locale>
so you will get :
<supported_locales>
     <locale>en_US</locale>
     <locale righttoleft=”true”>ar_AE</locale>
</supported_locales>
6.     Start the application server



Open Issues

The user should not consider updating the software unless there is a supported Arabic Kit to the newer version. In the case of updating to a non-supported version, the language Kit will be lost.


where to get it
from Xerox Emirtates.



xCP 2.x RTL



During software installation the installer will ask whether to deploy the default local or to use the localization engine, which will be installed along with the software. By default, the Arabic language local will be used. Since different applications create different locals, the out of the box Arabic local will cover super types and their pages only. Later on, the localization engine will start translating the created pages of other inherited object types. This process will cover up to 85% of the application local. The remaining labels will be translated through a user interface that will appear after the installation of the software is done.  The localization engine is an independent tool that will run in a background mode during installation or can be run manually at any time of the application development. This is to make sure the localization process is dynamic.




The software will also give the option to choose the alignment of the user interface (“LTR” or “RTL”). If the alignment is set to “RTL”, the software will update the application by adding a condition of changing the UI alignment whenever the localized language is detected at runtime. A separate configuration window is available within the software to revert changes.





The software is packaged as one component and can be installed through a windows installer. The package consists of three components:
1.    Localized NLS files
2.    The Localization engine
3.    The alignment tools (Cascade Style Sheets(css) + Java Script)