Skip to content

Add "How to update plugins in Trados Studio" page #271

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ealbu merged 5 commits into from
Feb 18, 2026
Merged

Add "How to update plugins in Trados Studio" page #271

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
20fdb35
Add "How to update plugins in Trados Studio" page
ealbu Feb 17, 2026
bd087e3
...
ealbu Feb 17, 2026
f4c897a
Update MultiTerm API Changes
ealbu Feb 18, 2026
8b3b721
...
ealbu Feb 18, 2026
2b2513a
...
ealbu Feb 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
121 changes: 0 additions & 121 deletions articles/hints_tips/Update_Plugins/how_to_update_plugins_to_trados_studio_2024.md
View file
Open in desktop

This file was deleted.

180 changes: 76 additions & 104 deletions ...date_plugins_to_trados_studio_2024_sr1.md → ...o_update_plugins_to_trados_studio_2026.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,23 @@
# How to update plugins to Trados Studio 2024 SR1
# How to update plugins to Trados Studio - 2026 Release

The following are a list of changes and known issues to consider when updating your plugin to be compatible with Trados Studio 2024 SR1.
The following are a list of changes and known issues to consider when updating your plugin to be compatible with Trados Studio - 2026 Release.

## Transition to 64-Bit (x64)
Studio Quantum is released as a 64-bit (x64) version. As a result, plug-ins must also be rebuilt and updated to target x64 in order to remain compatible.

The following element must be added in a global property group of the .csproj file to target x64:


```xml
<PropertyGroup>
...
<PlatformTarget>x64</PlatformTarget>
...
</PropertyGroup>
```
> [!NOTE]
>
> If the project is not SDK-style, <PlatformTarget>x64</PlatformTarget> must be set for all relevant configurations (e.g., Debug and Release), otherwise some builds may still compile for a different platform.

## Update Plugin Framework Packages
Ensure you are using the latest plugin framework NuGet packages:
Expand All @@ -13,52 +30,50 @@ Ensure you are using the latest plugin framework NuGet packages:
- Search, select, and install/update the above packages.
- Accept license agreements to complete installation.


## Update Plugin Manifest

Review and update the manifest (`pluginpackage.manifest.xml`) at the project root as in the following example:
```xml
<?xml version="1.0" encoding="utf-8"?>
<PluginPackage xmlns="http://www.sdl.com/Plugins/PluginPackage/1.0">
<PlugInName>My plugin name</PlugInName>
<Version>1.1.0.0</Version>
<Version>1.0.0.0</Version>
<Description>My plugin description</Description>
<Author>Trados AppStore Team</Author>
<RequiredProduct name="TradosStudio" minversion="18.1" maxversion="18.1.9" />
<RequiredProduct name="TradosStudio" minversion="19.0" maxversion="19.9" />
</PluginPackage>
```
Ensure **RequiredProduct** reflects `minversion="18.1"` and `maxversion="18.1.9"`.

Ensure **RequiredProduct** reflects `minversion="19.0"` and `maxversion="19.9"`.

## Project References & Deployment Path
Update references and deployment settings in your .csproj:

### [Production](#tab/standard)

**References**: Set Trados Studio assemblies to use the Studio 18 path:
**References**: Set Trados Studio assemblies to use the Studio 19 path:
~~~xml
<Reference Include="Sdl.Desktop.IntegrationApi.Extensions">
<HintPath>$(MSBuildProgramFiles32)\Trados\Trados Studio\Studio18\Sdl.Desktop.IntegrationApi.Extensions.dll</HintPath>
<HintPath>$(ProgramFiles)\Trados\Trados Studio\Studio19\Sdl.Desktop.IntegrationApi.Extensions.dll</HintPath>
</Reference>
~~~

**Deployment Path:**
~~~xml
<PluginDeploymentPath>$(AppData)\Trados\Trados Studio\18\Plugins</PluginDeploymentPath>
<PluginDeploymentPath>$(AppData)\Trados\Trados Studio\19\Plugins</PluginDeploymentPath>
~~~

### [BETA](#tab/beta)

**References**: Set Trados Studio assemblies to use the Studio 18 Beta path:
**References**: Set Trados Studio assemblies to use the Studio 19 Beta path:
~~~xml
<Reference Include="Sdl.Desktop.IntegrationApi.Extensions">
<HintPath>$(MSBuildProgramFiles32)\Trados\Trados Studio\Studio18Beta\Sdl.Desktop.IntegrationApi.Extensions.dll</HintPath>
<HintPath>$(ProgramFiles)\Trados\Trados Studio\Studio19Beta\Sdl.Desktop.IntegrationApi.Extensions.dll</HintPath>
</Reference>
~~~

**Deployment Path:**
~~~xml
<PluginDeploymentPath>$(AppData)\Trados\Trados Studio\18Beta\Plugins</PluginDeploymentPath>
<PluginDeploymentPath>$(AppData)\Trados\Trados Studio\19Beta\Plugins</PluginDeploymentPath>
~~~

---
Expand All @@ -72,11 +87,12 @@ Update references and deployment settings in your .csproj:
> Once you have applied your changes in the project file, then reload project
> * In the **Solution Explorer**, select the projects you want to load (press **Ctrl** while clicking to select more than one project)
> * Then right-click on the project and choose **Reload Project**.

<br/>
>
> If the project is SDK-style, then unloading/reloading is unnecessary.

## Known Issues & Dependency Updates
### Dependency Version Changes
The following are a list of known issues and solutions that you might encounter depending on your settings and configuration:
### Dependency version changes
Standalone integrations may require binding redirects. Example for `App.config`:
```xml
<?xml version="1.0" encoding="utf-8" ?>
Expand Down Expand Up @@ -112,14 +128,34 @@ Standalone integrations may require binding redirects. Example for `App.config`:
</startup>
</configuration>
```
<br/>
### Breaking API Changes
`ITerminologyProviderCredentialStore` was removed (together with method parameters of this type).

## Breaking API Changes
`TerminologyProviderManager.DefaultTerminologyCredentialStore` was removed.

### Assembly Version Change Requires Recompilation
With Trados Studio 2024 SR1, all core Trados assemblies have had their **assembly version increased to 18.1.x.x** (reflecting the semantic versioning minor update). **This assembly version bump introduces a breaking change:** Any plugin or standalone tool that references Trados assemblies must be recompiled against the new release, even if no other code changes are required. Referencing outdated assemblies is not supported and will likely result in runtime failures due to version mismatches.
<br/>
`public TerminologyProviderType Type` property removed from `ITerminologyProvider`
#### Working with BCMs
The BCM-related classes have been moved from Sdl.LanguagePlatform.TranslationMemoryApito TradosStudio.BcmLite:
```xml
<Reference Include="TradosStudio.BcmLite">
<HintPath>$(ProgramFiles)\Trados\Trados Studio\Studio19\TradosStudio.BcmLite.dll</HintPath>
</Reference>
```
And some classes were renamed:

`LiteDocument` to `Document`

`LiteFragment` to `DocumentFragment`

The `LiteBcmVisitor` abstract class now includes two more methods:

```cs
public abstract void VisitFeedbackContainer(FeedbackContainer feedbackContainer);
public abstract void VisitStructure(StructureTag structureTag);
```

#### Assembly Version Change Requires Recompilation
With Trados Studio - 2026 Release, all core Trados assemblies have had their **assembly version increased to 19.x.x.x** (reflecting the semantic versioning minor update). **This assembly version bump introduces a breaking change:** Any plugin or standalone tool that references Trados assemblies must be recompiled against the new release, even if no other code changes are required. Referencing outdated assemblies is not supported and will likely result in runtime failures due to version mismatches.
### Multiterm API Changes
**Migrate from `Sdl.Multiterm.TMO.Interop.dll` to `TerminologyProviderManager`**

Expand All @@ -132,7 +168,7 @@ As part of the separation of MultiTerm from Trados Studio, the legacy assembly `
using Sdl.Terminology.TerminologyProvider.Core;

// Example URI for your termbase
string termbaseUriString = "file:///C:/Termbases/MyTermbase.sdltb";
string termbaseUriString = "ttb.file:///C:/Termbases/MyTermbase.ttb";
Uri termbaseUri = new Uri(termbaseUriString);

// Get the terminology provider singleton instance
Expand All @@ -153,8 +189,16 @@ if (!terminologyProvider.IsInitialized)
}

// Set up search parameters
var sourceLanguage = new CultureInfo("en-US");
var targetLanguage = new CultureInfo("it-IT");
var sourceLanguage = new DefinitionLanguage
{
Locale = "EN",
Name = "English"
};
var targetLanguage = new DefinitionLanguage
{
Locale = "DE",
Name = "German"
};
string segmentText = "Insert your source segment text here";
int maxResultsCount = 10;
bool targetRequired = true;
Expand All @@ -171,87 +215,15 @@ var searchResults = terminologyProvider.Search(

// Process or display results as needed...
```
**Note:** Replace any references to `Sdl.Multiterm.TMO.Interop.dll` with the modern `TerminologyProviderManager` API. This ensures compatibility with Trados Studio 2024 SR1 and future releases, and aligns with Trados ongoing architectural updates.
**Note:** Replace any references to `Sdl.Multiterm.TMO.Interop.dll` with the modern `TerminologyProviderManager` API. This ensures compatibility with Trados Studio - 2026 Release and future releases, and aligns with Trados ongoing architectural updates.

<br/>

## Credential Management Best Practices
### Trados.Community.Toolkit (formally SDL.Community.Toolkit)
A new version of the Trados Community Toolkit, version 6.0.2, has been released to support the latest version of Trados Studio - 2026 Release. This includes the following assemblies:

When building plugins or integrating third-party terminology and translation providers with Trados Studio, you should always manage credentials independently in your own codebase, especially when working with non-Trados services.
- [Trados.Community.Toolkit.Core](https://www.nuget.org/packages/Trados.Community.Toolkit.Core)
- [Trados.Community.Toolkit.LanguagePlatform](https://www.nuget.org/packages/Trados.Community.Toolkit.LanguagePlatform)
- [Trados.Community.Toolkit.Integration](https://www.nuget.org/packages/Trados.Community.Toolkit.Integration)
- [Trados.Community.Toolkit.FileType](https://www.nuget.org/packages/Trados.Community.Toolkit.FileType)
- [Trados.Community.Toolkit.ProjectAutomation](https://www.nuget.org/packages/Trados.Community.Toolkit.ProjectAutomation)

**Key Points:**
- Built-in credential storage in Trados Studio is only required when you need to access native Trados resources (e.g., file-based translation memories, Language Cloud).
- For all other scenarios, including any third-party or custom service integration, you should implement your own secure mechanism for storing and retrieving credentials.
- Managing credentials independently enhances security and gives you greater flexibility and control.

**Best Practice:**
Always use your own secure credential management system, unless your integration specifically requires direct access to Trados resources.

---

### Example: Managing Credentials Securely
Below is an example showing how you can implement credential management using Windows Credential Manager. This strategy may be adapted to use other secure stores as required by your environment or policies.

**Credential Store Interface:**
```csharp
public interface ICredentialStore
{
void SaveCredential(string key, string username, string password);
(string Username, string Password)? GetCredential(string key);
void RemoveCredential(string key);
}
```

**Sample Windows Credential Manager Implementation**
*Install the [CredentialManagement](https://www.nuget.org/packages/CredentialManagement/) NuGet package for this sample:*

```csharp
using CredentialManagement;

public class WindowsCredentialStore : ICredentialStore
{
public void SaveCredential(string key, string username, string password)
{
var cred = new Credential
{
Target = key,
Username = username,
Password = password,
PersistanceType = PersistanceType.LocalComputer
};
cred.Save();
}

public (string Username, string Password)? GetCredential(string key)
{
var cred = new Credential { Target = key };
if (cred.Load())
{
return (cred.Username, cred.Password);
}
return null;
}

public void RemoveCredential(string key)
{
var cred = new Credential { Target = key };
cred.Delete();
}
}
```

**How to Use in Your Integration**
```csharp
// Example usage
var credentialStore = new WindowsCredentialStore();
var credentials = credentialStore.GetCredential("your-provider-key");
if (credentials.HasValue) {
var username = credentials.Value.Username;
var password = credentials.Value.Password;
// Use credentials securely...
} else {
// Handle missing credentials scenario
}
```
**Note:** Using your own credential store ensures future compatibility, enhances security, and keeps your integration flexible as Trados Studio and its APIs evolve.

Loading