Automatic Actions Table

The following table describes the automatic actions available by default in WorldServer.

Action Arguments Description
Align

Source Assets Base AIS Path: AIS path to source asset

Previous Translations Base AIS Path: AIS path to a translated version of the source content

Matches the segments in a source asset (an asset in its original language) with segments in a previous translation of the asset. The result of performing an alignment is a collection of translation pairs that can be used to populate a translation memory. Use this action if there is no TM for the earlier translation.

The source and translated paths point to folders that contain the translatable assets, possibly in a subdirectory. The file structure at each level below the two paths must be identical, including directory names and file names.

The Previous Translations Path must contain translated assets corresponding to each of the assets in the Source Assets Path.

Block Projects Tasks None Prevents all of the tasks within a project group from advancing to the next step until all of them complete the previous step. This action allows you to synchronize the work across all of the tasks in entire project group. Returns Done in all cases.
Block Tasks None Blocks all the tasks within a project from advancing to the next step until all of the tasks complete the previous step. This action allows you to synchronize the work across all of the tasks in a project. Returns Done in all cases. Project scope.
CAUTION:
Be careful when using this step with a workflow that contains branching logic. You must ensure that all of the tasks in the project can and will reach this step in the workflow. If some tasks reach this step while others proceed to a different fork in the workflow, your project will hang, waiting for all the tasks to reach this step.
Calculate Repetitions None Scans through all of the tasks in the project to find any segments that occur more than once. Repetitions are flagged in the translation workbenches. The first occurrence of a repetition is called a Repeated Segment. All other occurrences are called Repetitions.

This is a project scope automatic action. It waits until all tasks in the project reach this step before running.

The action sends all tasks in the project to Auto Error if any of the source assets have not already been segmented. The action returns Done in all other cases.

The number of repetitions in scoping reports with cost analysis are incorrectly reported if the automatic actions in the workflow are not in the correct order. To update the scoping/costing analysis with new repetition information the correct order of automatic actions is:

Segment Assets > Update Scoping Information > Calculate Repetitions > Generate Scoping

Note: If you use a machine translation server to which you do not want to send repetition segments, you can add Calculate Repetitions > [Other leverage step(s)]automatic actions before the Update Scoping Information step.
Change Asset Property

Property name: Specifies which AIS property to set.

Property value: The new value of the property.

Sets a custom AIS property of the target asset to a specified value.

The action sends the task to Auto Error if the property does not exist or if the value cannot be set. It returns Done in all other cases.

Check In

Asset Type to Check In: Specifies whether to check in the source or target asset.

If Content is Unchanged: Specifies the action to perform if the new content is identical to the old content, one of Undo checkout, Check in, or Return File.

Check in an asset that supports versioning.

If the content is unchanged and the specified action is Return File, returns Identical so that the workflow can control what happens next. The action returns Success in all other cases.

Check Out Asset Type to Check Out: Specifies whether to check out the source or target asset. Check out an asset that supports versioning. Returns Success.
Clear Segment None Clear the segment cache for the asset, forcing the asset to be resegmented and rescoped the next time a segmentation operation occurs (for example, if Segment Asset is run on it, it is opened in the Browser Workbench, exported to a translation kit, or a scoping report is generated 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, it therefore does not affect what is in outstanding tasks.
Document Locked? None Checks whether all the segments in the asset are locked. The action sends the task to Auto Error if the source asset has not already been segmented. The action returns Yes if all the segments are locked and returns No otherwise.
Enable Online Editing None Prepares assets to be modified in SDL Online Editor. You should always add this automatic action before each human step that you want users to perform in SDL Online Editor.
Lock Segments The segments to lock, either:

all: locks all segments in the asset

in-context matched: locks only segments for which an ICE match has been found

Locks either all the segments or in-context (ICE) match segments in the task.

This action can be used in conjunction with the Locking Options on a Human Step to control which segments the user can modify. However, you must set the Locking Options on the Human Step for the segment-level locking to have any effect. If the Locking Option is set to No Locking (the default value), the segment-level locks are ignored.

The action sends the task to Auto Error if the source asset has not been segmented previously. The action returns Done in all other cases.
None None Does not perform any action. The default action that is performed when a Cancel action runs. Returns Done.
Notify

Name: This argument is no longer used and its value will be ignored.

E-Mail Addresses of Recipients: the email address of the person to whom to send the message. Separate multiple addresses with semicolons. You cannot use a distribution list; you must specify individual email addresses in this field.

Message to send: the text of the message

Sends an email message to one or more users.
QA Checker

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.

Ignore 100% Segments: Select Yes if you do 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 ICE and SPICE matches. If you want it to check 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 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.

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):
  1. Untranslated segments.
  2. Tag differences, term usage, identical numbers.
  3. 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 this automatic action is after the Segment Asset automatic action in your workflow.
Save Update TM?: whether the TM should updated on save – Yes or No. Generates the target asset for this task based on the current contents in the segment cache.

If the Update TM? option is enabled, and WorldServer is not in live TM mode, the action also updates the Translation Memory based on the segment cache. If the Update TM? option is enabled, and WorldServer is in live TM mode, the action sets the translation status of all segments to reviewed. This behavior is for backwards compatibility and we do not suggest enabling the Update TM? option when using live TM mode. If you are not in live TM mode you should still be careful with the Update TM? option. Updating the TM before reviewing the translations can lead to confusion or even incorrect translations in other documents.

The action sends the task to Auto Error if the asset has not been previously segmented, or if there is no TM associated with the task and the Update TM? option is selected. Returns Done in all other cases.

When used for assets processed with SDL file types, segments are processed asynchronously by default.

Save Online Asset Update?: whether the TM should be updated on save – Yes or No. 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 SDL Online Editor.
Segment Asset Copy Non-Translatable Assets to Target: Yes or No. If an asset is not translatable, Yes copies the asset to the target directory. No skips the asset and does not copy it. Default: Yes Segments an asset in preparation for translation. After the asset is segmented, it is leveraged against the translation memory to find any matches. This process computes the leverage rates for every segment in the asset, which allows you to use the scoping feature to estimate the cost of translation.

If you apply this automatic 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 deemed to be not translatable (for example, it is a binary file for which there is no file type in WorldServer), returns Not Translatable. In addition, if the Copy Non-Translatable Assets to Target option is enabled, it copies the source asset directly to the target asset. Otherwise returns Translatable.

When used for assets processed with SDL file types, segments are processed asynchronously by default.

Set Quote Status There are four quote-status values:
  • Approved
  • Requested
  • Pending Approval
  • Abandoned
Sets the status of a quote to the specified value. Note that Advanced Quote Approval Workflow uses this automatic action to change the quote status after the appropriate Human Step is performed.
Set Return Value Return Value: Enter a value of 1 for success or 0 for failure. Sets the return value of a sub-workflow for return to the parent workflow. Use this action as the last step before the Finish step in a sub-workflow. This action is used to control the transitions after the sub-workflow step in the parent workflow. Returns Done in all cases.
Text Changed? None Determines whether the target can be generated completely from ICE match segments or whether at least one segment cannot be ICE matched. The action sends the task to Auto Error if the source asset has not already been segmented. The action returns No change if all of the segments can be ICE matched. It returns Changed otherwise.
Trisoft Change Asset Status Status: one of the component status values defined in the SDL Knowledge Center server Changes the status of the target asset in the SDL Knowledge Center server to the specified value. If WorldServer cannot change the status to that value, the task goes to Auto Error. If WorldServer successfully changes the status, the automatic action returns Done. If the asset is not in an SDL Knowledge Center server, the automatic action does nothing other than return Done.
Trisoft Check Asset Status Status: one of the component status values defined in the SDL Knowledge Center server Compares the specified value with the status of the target asset in the SDL Knowledge Center server. If the asset's status in the SDL Knowledge Center server is the same as the value specified in the Status parameter, the automatic action returns Yes. Otherwise, it returns No. The status comparison is case insensitive. If the asset is not in an SDL Knowledge Center server, the action returns No.
Trisoft Check Out None Checks out the target asset in the SDL Knowledge Center server, in order to get an exclusive right to use the asset. If WorldServer successfully checks out the asset, the automatic action returns Done. If the asset is currently checked out by any user (including WorldServer), or if any other error occurs in the SDL Knowledge Center server during the checkout, the task goes to Auto Error. If the asset is not in an SDL Knowledge Center server, the automatic action does nothing other than return Done.
Trisoft Undo Check Out None Undoes a checkout on the target asset in the SDL Knowledge Center server. It is typically used at the end of a workflow to remove the checkout performed by the Trisoft Check Out automatic action. In addition to using this action in an Automatic Step, always set this action in the Cancel step of your workflow to be sure that if a task is canceled WorldServer releases any assets you have checked out.
Important: This action always returns Done whether or not the "undo checkout" was successful. To be sure that all of the assets have been released, upon completion of the translation project you should check the status of your assets in the SDL Knowledge Center server.
Important: If your SDL Knowledge Center AIS Mount is configured to connect as user Administrator, the Undo Check Out action will undo the checkout that any user has on the specified asset. Otherwise, the Undo Check Out action will undo only checkouts performed by the user specified in the SDL Knowledge Center AIS Mount. To find out how your SDL Knowledge Center AIS Mount has been configured, contact your WorldServer administrator.
Undo Change Detection Database Lock Timeout (for SQL server only): Specifies a time (5000ms by default) to wait to obtain locks on busy assets. Deletes all consumed changes for a given source path and change token. The action will essentially make the source asset appear to be totally new for the 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 last executed" clause.
Undo Check Out Asset Type to Undo Check Out: Specifies whether to undo the checkout for the source or target asset. Undo an earlier checkout of a versioned asset, reverting to the version that was last checked in. Returns Success.
Unlock Segments None Unlocks all the segments in the task. This action is used to turn off any locks that were set through the Lock Segments automatic step or by a translator or reviewer.

The action sends the task to Auto Error if the source asset has not been previously segmented. Returns Done in all other cases.