Migrating the translated user interface elements of your case management application

You can migrate the translated user interface in your case management application by exporting translated artifacts from the source domain and deploying them in the target domain.

Procedure

To migrate the translated user interface elements of your case management application to another target environment, complete the following steps:

  1. Export or generate versions of the translated solution artifacts:
    Option Description
    Content-related artifacts: Property templates, choice lists, document classes, case types, and activities Use IBM® FileNet® Deployment Manager to export the translated assets that are managed by the Content Platform Engine in the target object store:
    1. Create an export manifest and add property templates, choice lists, and class definitions, including case types and document classes and activities. Set the Include Options to none.
    2. Export the assets.
    3. Create a compressed file to use as a deployment package.
    Be aware of the following situations:
    • If your solution exposes all of the document classes in the target object store in case client, you must translate all document classes. If your solution is configured to expose only the document classes that are defined in your solution, then translate only those document classes.
    • You need to translate only discretionary activities. Automatic or manual activities do not use translated names at run time by design.
    Form templates and localization proxy document Use IBM FileNet Deployment Manager to export translated assets that are managed by the Content Platform Engine in the target object store:
    1. Create an export manifest with the translated form template documents and localization proxy document.
    2. Export the assets.
      Tip: If the translated assets exist in the same object store folder as the originals, you can export the entire folder. Use the IBM FileNet Deployment Manager Include Options to include all of the folder contents. If you want to manage the translated forms separately from the originals, then create a separate export manifest for the translated forms.
    3. Create a compressed file to use as a deployment package.
    Process-related artifacts Create a compressed file that contains the PEAuthoredNames.jar file, which is in the ICN_install_path\ECMClient\configure\explodedformat\navigator\WEB-INF\lib folder.
    Page and view artifacts Translated pages and view resources are included in the solution package when you export the solution.
  2. By using the IBM Administration Console for Content Platform Engine, browse to the design_object_store/IBM Business Automation Workflow/Solutions/solution_name folder.
    1. Create a subfolder of any valid name in this folder, such as NonICMAssets, if the subfolder does not exist.
    2. Add all of the compressed files that contain the exported translations to the design_object_store/IBM Business Automation Workflow/Solutions/solution_name/NonICMAssets folder in the source environment design object store.
      Add each compressed file as a separate document object and check in as major version.
  3. By using the IBM Business Automation Workflow administration client, export your solution from the source domain.
    The compressed files that contain the translations are checked into the solution folder, so the exported solution package contains the translations.
  4. Using the IBM Business Automation Workflow administration client, import your solution into the target domain.
  5. Deploy the solution to the target environment in the target domain.

    When you design and create a solution, you must decide what the solution locale is. The solution locale refers to the locale of display names, such as case properties, case types, activities, and other solution artifacts that you create with Case Builder. When you deploy the solution to a target environment for the first time, you must deploy the solution under the same locale to ensure that the display names are preserved.

    If you use Case Builder to deploy the solution, change the browser locale.

    If you use the Case administration client to deploy the solution, change the browser locale or change the application language value in the Change Language and Locale Settings window.

    If you use the Case configuration tool to deploy the solution, change the JVM locale in which the Case configuration tool runs. Edit the configmgr.ini or configmgr_cl.ini file in the ICM_install_dir\configure folder and change the nl value to specify your language locale. The default value is en_US.

  6. Deploy any assets that are not part of IBM Business Automation Workflow into the target domain that is used by your solution.
    If a single deployment package contains the original and translated form templates and localization proxy document, deploying these other assets also deploys those translated form assets.
  7. By using the IBM Administration Console for Content Platform Engine, browse to the IBM Business Automation Workflow/Solutions/solution_name/NonICMAssets folder in the design object store in the target domain. Download the translated artifacts.
  8. Deploy the translated artifacts of your solution to the target domain.
    Option Description
    Content-related artifacts: Property templates, choice lists, document classes, case types, and activities Use IBM FileNet Deployment Manager to import the deployed data set that contains the property templates, choice lists, and class definitions. Import into the target object store that the solution was deployed to. In the import wizard, choose following import options:
    • Standard Options: Select Import Object ID, leave all other options unselected
    • Update Options: Update if newer or Always update
    • Create Options: Never create
    • Property Update Options: Update only localized properties for class definitions, property templates, and choice lists
    Form templates and localization proxy document Use IBM FileNet Deployment Manager to import the translated form templates and localization proxy document into the target object store that the solution was deployed to. If the deployment package also contains the original form templates, you can skip this step. The previous step of deploying non-IBM Business Automation Workflow assets also deployed the translated form templates and localization proxy document
    Process-related artifacts
    1. Extract the compressed file that contains the PEAuthoredNames.jar file.
    2. Open the PEAuthoredNames.jar file to retrieve the XLIFF files.
    3. Rename the PEAuthoredNames_sourcePERegionID_lang.xliff file to PEAuthoredNames_targetPERegionID_lang.xliff. PERegionID is the region ID of the Content Platform Engine, which you can find by using the process configuration console, and lang is the two letter language code.
    4. Repackage the PEAuthoredNames.jar file:
      1. Create a staging directory. For example,C:\temp.
      2. Create the destination directory for the XLIFF files in the staging directory. For example, C:\temp\XLIFF.
      3. From the destination directory, create the PEAuthoredNames.jar file. For example, jar -cvf PEAuthoredNames.jar *.xliff
    5. Add the PEAuthoredNames.jar to the ICN_install_path\ECMClient\configure\explodedformat\navigator\WEB-INF\lib folder.
    6. Run the Build the Web Application task and Deploy the Web Application task from the IBM Content Navigator configuration and deployment tool.
    Page and view artifacts Translated pages and view resources are included in the exported solution package. They are deployed to the target environment by deploying the solution.
  9. Restart the web application server in which IBM Business Automation Workflow is deployed in your target domain, and then redeploy your solution.