Available automatic actions

A list of automatic actions available by default in WorldServer.

Action	Description	Input arguments
Align	This action aligns the segments in a source asset with the segments in a previous translation of the asset. The result of performing an alignment is a collection of segment pairs that you can use to create or populate a translation memory (TM). Use this action if you do not have a TM for the previous translation. The source and translated paths point to folders that contain the translatable assets. The file structure at each level below the two paths need to be identical, including folder names and file names. The Previous Translations Base AIS Path must contain translations corresponding to each asset in the Source Assets Base AIS Path.	Source Assets Base AIS Path: Specify the AIS path to the source asset. Previous Translations Base AIS Path: Specify the AIS path to the translated version of the source asset.
Block Projects Tasks	This action prevents all the tasks within a project group from advancing to the next step until all of them have completed the previous step. You can use this action to synchronize the work across all the tasks in a project group. Returns `Done` in all cases.	None.
Block Tasks	This action prevents all the tasks within a project from advancing to the next step until all of them have completed the previous step. You can use this action to synchronize the work across all the tasks in a project. Returns `Done` in all cases. Note: When you use this step in a workflow that contains branching logic, make sure that all the tasks in the project can and will reach this step. If some tasks reach this step and others follow a different path in the workflow, your project will hang, because it will wait for all the tasks to reach this step.	None.
Calculate Repetitions	This action scans through all of the tasks in the project to find any segments that occur more than once. If any of the source assets has not been segmented already, the action sends all the tasks in the project to Auto Error. In all other cases, the action returns `Done`. If the automatic actions in the workflow are not in the correct order, the number of repetitions in scoping reports with cost analysis may be reported incorrectly. To update the scoping/costing analysis with new repetition information, you need to arrange the automatic actions in the following order: Segment Assets > Update Scoping Information > Calculate Repetitions > Generate Scoping Report The Update Scoping Information and Generate Scoping Report automatic actions are not available by default, but you can upload them as part of the sample automatic actions. Note: If you use a machine translation server to which you do not want to send repetition segments, you can add the Calculate Repetitions automatic action, as well as other leverage steps before Update Scoping Information.	None.
Change Asset Property	This action sets a specified value to a custom AIS property of the target asset. If the property does not exist or if the action cannot set the value, the action sends the task to Auto Error. In all other cases, it returns `Done`.	Property Name: Specify the AIS property that the automatic action needs to set. Property Value: Specify the new value of the property.
Check Out	This action checks out an asset that supports versioning. It returns `Success` if it succeeds.	Asset Type to Check Out: Select the type of asset that the automatic action needs to check out—source or target.
Clear Segment	This action clears the segment cache for the asset, forcing the asset to be re-segmented and re-scoped the next time a segmentation operation occurs. Some segmentation operations are: running Segment Asset on that asset, opening the asset in Browser Workbench, exporting it to a translation kit, or generating a scoping report for it). Returns `Done`. Note: A task maintains the segmentation for an asset after the Segment Asset automatic action step is completed in that task. If you run the source file through another workflow with Clear Segment in it, this does not affect the segmentation in outstanding tasks.	None.
Document Locked?	This action checks whether all the segments in the asset are locked. If the source asset has not already been segmented, the action sends the task to Auto Error. The action returns `Yes` if all the segments are locked; otherwise, it returns `No`.	None.
Enable Online Editing	This action prepares assets to be modified in Online Editor. You should always add this automatic action before each human step that you want users to perform in Online Editor.	None.
Generate TM Matches for Export Kit		TM Filter:
Lock Segments	This action locks either all the segments in a task or only segments with ICE matches. You can use this action in conjunction with the Locking Options configuration in the advanced settings of a human step to control the segments that users can modify. For segment-level locking to have any effect, you must set the locking options on the human step. If you set Locking Options to No Locking (the default value), segment-level locks are ignored. If the source asset has not been segmented previously, the action sends the task to Auto Error. In all other cases, it returns `Done`.	Segments To Lock: Select the type of segments that you want the automatic action to lock—either all the segments or only segments with ICE matches.
None	This action is performed by default when a Cancel action runs and it does not do anything. Returns `Done`.	None.
Notify	This action sends an email message to one or more users.	Name of Recipient (ignored): This argument is no longer used. You can ignore it. Email Addresses of Recipients: Specify email addresses of the persons to whom you want to send the notifications. Use semicolons to separate addresses. Also, do not specify distribution lists; you need to specify individual addresses. Message to Send: Specify the content of the notification that you want this automatic action to send.
QA Checker	This action checks whether each segment in a task meets certain validation criteria after being translated or reviewed. If the task meets all the criteria, it moves on to the next step in the workflow. If it does not meet all the criteria, you can view a report that contains each segment and the criteria that it did not meet. This report is available both in .xml and in .html format on the Tasks page. To download the report, make the QA Checker Report column visible in the table on the Tasks page, and then click the link under QA Checker Report. Errors are reported according to the following priorities (from highest to lowest): Untranslated segments. Tag differences, term usage, identical numbers. Incorrect order of tags. If the same segment contains errors of different priorities, such as numbers that do not match (2) and an incorrect tag order (3), the report presents only the error with the highest priority for that segment (in this case, 2). Tip: If possible, make sure that you place this automatic action after the Segment Asset action in your workflow.	Ignore 100% Segments: Select Yes if you want this automatic action to skip checking segments with 100% matches. If you want it to check 100% matches as well, select No. Ignore ICE/SPICE Match Segments: Select Yes if you want this automatic action to skip checking segments with ICE and SPICE matches. If you want it to check segments with ICE and SPICE matches as well, select No. Ignore Locked Segments: Select Yes if you want this automatic action to skip checking locked segments. If you want it to check locked segments as well, select No. Check for Untranslated Segments: Select Yes if you want this automatic action to check for any untranslated segments in the target text. Otherwise, select No. Check for added or removed tags: Select Yes if you want this automatic action to check for any tag differences between the source text and the target text. Otherwise, select No. Check for correct order of tags: Select Yes if you want this automatic action to check whether the tags in the target text are in the same order as in the source text. Otherwise, select No. Check for changed numbers: Select Yes if you want this automatic action to check whether numbers are the same both in the source text and in the target text. Otherwise, select No. Check if terms are used: If you have a terminology database (TD) associated with your project type, select Yes for the automatic action to check whether the terms in the TD are used in the target text. Otherwise, select No.
Save	This action generates the target for the task based on the current contents of the segment cache. If you configure the action to update the translation memory (TM) and WorldServer is not in Live TM mode, the action also updates the TM based on the segment cache. If you configure it to update the TM and WorldServer is in Live TM mode, the action sets the translation status of all the segments to Reviewed. If the asset has not been segmented previously or if there is no TM associated with the task and Update TM is set to No, the action sends the task to Auto Error. In all other cases, it returns `Done`. When you use it for assets processed with regular file types, segments are processed asynchronously by default.	Update TM: Select whether or not you want the automatic action to update the translation memory (TM) after it is executed. You should not select Yes if you are using Live TM mode. Even if you are not in Live TM mode, you should still be careful with this option, because updating the TM before reviewing the translations can lead to confusion and incorrect translations.
Save Online Asset	This action ensures that the asset is synchronized in WorldServer and can be modified in WorldServer after a human step has been completed. You should always add this automatic action after each human step that you want users to perform in Online Editor.	Update TM: Select whether or not you want the automatic action to update the translation memory (TM) after it is executed.
Segment Asset	This action segments assets to prepare them for translation. After it segments each asset, it leverages it against the translation memory to find matches. If you apply this action to an asset that has already gone through a partial translation, it will reapply the TM and pick up any new matches from the TM. If the asset is not translatable, the action returns `Not Translatable`. Otherwise, it returns `Translatable`. When you use it for assets processed with regular file types, segments are processed asynchronously by default.	Copy Non-Translatable Assets to Target: Select whether or not you want the automatic action to copy non-translatable assets to the target folder. Leverage Assigned TM: Leverage Assigned MT: Collect and Record Scoping Data: Set Translation Statuses: Maximum Translation Results for 100% matches:
Set Return Value	This action sets the return value of a sub-workflow to return to the parent workflow. Use this action as the last step before Finish in a sub-workflow. With this action, you can control the transitions after the sub-workflow step in the parent workflow. Returns `Done` in all cases.	Return Value: Enter a value of `1` for success or `0` for failure.
Text Changed?	This action determines whether the target can be generated completely from segments with ICE matches or whether at least one segment has no ICE matches. If the source asset has not been segmented already, the action sends the task to Auto Error. If it finds ICE matches for all segments, it returns `No change`. Otherwise, it returns `Changed`.	None.
Trisoft Change Asset Status	This action changes the status of the target asset in Tridion Docs to the value of your choice. If the action cannot change the status to that value, it sends the task to Auto Error. If it changes the status successfully, it returns `Done`. However, if the asset is not in a Tridion Docs server, it also returns `Done`, but it does not do anything further.	Status: Specify one of the component status values defined in your Tridion Docs server.
Trisoft Check Asset Status	This action compares the specified value with the status of the target asset in the Tridion Docs server. If the status is the same, it returns `Yes`. Otherwise, it returns `No`. If the asset if not in a Tridion Docs server, it also returns `No`. Note: The status comparison is case-insensitive.	Status: Specify one of the component status values defined in your Tridion Docs server.
Trisoft Check Out	This action checks out the target asset in the Tridion Docs server. If the action checks out the asset successfully, it returns `Done`. If the asset is currently checked out by a user or if any other error occurs in Tridion Docs, the action also returns `Done`, but it does not do anything further.	None.
Trisoft Undo Check Out	This action undoes a checkout on the target asset in the Tridion Docs server. You can use it at the end of a workflow to remove the checkout performed by the Trisoft Check Out automatic action. If you are working with Tridion Docs, you should also always set this action in the Cancel step of your workflow to make sure that WorldServer releases any checked out assets if someone cancels a task. This action always returns `Done`, regardless of whether it was successful or not. To make sure that all the assets have been released, check their statuses in Tridion Docs. Note: If your Tridion Docs AIS Mount is configured to connect as the Administrator user, this action undoes the checkout performed by any user on the specified asset. Otherwise, the Undo Check Out action will undo only checkouts performed by the user specified in the Tridion Docs AIS Mount.	None.
Undo Change Detection	This action deletes all the consumed changes for a given source and change token. It essentially makes the source asset appear as completely new for the new locale (and rule) identified by the change token. This action also takes into account changes applied by rules using the new or changed since rule was last executed clause.	Database Lock Timeout (ms): Specify a time (in milliseconds) to wait to obtain locks on busy assets. This argument only applies to Microsoft SQL Server environments.
Undo Check Out	This action undoes an earlier checkout of a versioned asset, reverting to the version that was last checked in. Returns `Success`.	Asset Type to Undo Check Out: Select whether you want to undo the checkout for the source asset or for the target asset.
Unlock Segments	This action unlocks all the segments in the task. Use this action to turn off any locks set through the Lock Segments automatic step or by a translator or reviewer. If the source asset has not been segmented previously, the action sends the task to Auto Error. In all other cases, it returns `Done`.	None.