Home Portal

Skip to end of metadata
Go to start of metadata

Kindly note that WeLocalize is in the process of replacing their legacy Falcon API with a new Junction API. As a consequence, the integration with XTRF will only remain operational until WeLocalize fully deprecates Falcon. XTRF is not planning to develop this integration further in its current shape, nor to migrate to the Junction API. Connecting XTRF to WeLocalize's portal will only be possible by means custom connectors. If you are interested in such a connector, kindly contact your Customer Success Manager at XTRF or XTRF Sales Team.

The integration with WeLocalize allows XTRF to perform synchronisation with WeLocalize's system called Falcon.

The basic workflow support includes:

  • automatic creation of tasks proposed by WeLocalize - they become quotes in XTRF,
  • automatic propagation of state modification of XTRF tasks:
    • accepted quotes automatically become active tasks in WeLocalize,
    • rejected quotes automatically become rejected tasks in WeLocalize,
    • tasks closed in XTRF are automatically marked as done in WeLocalize,
  • automatic project acceptance - final acceptance of tasks in WeLocalize is propagated to XTRF.

The integration was introduced in XTRF v2014 Winter (3.1).

Table of Contents

Configuration

See: WeLocalize Integration Pre-configuration.

Synchronisation Policy

WeLocalize Task PhaseXTRF corresponding task stateSynchronisation Action
Proposedneither project nor quote existsA Quote is created (according to the mappings described in Fields Mapping section)
The created Quote has one language combination and one task.
quote existsOnly Status and Task Communication History are updated (no other potential changes in WeTask are reflected in XTRF).
project existsWeLocalize task is marked as Active (acceptTask method is called on WeLocalize API).
Note: No potential changes in WeTask are copied to XTRF task. The project may have been converted from quote or created manually without the quote phase.
quote exists in Rejected stateWeTask is marked as cancelled (the rejectTasks method is called on WeLocalize API).
ActiveanyOnly Status and Task Communication History are updated.
Note: No other potential changes in WeTask are copied to XTRF task.
No XTRF project/quote is created and no XTRF quote to project conversion is performed if a WeTask is accepted manually via Falcon GUI.
project exists, task closed
The WeTask is marked as Completed (markTasksAsComplete method is called on WeLocalize API).
CompleteanyOnly Status and Task Communication History are updated.
Note: No potential changes in WeTask are copied to XTRF task.
Approvedproject exists, task closedXTRF task's Delivery Date and Time is set to WeTask ApprovedDate, Status and Task Communication History are updated.

Task Identification

XTRF maps XTRF task to WeLocalize task. XTRF task is considered matching when:

  • XTRF task's Customer Task Number equals WeLocalize TaskId
  • XTRF task (project/quote) Customer must be the same as the Customer set in the synchronisation module configuration (in most cases it means it must be WeLocalize).

Note: You may turn off synchronisation for any task at any workflow stage. Simply change Customer Task Number in these tasks. The system will not be able to correctly identify a WeTask so it will not be included in synchronisation any more.

Fields Mapping

Field NameDescription (from WeLocalize)XTRF field
TaskIdA unique identifier for each and every task provided. This will be an integer number.Customer Task Number
SourceLocaleThe Source Language identifier. These are typically the ISO codes for various locales, but there are some exceptions such as "zh-Simp" for Chinese Simplified and "zh-Trad" for Chinese Traditional or "ar-MidEast" for Arabic Middle East and "ar-NorAF" for Arabic North Africa.Task's Source language (may be null if null passed or no target locale is found in XTRF languages list).
Mapping is performed using Symbol, ISO 639-2 Code and ISO 639-2 Code properties of Language entity in XTRF.
TargetLocaleThis is the Target locale identifier for the task. Please see comments above.Task's Target Language (may be null if null passed or no target locale is found in XTRF languages list)
Mapping is performed using Symbol, ISO 639-2 Code and ISO 639-2 Code properties of Language entity in XTRF.
SourceLanguageThis is the full text for the source language identifier.Ignored.
TargetLanguageThis is the full text for the target language identifier.Ignored.
TaskTypeThis will be the task type.Task Receivable Job Type, mapped by Job Type's name. Job Type is created if there isn't any with a given name.
Quote/Project Name
Task Name
Customer Special Instructions
ToolNameThis will indicate the tools required to perform the given task type. For translation, it will indicate the translation tool used to generate the translation kit. For non-translation tasks it may be used to indicate additional tools such as DTP type (MS Word, InDesign, etc).Customer Special Instructions
Provider Special Instructions
LocationThis is a URL address that can be used to download the files to work on. This could also be the URL for an online tool to perform the work.Customer Special Instructions
Provider Special Instructions
ProposedDateThis is the date that the task was first proposed to you. All dates provided will be GMT-based and rounded to the nearest second. All times will utilise a 24-hour clock. Example: “1012-08-25T13:30.00 GMT”. This would be Year=2012, Month=8 (August), Day=25, Hour=1300 (or 1 PM) , Minute=30 and Second=0, so the date above would be August 25, 2012 1:30 PM.Quote's Quote Start Date (do not confuse with Start Date which is the expected date of the project start).
StartDateThe date the task is due to start.Task Start Date and Project/Quote Start Date.
DueDateThe date the task is due.Task Deadline and Project/Quote Deadline.
DeliveredDateThe date the task was delivered/completed. (Will be null for tasks not yet delivered).Ignored.
ApprovedDateThe date the task was approved. (Will be null for tasks not yet approved).Delivery Date
This field is updated only if it is null and WeTask is in APPROVED phase.
PhaseThe Phase the Task is in. It can be Proposed, Active or Approved.Ignored, only PhaseCode is used.
PhaseCodeThe Code for the Phase the Task is in. See table below.See: Synchronisation Policy.
StatusCurrent Status of the task. A full explanation of the status can be found in the table below. Note that a task may have multiple statuses.Ignored, only StatusCode is used.
StatusCodeThe Status Code for the Current Status of the task. A full explanation of the status can be found in Appendix B below.Set of Task Category. For each WeLocalize Status a corresponding category entry is created in XTRF. This field is updated to reflect changes in WeTask introduced by WeLocalize team.
POIDPurchase Order ID for the task. May be empty / null.Customer Special Instructions
ClientNameThe name of the WeLocalize Client.Task Name
Quote/Project Name
ProjectManagerName of the WeLocalize Project Manager.Project/Quote/Task Customer Contact Person
Matching is performed using contact person name. If a person does not exist, it is created and added to a given customer contact persons list. (See: Configuration – Customer.) As there is no Project Manager's e-mail address available in WeLocalize API, someone@welocalize.com address is being set.
AssigneeVendor Contact that the task is assigned to.Project/Quote Project Manager
Matching is performed using name. If a user does not exists the default PM of a customer is used. (See: Configuration – Customer).
AssigneeIdID of the Vendor Contact that the task is assigned to. (See: getAssignableContacts WS.)Ignored.
ClientProductThe product for the WeLocalize Client.Customer Special Instructions
Provider Special Instructions
ContentTypeThe content type of the work. This would typically be UI, UA or MARCOM (Marketing materials).As text in Provider Special Instructions: "The content is provided in the following format: {x}".
Customer Special Instructions
SpecialtyRequiredThis would list any special linguistic skills that may be needed. For example Legal, Engineering, Transportation, etc.Task Specialisation
Specialisation is matched by name (only basic – usually English – name is checked, not the localised values). If no specialisation of a given name exists, it is created.
MessageThis contains the contents of the last communication thread for the task. This will contain any special instructions required.Customer Special Instructions
WeightedUnitsThis contains the scope of the work. For translation work, this will be a weighted word count. Please see the explanation below on how the weighting is calculated.
For non translation work, this will be the actual units for the task.
If no CAT analysis is provided (see below), it is used as Quantity in Receivable. If CAT analysis is provided, Receivable's Quantity is calculated using the analysis.
UnitOfMeasureIndicates the measure that the units above apply to. For example Words, Hours, Pages, etc.Receivable's Calculation Unit
Calculation Unit is matched by name (only basic – usually English – name is checked, not the localised values). If no unit of a given name exists, it is created.
BaseRateThis is the rate for the task. For Translation tasks, this is the new word rate. For non-translation tasks, this is the rate for the work.Used as Rate Value in receivable and CAT receivable.
RateCurrencyThis is the currency that the rate applies to. This will be an ISO currency code. Please see the list of possible currency codes at: http://www.xe.com/iso4217.php.Quote/Project Currency. Currency is matched using XTRF Currency ISO code and symbol. If it does not exist, no new currency is created. Exception is thrown and synchronisation is not performed.
TaskValueThis will be the value of the task.Task Total Agreed
Task Total Agreed always overrides the calculated value. (Auto-calculate Total Agreed is off.)
WordCountsThis will apply to translation tasks only and will provide the detailed breakdown of words based on the match type. This will be an array of WordCount elements. Each element will have a WordType attribute which will indicate the type of match and a value indication the number of words for that type.SDL Trados CAT Quantities in CAT Receivable
WordRatesThis will apply to translation tasks only and will provide the detailed breakdown of word rates based on the match type. This will be an array of WordRate elements. Each element will have a WordType attribute which will indicate the type of match and a value indicating the rate for the match type.SDL Trados CAT Rates in CAT Receivable
WordTypeUsed in the WordCount and WordRate elements above. Values are:
  • New
  • 100%
  • Repetition
  • 95%
  • 85%
  • 75%
  • ICE
  • 50% (optional for Japanese source translation)
SDL Trados CAT Match Type in CAT Receivable
PlatformThe platform.Customer Special Instructions
ClientJobIdThe client identifier for the job.Customer Special Instructions
ProjectNumberThe WeLocalize project / request number.Quote/Project Customer Project Number
RequestNameThe name for the request.Customer Special Instructions
RequestDescriptionA description for the request.Customer Special Instructions
TmsTaskTells whether it is a TMS generated task.Ignored.
TmsTaskIdThe TMS task ID.Ignored.
TmsRequestIdThe TMS request ID.Ignored.
TaskCommunicationHistory Task Internal Special Instructions. This field is updated to reflect all changes introduced by WeLocalizeTeam.

Known Issues

Incorrect / login password message even the credentials are correct.

Error message: Internal error: javax.xml.ws.soap.SOAPFaultException: javax.xml.ws.soap.SOAPFaultException: An error occurred when verifying security for the message.

Possible reason: Incorrect time set on the server running XTRF. To confirm, check the server time and compare with your local time (hours may be different due to different time zone but minutes should be equal). To check server time, log in to XTRF, go to System Monitor and check HTTP session start time – it is set to the current server time.

Solution: Change the server time (use NTP for automatic time synchronization if possible). This operation requires administrator rights on the server and cannot be performed using XTRF console.

 

  • No labels