GroupShare PowerShell Toolkit
By Trados AppStore Team
Free
Description
The GroupShare API PowerShell Toolkit enables users to automate and manage various operations within GroupShare through PowerShell scripts. By utilising the GroupShare REST API, this toolkit provides a convenient and efficient way to handle tasks such as project management, resource handling, and user administration directly from the PowerShell console.
Key features include streamlined project creation and updates, translation memory management, and system configuration adjustments. 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 an on-premise GroupShare instance and have a role with Admin access.
Technical details
1.0.10.0 - Trados Studio (2024, 2022)
Support website: https://community.rws.com/product-groups/trados-portfolio/rws-appstore/f
Shared products:
- Trados Studio
- GroupShare
1.0.10.0 - Trados Studio (2024, 2022)
- Implemented a WIX Installer for the toolkit
1.0.0.0 - Trados Studio (2024, 2022)
- Initial release
Full instructions and user documentation is provided through the README to the GitHub Repository for this Toolkit.
GroupShare PowerShell Toolkit Summary
Overview:
The GroupShare API PowerShell Toolkit allows users to automate operations within GroupShare using the REST API. This toolkit is designed to streamline tasks such as project management, resource handling, and user administration through the PowerShell console.
Toolkit Components:
- Modules: PowerShell modules such as AuthenticationHelper, ProjectServerHelper, ResourcesHelper, UserManagerHelper, and more. Each module contains functions to handle specific GroupShare 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 installed on your system.
- Access to a GroupShare server with valid credentials for interaction.
- 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:
- Server Configuration:
- Set the $server parameter in each module's .psm1 file or specify the server details when importing the modules using the -ArgumentList parameter.
- Authentication:
- Configure the Sample_Roundtrip.ps1 script or other scripts with your GroupShare server URL and credentials (username and password) for authentication.
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:
- Import individual modules or load them all using:
powershell Copy code Import-Module -Name AuthenticationHelper -ArgumentList "https://your.groupshare.server/uri"
- Once imported, functions within each module can be executed for automating various GroupShare 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 full documentation and detailed instructions, please refer to the README in the GitHub Repository.
