Configure the incremental localization process for CCMS Web

The CCMS Web incremental localization process allows you to start the localization process before all objects have an Authoring:done or equivalent status.

Typically, the map and all its children should have an Authoring:done or equivalent status before you can begin with localization. When you implement the incremental localization process, you define each acceptable status before the objects go into the Localization cycle. For example, instead of having the map, the topics, and all the images at Authoring:done before starting the localization process, you can configure it so you can begin the localization process even if some of the topics still have an Authoring:work status.

Note: If you localize individual topics and images, MadCap Software strongly recommends that you implement the incremental localization process.

To incorporate the incremental localization process in the workflow, make the following changes to the configuration files:

  1. Add a new status called Localization:do not translate that defines the available statuses for each object. The Localization:do not translate status identifies the objects that are not authorized for translation.
  2. In the access rights configuration file, the Localize action defines the required statuses for objects at the time they go to the Localization cycle.
  3. In the access rights configuration file, the localize_api action defines which statuses for each object are set to Localization:tb translated at the time they go to the Localization cycle. All statuses not defined in the localize_api action are automatically set to Localization:do not translate when they go to the Localization cycle.
  4. In the access rights configuration file, the Prepare kit action defines which objects and at which status get included in the localization kit.

Objects set to Localization:do not translate are excluded from localization kits that are prepared by IXIA CCMS.

To configure the incremental localization process:
Note: Because your deployment may have different status types, use those equivalents for those specified in this task.
  1. In the TEXTML Administration perspective, connect to your server.
  2. Locate the status.xml file in the repository's /system/conf collection.
  3. Check out the file and open it for editing.
  4. In the section <collection="/content/localization/" >, add the do not translate state by copying the following lines and pasting them inside the states element.
    Important: Do not alter the name of the state from do not translate.
    <state level="0" name="do not translate" type="work">
    	<lockable>
    		<objtypes>
    			<type>none</type>
    		</objtypes>
    	</lockable>
    	<milestone/>
    	<nextStates/>
    </state>

    It should look like the following example:

    <cycle collection="/content/localization/" description="" initial="false" lastworkcycle="false"
    	level="0" name="Localization" type="localization">
    	<nextCycle/>
    	<states>
    		<state level="0" name="do not translate" type="work">
    			<lockable>
    				<objtypes>
    					<type>none</type>
    				</objtypes>
    			</lockable>
    			<milestone/>
    			<nextStates/>
    		</state>	
    		<state initial="true" level="0" name="tb translated" type="work">
    			<lockable>
    				<objtypes>
    					<type>image</type>
    				</objtypes>
    			</lockable>
    			<nextStates>
    				<next>in translation</next>
    			</nextStates>
    		</state>
    		
    		[ . . . ]
    
    	</states>	
    </cycle>	
  5. Repeat the previous steps you completed for status.xml to add the new state to the following files:
    • map_status.xml
    • topic_status.xml
    • image_status.xml
  6. Save, close, and check in the files.
  7. Open the Access Manager window.
    1. Right-click your docbase.
    2. Click CCMS Admin.
    3. Click Manage Access.
  8. In the Actions column, click Localize and click Lock to configure the localization process.
  9. For each condition, define which objects in which statuses can be sent to the Localization cycle:
    1. In the Conditions column, click a condition.
    2. Click the arrow next to an object to expand the list of cycles.
    3. Click the arrow next to Authoring to expand the list of statuses.
    4. Select each status which is authorized to be sent to the Localization cycle.
    5. Repeat for each object.
    6. Repeat for each condition.

    For example, if you wanted to allow the map and all its children to be able to be sent to the Localization cycle regardless their status, you would select all the statuses for all the objects.

  10. In the Actions column, click localize_api to define which statuses are set to Localization:tb translated for when objects are sent to the Localization cycle. All other statuses will be set automatically to Localization:do not translate.
  11. For each condition, define which statuses can be sent through the localization process:
    1. In the Conditions column, click a condition.
    2. Click the arrow next to an object to expand the list of cycles.
    3. Click the arrow next to Authoring to expand the list of statuses.
    4. Select each status for which you want to authorize to be translated.
    5. Repeat for each condition.

    For example, if you only wanted objects in Authoring:done and Authoring:accepted, you would select only those statuses. This means that objects with an Authoring:done and Authoring:accepted status are set to Localization:tb translated when they get sent to the Localization cycle. All objects in any other status are set to Localization:do not translate.

  12. In the Actions column, click Prepare kit.
  13. For each condition, define which objects in which statuses you can prepare a localization kit from:
    1. In the Conditions column, click a condition.
    2. Click the arrow next to an object to expand the list of cycles.
    3. Click the arrow next to Localization to expand the list of statuses.
    4. Select each status you want included in the localization kit.
    5. Repeat for each object.
    6. Repeat for each condition.

    For example, if you want to allow users to only prepare localization kits from maps in status Localization:tb translated, then you would select only Localization:tb translated for maps.

  14. In the Actions column, click Retranslate.
  15. For each condition, define which objects can be re-translated:
    1. In the Conditions column, click a condition.
    2. Click the arrow next to an object to expand the list of cycles.
    3. Click the arrow next to Localization to expand the list of statuses.
    4. Select each status you want included in the localization kit.
    5. Deselect do not translate.
    6. Repeat for each condition.
    Tip: It is recommended to selected all the statuses, except do not translate.
  16. Save, close, and check in the file.
  17. Test your implementation. If it is not behaving as expected, verify the access rights are configured correctly for each object and status in each condition.
  18. Inform users of the changes.
    The changes will be applied automatically once users close and then reopen their CCMS Desktop. Users can also apply the changes without restarting their CCMS Desktop by clicking IXIA CCMS > Synchronize Configuration. Additionally, refresh IXIA CCMS Web so that users will see the change reflected there.