Project management
In the SOAP API, you can use these project management-related methods:
assignLinguistToProject()
Assigns Linguists or LSPs to all jobs (all bundles, all files, and all languages) for a specific workflow step in the project and returns the result of the assignment operation. It requires a project descriptor and a list of
XTMStepLinguistAssignmentAPIobjects. TheXTMStepLinguistAssignmentAPIobject includes a workflow step descriptor and a user descriptor.assignLinguistToJob()
Assigns Linguists or LSPs to the specified jobs and returns the result of the assignment operation. It requires a list of
XTMJobLinguistAssignmentAPIobjects. TheXTMJobLinguistAssignmentAPIobject includes a job descriptor and a list ofXTMStepLinguistAssignmentAPIobjects, which are described in point 1.startProject()
Starts the given projects. It requires a list of project descriptors. All jobs in the projects are started, and Linguists receive emails about their tasks.
findProject()
This method can be used to search for projects. It is necessary to specify search parameters in the
XTMFilterProjectAPIobject. It returns all projects matching the given criteria with details. There are two additional settings in the method’s objectXTMFindProjectOptionsAPI. TheprojectCreatorparameter filters the projects by the user who created them. Thepaginationparameter splits the returned project listing into pages and displays only the requested page. The number of projects listed on a page can be specified using thepageSizeparameter. Pagination is optional, and when it is not used, all projects are displayed on a single page. The user is specified in theLoginAPIobject (XTMProjectCreatorEnum).updateProject()
This method can be used to update project details. It requires a list of
XTMUpdateProjectAPIobjects specifying the projects to update. TheXTMUpdateProjectAPIobject includes the project descriptor, fields to update (name, description, and domain descriptor), project custom fields, and project translation properties to update. When the project domain is updated, estimates have to be recalculated. Custom fields can be set or changed for the project. TheXTMUpdateProjectTranslationPropertiesAPIobject includes translation properties that can be updated:allow editing ICE matches.
updateProjectActivity()
This method can be used to delete, activate, archive, or reanalyze specified projects. It requires a list of project descriptors and activity. There is an additional setting in the method options that filters the projects by the user who created them. The user is specified in the
LoginAPIobject (XTMProjectCreatorEnum).updateJobActivity()
This method can be used to cancel specific jobs. It requires a list of job descriptors and the activity to be set (available job activity states are listed in the
XTMJobActivityobject). Cancelled jobs are no longer processed, but they are not removed from projects.updateProjectWorkflow()
This method can be used to change the workflow for the specified project. It requires the project descriptor and the
XTMUpdateWorkflowAPIobject, where the workflow can be defined using theXTMWorkflowDescriptorAPIobject or definitions of workflow steps (the list ofXTMUpdateWorkflowStepAPIobjects).The
XTMUpdateWorkflowStepAPIobject includes the step descriptor, role, forward blocking type, and TM approval step.There are two algorithms for updating the workflow, which can be specified by the
XTM_WORKFLOW_MATCHenum:MATCH_NAMES– XTM Cloud tries to find the existing workflow step with the same name and updates the properties. Changing the step role will clear any assigned Linguists.NO_MATCH– XTM Cloud deletes the current workflow steps and creates new ones.
updateJobGroupWorkflow()
This method can be used to change the workflow for a specified group of project jobs. It requires the
XTMJobGroupDescriptorAPIobject, which can be used to define a group of project jobs in the following ways:jobDescriptors – a list of project jobs from a single project.
projectDescriptor – all project jobs from a project.
projectDescriptor and projectTargetLanguages – a list of project jobs from a project for specific target languages.
The workflow definition and possible workflow update algorithms are described in the
updateProjectWorkflow()method.updateTargetLanguages()
This method can be used to change target languages for the specified project. It requires the
XTMUpdateTargetLanguagesAPIobject, which includes the project descriptor and objects that define changes in the target languages:XTMAddTargetLanguagesAPI– languages to add.XTMDeleteTargetLanguagesAPI– languages to delete.
This operation cannot be performed when the project is being analysed.
updateTranslationFilesMTOM()
This method can be used to add, update, or delete source files in a project using MTOM or BASE64, depending on the chosen webservice. It requires the project descriptor and a list of files. Source files can be added or updated only for all languages. By specifying target languages in the
xtmDeleteTranslationFilesAPIobject, source files can be deleted only for a selection of languages. This operation cannot be performed when the project is inactive or being analysed.updateTranslationFilesURL()
This method can be used to add, update, or delete source files in the project based on the file URL. It requires the project descriptor and a list of files. Source files can be added or updated only for all languages. By specifying target languages in the
xtmDeleteTranslationFilesAPIobject, source files can be deleted only for a selection of languages. This operation cannot be performed when the project is inactive or being analysed.moveJobWorkflow()
This method can be used to move the workflow forward or backward, or restart a failed automatic step for specific jobs. It requires the
XTMMoveJobWorkflowAPIobject, which consists of a list of theXTMJobWorkflowMoveAPIobjects. TheXTMJobWorkflowMoveAPIobject includes the job descriptor and the field that defines the type of movement that should be made (XTM_WORKFLOW_MOVE).Additional settings:
concurrentStepsAsOne– defines if concurrent steps should be treated as one.mailing– possibility to disable email notifications (XTMMoveWorkflowMailing).
moveProjectWorkflow()
This method can be used to move the workflow forward or backward, or restart a failed automatic step for the specific project. It requires the
XTMMoveProjectWorkflowAPIobject, which includes the project descriptor and the field that defines the type of movement that should be made (XTM_WORKFLOW_MOVE). Additional settings are the same as under themoveJobWorkflow()method.checkProjectAnalysisCompletion()
Checks if the analysis of the project and its jobs is completed. This method requires a project descriptor and returns the general project status (
XTM_PROJECT_COMPLETION_STATUS) and status for each job (XTM_JOB_COMPLETION_STATUS).checkJobAnalysisCompletion()
Checks if the analysis of the job is completed. This method requires a list of job descriptors and returns the status for each job (
XTM_JOB_COMPLETION_STATUS).checkProjectCompletion()
Checks if the project and jobs are completed. This method requires the project descriptor and returns
the general project status (
XTM_PROJECT_COMPLETION_STATUS).the status for each job
(XTM_JOB_COMPLETION_STATUS).the locked status for each job (
XTMJobLockingStatusEnum)– provides locked status information for segments locked in a
TIPPpackage that has been downloaded by a user. If the segments are locked, the target file cannot be generated or uploaded by anyone else.the status for all workflow steps in the job (
XTM_STEP_COMPLETION_STATUS).the status for all automatic workflow steps in the job (
XTM_AUTOSTEP_COMPLETION_STATUS).
checkJobCompletion()
Checks if the job is completed. This method requires a list of the job descriptors and returns:
the status for each job (
XTM_JOB_COMPLETION_STATUS).the locked status for each job (
XTMJobLockingStatusEnum).the status for all workflow steps in the job (
XTM_STEP_COMPLETION_STATUS).the status for all automatic workflow steps in the job (
XTM_AUTOSTEP_COMPLETION_STATUS).
updateJobStepProperty()
This method can be used to update workflow step due dates for specific jobs and set a due date for the entire project.
updateProjectStepProperty()
This method can be used to update workflow step due dates for all jobs in translation into the specified target languages and set a due date for the entire project.
updateJobWorkflowActivity()
This method can be used to finish, reopen or reset the workflow for specific jobs. A workflow activity setting should be set using the
XTM_WORKFLOW_ACTIVITYenumeration type.updateProjectWorkflowActivity()
This method can be used to finish, reopen or reset the workflow for all jobs in the specified projects. A workflow activity setting should be set using the
XTM_WORKFLOW_ACTIVITYenumeration type.findAnalysisTemplates()
This method can be used to search for analysis templates. It returns all global templates and templates for customers from the list that can be specified in the
XTMFindAnalysisTemplatesFilterAPIobject.findWorkflow()
This method can be used to search for workflow definitions. It returns active definitions that match the given criteria. Optional search parameters, such as the list of workflow IDs or workflow names can be specified in the
XTMFindWorkflowFilterAPIobject.
XTM_WORKFLOW_MOVE – list of possible types of workflow moves:
Option | Description |
|---|---|
| The workflow will be moved forward. |
| The workflow will be moved backward. |
| The failed automatic step will be restarted. |
XTM_PROJECT_COMPLETION_STATUS – the possible project completion statuses:
Option | Description |
|---|---|
| All jobs in the given project are still processing. |
| At least one job in the given project is completed. |
| All jobs in the given project are completed. |
XTM_JOB_COMPLETION_STATUS – the possible job completion statuses:
Option | Description |
|---|---|
| A job is still processing. |
| A job could not be completed. |
| A job is completed successfully. |
XTM_STEP_COMPLETION_STATUS – the possible workflow step completion statuses:
Option | Description |
|---|---|
| A workflow step is still processing. |
| A workflow step is completed successfully. |
| A workflow step is not started. |
XTM_AUTOSTEP_COMPLETION_STATUS – the possible completion statuses for auto workflow steps:
Option | Description |
|---|---|
| An auto workflow step has been completed successfully. |
| An auto workflow step could not be completed. |
XTMJobLockingStatusEnum – the possible job locked statuses:
Option | Description |
|---|---|
| A job is locked. |
XTMProjectCreatorEnum – provides an option for filtering the projects by project creator:
Option | Description |
|---|---|
| Projects created by the user specified in the LoginAPI object. |
XTM_WORKFLOW_ACTIVITY – available workflow states:
Option | Description |
|---|---|
| Sets the workflow state as finished. |
| Reopens the workflow. |
| Sets the workflow state as not started. |
XTMMoveWorkflowMailing – the possible options for email notifications:
Option | Description |
|---|---|
| Email notifications will be sent (default value if not set). |
| Email notifications will not be sent. |
updateJobActivity – the possible job activity statuses:
Option | Description |
|---|---|
| Cancels processing of a job without removing it from the project. |