API methods

These API methods are configurations for automated actions in IXIASOFT CCMS.

When a user performs some actions, the configuration of these API methods determines what happens in IXIASOFT CCMS. These methods do not give users access to any visible functionality.

Action name Description Action use
importLocalization_api This method determines at what statuses objects in Localization can be overwritten by an import from a localization kit.

By default, this method applies to objects at Localization:in translation or Localization:in review.

Note: This method looks only at status names. It does not distinguish between object types unless different objects have different names for statuses.
 CCMS Desktop
LinguisticReview This method works with the linguisticReview.xml configuration file, as well as the Prepare kit and prepareLocalizationPackage_api methods, to determine for what objects you can create a localization kit that removes the translate="no" attribute from auto-translated text.

By default, this method applies to maps and topics at Localization:review.
localize_api When a user uses the Localize action on an object in the Authoring cycle (such as a map), this method determines which objects to create at a localizable status (such as Localization:tb translated) as opposed to a non-localizable status (such as Localization:do not translate). This is determined for the object that is localized and all its dependencies.

By default, this method applies to all objects at Authoring:done or Published:done.

Note: This method looks only at status names. It does not distinguish between object types unless different objects have different names for statuses.
 CCMS Desktop
prepareLocalizationPackage_api This method determines at what status objects (excluding images) are included in the localization kit. It does not give users access to any visible functionality

By default, this method applies to maps, topics, and resources at Localization:tb translated or Localization:in translation.

Note: This method looks only at status names. It does not distinguish between object types unless different objects have different names for statuses.

If a localization kit needs images so that there are no missing dependencies, this can be set in localizationManagers.xml. However, images that are marked as needing translation are not translated from this localization kit. If images need translation, they must be included in a separate image localization kit.

 CCMS Desktop
prepareImageLocalizationPackage_api This method determines at what status images are included in the image localization kit. The images must also be tagged as needing translation.

By default, this method applies to images at Localization:tb translated or Localization:in translation.

Note: This method looks only at status names. It does not distinguish between object types unless different objects have different names for statuses.
 CCMS Desktop
publish_api This method determines at what status users can publish an object.

By default, this method applies to images at an end status, such as Authoring:done.

 CCMS Desktop