Language Cloud PowerShell Toolkit
By Trados AppStore Team
Free
Description
The Language Cloud PowerShell Toolkit enables users to automate and manage various operations within Language Cloud through PowerShell scripts. By utilising the Language Cloud REST API, this toolkit provides a convenient and efficient way to handle tasks such as project creation, resource handling, and some administration overview directly from the PowerShell console.
Key features include streamlined project creation and project template updates, translation memory management, terminology management and an overview of users, users and workflows. With sample scripts and detailed help documentation, users can easily set up, customise, and run automation tasks to simplify their workflow.
Minimum Requirement: Must have access to Language Cloud Team tenant with relevant access rights based on user role.
Technical details
1.0.1.0 - Trados Studio cloud capabilities, Trados Accelerate, Trados Team, Trados Enterprise
1.0.1.0 - Trados Studio cloud capabilities(), Trados Accelerate(), Trados Team(), Trados Enterprise()
- Implemented a WIX Installer for the toolkit
1.0.0.0 - Trados Studio (2024, 2022), Trados Studio cloud capabilities(), Trados Team()
- Initial release
This documentation provides details on importing and using PowerShell modules included in the toolkit. Full instructions and user documentation is provided through the README to the GitHub Repository for this Toolkit.
Overview
The Language Cloud PowerShell Toolkit integrates with Language Cloud enabling users to script and automate actions using the publicly available APIs. The purpose of this toolkit is to automate project creation and retrieve essential resources through the PowerShell console.
Toolkit Components
- Modules: AuthenticationHelper, ProjectServerHelper, ResourcesHelper, UserManagerHelper, FileManagementHelper, WorkflowHelper and ReportingHelper. Each module contains functions to handle specific Language Cloud operations.
- Scripts: Sample scripts like Sample_Roundtrip.ps1 demonstrate practical usage of the toolkit for common tasks such as creating and managing projects.
- Samples: Example files included to illustrate typical automation workflows.
Getting Started
Requirements:
- PowerShell Version 7.4 or Higher
- Access to Language Cloud with adequite user rights and permissions
Installation:
- Download the toolkit files.
- Unblock the downloaded files as needed.
- Create necessary directories in your PowerShell user folder, such as Documents\PowerShell\Modules.
- Copy the relevant script and module files to the designated directories.
Configuration
After obtaining your Client ID, Client Secret, and Tenant ID update the script with the retrieved values. Example Sample_Roundtrip.ps1
Authentication
The Get-AccessKey function retrieves an authentication token and stores it as a PowerShell object for API use. To reduce repeated requests, it saves the token in a JSON file within the AuthenticationHelper module. Run
Get-AccessKey -id "Your_ClientId" -secret "Your_ClientSecret" -lcTenant "YourLcTenant"
Running Scripts
- Open PowerShell 7.4 or higher.
- Set the execution policy to Unrestricted if required (Set-ExecutionPolicy -ExecutionPolicy Unrestricted -Scope CurrentUser).
- Navigate to the folder where the script (e.g., Sample_Roundtrip.ps1) is stored.
- Run the script using .\Sample_Roundtrip.ps1.
Module Usage
- Use the Get-Module command to verify if the required modules are available in your PowerShell environment
- Import Modules
Import-Module -Name AuthenticationHelper Import-Module -Name ProjectHelper Import-Module -Name ResourcesHelper Import-Module -Name UsersHelper Import-Module -Name TerminologyHelper
- Once imported, functions within each module can be executed for automating various operations.
Help & Troubleshooting
- Use the Get-Help cmdlet to access detailed documentation for each function after the module is imported.
- Ensure all file paths are correctly configured, and the required modules are available in the Documents\PowerShell\Modules directory.
For detailed guidance and information on available endpoints, please refer to the API Documentation.
