Blogs

IMPORTANT! Implementation of previously notified changes

2023-09-05T15:25:11Z

In line with our policy, any deprecated functionality or breaking API changes are announced 6 months in advance. With this in mind, the following two changes require notification. Enforcement of validation of fields when a project is created Previously announced in February 2023, May 2023, and August 2023. The dueBy, location, and languageDirection fields will be required when creating a new proje...(read more)

Language Cloud Public API Updates [August 2022]

2022-08-17T10:49:39Z

What's new Visit the What's new page to find out more. Recent changes include: There are new endpoints for downloading project quotes New versions of source and target files can be uploaded New information about file formats What's deprecated Visit the What's deprecated page to find out more. Recent changes include: The Export Quote endpoint will be retired in Dece...(read more)

Language Cloud Public API Updates [July 2022] #2

2022-08-10T09:30:16Z

What's new Visit the What's new page to find out more. Recent changes include: Guidelines for How to use location and folders Details on How to report an API issue (read more)

Language Cloud Public API Updates [July 2022]

2022-07-05T08:09:52Z

For developers who want to integrate with RWS Language Cloud applications, the Public API provides a rich feature set. New features and functionality are being added to the API all the time so I thought I would take this opportunity to let you know what's been happening recently. What's new There is a specific section of the API documentation where you can find a list of newly released endpoints o...(read more)

Retrieve the list of active Projects available in SDL WorldServer using the REST API

2019-04-16T15:57:00Z

In this article, I would like to present a method for retrieving the list of active Projects in SDL WorldServer using the REST API. The method takes two parameters: wsBaseUrl token The wsBaseUrl must be the <serverURL>:<portnumber> where your WorldServer instance is running. The second parameter is a security token, which can be retrieved by using the SDL WorldServer REST API as...(read more)

Complete a Task Step in SDL WorldServer using the REST API

2019-04-16T15:46:00Z

In this article, I would like to present a method for completing an active Task Step in SDL WorldServer using the REST API. The method takes three parameters: wsBaseUrl token completeTaskStepRequestBody The wsBaseUrl must be the <serverURL>:<portnumber> where your WorldServer instance is running. The second parameter is a security token, which can be retrieved by using the ...(read more)

Download an asset associated with a TASK in SDL WorldServer using the REST API

2019-04-16T15:16:00Z

In this article, I would like to present a method for downloading a file (asset) associated with a Task in SDL WorldServer using the REST API. The method takes six parameters: wsBaseUrl token taskId assetName downloadLocation assetLocationType The wsBaseUrl must be the <serverURL>:<portnumber> where your WorldServer instance is running. The second parameter is a security to...(read more)

Get a list of Tasks from a Project in SDL WorldServer using the REST API

2019-04-16T15:07:00Z

In this article, I would like to present a method for retrieving a list of Tasks from a Project in SDL WorldServer using the REST API. The method takes three parameters: wsBaseUrl token projectId The wsBaseUrl must be the <serverURL>:<portnumber> where your WorldServer instance is running. The second parameter is a security token, which can be retrieved by using the SDL Wor...(read more)

Create Project Groups in SDL WorldServer using the REST API

2019-04-16T14:33:00Z

In this article, I would like to present a method for creating a Project Group in SDL WorldServer using the REST API. The method takes three parameters: wsBaseUrl token projectGroups The wsBaseUrl must be the <serverURL>:<portnumber> where your WorldServer instance is running. The second parameter is a security token, which can be retrieved by using the SDL WorldServer REST API&...(read more)

Upload files to SDL WorldServer using the REST API

2019-04-16T13:59:00Z

In this article, I would like to present a method for uploading a collection of files to SDL WorldServer using the REST API. The method takes three parameters: wsBaseUrl token files The wsBaseUrl must be the <serverURL>:<portnumber> where your WorldServer instance is running. The second parameter is a security token, which can be retrieved by using the SDL WorldServer REST API a...(read more)

Uploading customization package to SDL WorldServer using Java

2017-11-27T17:49:00Z

In this article, I present a solution for uploading a customization package (zip file containing a desc.xml) using a Java method.

Click here to view the upload customization method code

The method takes three parameters:

wsBaseUrl
token
customizationFile

The wsBaseUrl must be the <serverURL>:<portnumber> where your WorldServer instance is running.

The second parameter is a security token, which can be retrieved by using the SDL WorldServer REST API as explained here.

The third parameter is the customization zip file containing the compiled customization classes and the XML descriptor file.

This solution relies on the same "management_customization" servlet used by the WorldServer UI for uploading customizations. Certain parameter values (i.e. "comp_type", "submittedBy") are hard-coded to impersonate the UI selection process and allow the upload to proceed.

Connecting to SDL WorldServer using the /login REST API call

2017-11-27T17:34:00Z

It is now possible to connect to SDL WorldServer and perform a number of actions by using the WorldServer REST API. The REST API documentation is available from your WorldServer instance by accessing <serverURL>:<portnumber>/ws-api/docs/ws-api-doc-v1.html.

In this article I present a method for connecting to SDL WorldServer and fetching a security token to be used in all subsequent API calls.

Click here to view the login method code

The method takes three parameters:

wsBaseUrl
username
password

The wsBaseUrl must be the <serverURL>:<portnumber> where your WorldServer instance is running. The login method will append the "/ws-api/v1/login" path required for invoking the REST-based login call.

As mentioned earlier, the call returns a security token to be used in all subsequent API calls.

Building a Custom Servlet for SDL WorldServer

2017-06-12T16:48:00Z

SDL WorldServer allows customers to expand WorldServer capabilities through pluggable components. There are several exit points in WorldServer through which custom code can be invoked to perform customer-specific operations.

Here are the types of pluggable components currently supported:

AIS Triggers: AIS stands for Asset Interface System and is the framework WorldServer uses to access content whether that content is in a content management system, a file system, a database, etc. Through a customized AIS trigger, it is possible to execute customer-specific actions in response to specific AIS-related events.
Automatic Actions: customized automatic actions to be executed within a WorldServer workflow.
Authentication: can be used to override the default password validation strategy.
Filters: allow the support of new types of assets within WorldServer.
Notification Service: allow email messages to be customized.
Servlets: customized WorldServer-aware servlets.
TM Services: TM stands for Translation Memory. It is possible to provide alternative services to be used in place of the exposed TM services.

Developers use the SDL WorldServer Software Development Kit (SDK) to write these pluggable components. The implementation begins by extending an abstract class corresponding to the type of component you want to create. For example, the com.idiominc.wssdk.component.servlet.WSHttpServlet abstract class needs to be extended in order to implement a customized servlet.

The abstract classes provide us with a handle to the WSContext object, which provides us with access to the service managers.

I've implemented a very simple servlet for demonstration purposes. I'm using Maven in my project, so I first installed the wssdk-server jar file in my local repository using the following.

mvn install:install-file -Dfile=wssdk-server.jar -DgroupId=com.idiominc -DartifactId=wssdk-server -Dversion=11.1.0.3909 -Dpackaging=jar

There are only two dependencies in the pom.xml file.

<dependencies>
    <dependency>
        <groupId>com.idiominc</groupId>
        <artifactId>wssdk-server</artifactId>
        <version>11.1.0.3909</version>
    </dependency>
    <dependency>
        <groupId>javax.servlet</groupId>
        <artifactId>javax.servlet-api</artifactId>
        <version>3.1.0</version>
        <scope>provided</scope>
    </dependency>
</dependencies>

The ProjectInfo servlet outputs project information from all projects available in the system (active and inactive). It demonstrates the use of the user and workflow managers for gathering information.

ProjectInfo.java

Deploying the custom servlet

The steps for installing the custom servlet include:

Creating a WorldServer component deployment descriptor
Creating a component archive (zip file) containing the component classes and, if required, including all of the non-WorldServer library dependencies.
Using the WorldServer UI to deploy the component.

The component descriptor is an XML file that provides WorldServer with the information needed to identify and register the uploaded component. Only one descriptor file, named as desc.xml, is provided per deployment. If your project contains multiple implementations (i.e. servlets, filters), all references are included within a unique descriptor file.

The contents of my project's desc.xml is shown below.

<components>
    <servlet class="com.worldservertraining.ProjectInfo"/>
</components>

Create a zip file containing the XML descriptor file and your classes. Note that the desc.xml file must be at the base of the zip file. In addition, your Java classes must be placed in the zip file under the appropriate Java package structure. There cannot be any jar or zip files inside your deployment zip file. In order to use supporting libraries in your projects, you can either expand these supporting libraries in your zip package or have them added to WorldServer's classpath.

Once the zip package is ready, you can use WorldServer's UI to deploy your customizations. Your WorldServer user will need to have the right privilege to perform the following steps.

Login to WorldServer and click the Management option.

Click the Administration option.

Click the Customization option.

Select the appropriate component type and click the Add button to upload your zip package. If your deployment includes components of different types, select any option from the drop-down. WorldServer will workout the components from the descriptor file anyway.

Once uploaded, providing no errors are displayed, you should see your customizations listed as shown below.

The Name, Description and Version properties are taken from the respective properties in the bespoke component object.

Testing the custom servlet

Of course testing depends on the type of component you have deployed. For instance, an automatic action (auto_action) component will require an association with a workflow step for testing to work.

Invoking a servlet involves requesting the following URL.

http://localhost:8080/ws-legacy/ws_ext?servlet=<servlet_name>

Therefore, our ProjectInfo servlet would be requested using:

http://localhost:8080/ws-legacy/ws_ext?servlet=project_info

Options to extend and customize Trados Studio

2017-03-08T16:48:22Z

I'm absolutely sure that Trados Studio is the most customizable product on the market. To me this a no brainer; all you have to do is to go to the SDL AppStore and have a look at the number of plugins and applications that are available. And that is not all, because there are at least the same number of customizations carried out which are not published on the store because they are built to f...(read more)

SDL Studio plugin dependencies cleanup

2016-09-30T13:27:40Z

I decided to write this article after I got a question on my last blog article, SDL Studio plugin manifest, about an issue with files that are overridden during an SDL Studio plugin build. Although this issue is quite specific I received questions with similar situations from other people and the root cause of this problem is related to how you manage SDL Studio plugin dependencies, or, in other w...(read more)