Set a status for documents that are retranslated from source

You can now specify the status that documents will be in after a Retranslate from source operation, which reverts the content of one or more objects to the original source language.

This feature applies to the Sequential Localization Manager only.

The following list summarizes the steps required to implement this feature:
  • Configure the status in the localizationManagers.xml file.
  • Add the status in the following workflow files:
    • topic_status.xml
    • map_status.xml
    • image_status.xml
  • Add the status to the prepareLocalizationPackage_api method in the accessrights.xml file.
To implement this feature:
  1. Open the TEXTML Administration perspective by clicking the TEXTML Administration shortcut on the tool bar. If the shortcut is not displayed, follow these steps:
    1. Select Window > Perspective > Open Perspective > Other
    2. Click TEXTML Administration.
    3. Click Open.
  2. In the TEXTML Administration view, double-click the server. If your server is not displayed in the view, you must add it to the view.
  3. When the Connect as dialog opens, type your username and password and click OK.
  4. Double-click the name of your Content Store to open a connection to it.
  5. Configure the status in the localizationManagers.xml file:
    1. Locate the localizationManagers.xml file in the repository's /system/conf collection.
    2. Check out and open the localizationManagers.xml file with a text editor.
    3. In the "com.ixiasoft.cms.controller.localization.sequential.SequentialLocalizationManagerService" manager class, add the retranslated.state parameter and set it to the new state.
      Note: In DRM, this class is called "com.ixiasoft.cms.controller.localization.sequential. SequentialLocalizationManagerServiceWithContainer".
      For example:
      <manager class="com.ixiasoft.cms.controller.localization.sequential.SequentialLocalizationManagerService"  
         name="Sequential Localization manager">
            <config name="substantialChange">false</config>
            <config name="full.context">false</config>
            <config name="context.document.type">Dita2Pdf</config>
            <config name="include.default.images">true</config>
            <config name="in.context.exact.matches">false</config>
            <config name="translatable.attributes">alt,navtitle</config>
            <config name="retranslated.state">retranslated</config>
      </manager>
    4. Save, close, and check in the localizationManagers.xml file.
  6. Add the status in the prepareLocalizationPackage_api method:
    1. Locate the accessrights.xml file in the repository's /system/conf collection.
    2. Check out and open the accessrights.xml file with a text editor.
    3. Look for the line that starts as follows:
      <method name="prepareLocalizationPackage_api"
    4. In the <statuses> element, add the following element and specify the new status:
      <status>Localization:retranslated</status>
      For example:
      Note: Your configuration may differ from the example below.
      <method name="prepareLocalizationPackage_api" type="api">
         <notify enabled="false"/>
         <conditionset operator="any">
            <condition>
               <current>
                  <type name="*">
                     <statuses>
                        <status>Localization:tb translated</status>
                        <status>Localization:in translation</status>
                        <status>Localization:retranslated</status>
                     </statuses>
                  </type>
               </current>
               <users>
                  <groups>
                     <group name="Everyone"/>
                  </groups>
               </users>
            </condition>
         </conditionset>
      </method>
    5. Save, close, and check in the accessrights.xml file.
  7. Add the new status in the topic_status.xml file:
    1. Locate the topic_status.xml file in the repository's /system/conf collection.
    2. Check out and open the topic_status.xml file with a text editor.
    3. In the localization cycle, add a <state> element for the new retranslated state, as follows:
      <state level="0" name="new_state" type="work">
         <lockable>
            <objtypes>
               <type>none</type>
            </objtypes>
         </lockable>
         <nextStates>
            <next>in translation</next>
         </nextStates>
       </state>
      For example:
      <state level="0" name="retranslated" type="work">
         <lockable>
            <objtypes>
               <type>none</type>
            </objtypes>
         </lockable>
         <nextStates>
            <next>in translation</next>
         </nextStates>
       </state>
    4. Make sure that the next state corresponds to the state for topics that are currently being translated.
      For example, in the sample code above, the next state is in translation.
    5. Save, close, and check in the topic_status.xml file.
  8. Add the new status in the image_status.xml file:
    1. Locate the image_status.xml file in the repository's /system/conf collection.
    2. Check out and open the image_status.xml file with a text editor.
    3. In the localization cycle, add a <state> element for the new retranslated state, as follows:
      <state level="0" name="new_state" type="work">
         <lockable>
            <objtypes>
               <type>none</type>
            </objtypes>
         </lockable>
         <nextStates>
            <next>in translation</next>
         </nextStates>
       </state>
      For example:
      <state level="0" name="retranslated" type="work">
         <lockable>
            <objtypes>
               <type>none</type>
            </objtypes>
         </lockable>
         <nextStates>
            <next>in translation</next>
         </nextStates>
       </state>
    4. Make sure that the next state corresponds to the state for topics that are currently being translated.
      For example, in the sample code above, the next state is in translation.
    5. Save, close, and check in the image_status.xml file.
  9. Add the new status in the map_status.xml file:
    1. Locate the map_status.xml file in the repository's /system/conf collection.
    2. Check out and open the map_status.xml file with a text editor.
    3. In the localization cycle, add a <state> element for the new retranslated state, as follows:
      <state level="0" name="new_state" type="work">
         <lockable>
            <objtypes>
               <type>none</type>
            </objtypes>
         </lockable>
         <nextStates>
            <next>in translation</next>
         </nextStates>
       </state>
      For example:
      <state level="0" name="retranslated" type="work">
         <lockable>
            <objtypes>
               <type>none</type>
            </objtypes>
         </lockable>
         <nextStates>
            <next>in translation</next>
         </nextStates>
       </state>
    4. Make sure that the next state corresponds to the state for topics that are currently being translated.
      For example, in the sample code above, the next state is in translation.
    5. Save, close, and check in the map_status.xml file.
  10. Inform users of the changes and request that they close and reopen their CCMS Desktop to apply the changes. Additionally, have an administrator refresh IXIASOFT CCMS Web so that users will see the change reflected there.