Difference between revisions of "Command Center User's Guide"
(→Command Center Licenses) |
(→API Reference) |
||
| (151 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
= Roles = |
= Roles = |
||
| + | [[File:CCListofUsers.jpg|600px|center]] |
||
| − | (Admin, Manager, Developer, Translator) |
||
| + | Command Center requires users to login. Each user created in Command Center is assigned a role that defines the operations that can be completed by the user. There are five roles defined: |
||
| − | == Tasks == |
||
| + | *[[Command_Center_Roles#Administrator|Administrator]] |
||
| − | == [[ Command Center Licenses ]] == |
||
| + | *[[Command_Center_Roles#Manager|Manager]] |
||
| − | * [[ Command_Center_Licenses#Configure_Globalyzer_License | Configure Globalyzer License ]] [Admin] |
||
| + | *[[Command_Center_Roles#Developer and Translator|Developer]] |
||
| − | * Configure Localyzer License [Admin] |
||
| + | *[[Command_Center_Roles#Developer and Translator|Translator]] |
||
| − | * View Licenses [Admin, Manager, Developer, Translator] |
||
| + | *[[Command_Center_Roles#API User|API User]] |
||
| + | * The right column shows who is logged in (bold) and when the last time users were logged in. |
||
| − | == [[ Command Center Users ]] == |
||
| + | * An API in the example shows the key in red to indicate that it is expired. |
||
| − | * Create User [Admin] |
||
| − | * Edit User [Admin] |
||
| − | * Delete User [Admin] |
||
| − | * Search/Sort [Admin,Manager, Developer, Translator] |
||
| − | * View [Admin,Manager, Developer, Translator] |
||
| + | = Global Settings = |
||
| − | == [[ Command Center Teams ]] == |
||
| + | |||
| − | * Create Team [Admin] |
||
| + | When logged in to Command Center, any user can select the Settings icon [[File:SettingsIcon.jpg|40px]] to access the Global Settings page. |
||
| − | * Edit Team [Admin] |
||
| + | |||
| − | * Delete Team [Admin] |
||
| + | [[File:GlobalSettingsPageLocked.jpg|700px|center]] |
||
| − | * Search/Sort [Admin,Manager, Developer, Translator] |
||
| + | |||
| − | * View [Admin,Manager, Developer, Translator] |
||
| + | All user roles see the same Global Settings page, but the Administrator has the Maintenance mode slider. Not all users can select the various cards. |
||
| + | |||
| + | Notice that some of the cards have a lock icon [[File:LockIcon.jpg|50px]]. This indicates that the card is not selectable unless the system is in Maintenance Mode. |
||
| + | |||
| + | == Maintenance Mode == |
||
| + | [Administrator] |
||
| + | |||
| + | In order to modify some of the settings, the system must be in Maintenance mode. Only an Administrator user can toggle the mode on and off. When in Maintenance Mode, the lock icon is removed for the Administrator user. For the other users, some of the lock icons are removed. While in Maintenance mode, projects will not be analyzed. |
||
| + | |||
| + | [[File:MaintenanceMode.jpg|700px|center]] |
||
| + | |||
| + | The system needs to be in Maintenance mode to |
||
| + | *Install and Update licenses |
||
| + | *Create and edit machine translation connections and translation management configurations. |
||
| + | *Create and edit data source credentials |
||
| + | *Create and edit system files |
||
| + | |||
| + | When in Maintenance mode, projects don't run, they just get queued. The queue icon at the top of the screen shows if there are jobs queued. Hovering over the icon shows what jobs are in the queue. |
||
| + | |||
| + | == [[ Licenses ]] == |
||
| + | * [[ Licenses#View_Licenses | View Licenses ]] |
||
| + | * [[ Licenses#Configure_Globalyzer_License | Configure Globalyzer License ]] |
||
| + | * [[ Licenses#Configure_Localyzer_License | Configure Localyzer License ]] |
||
| + | |||
| + | == [[ System Email Sender]] == |
||
| + | * [[ System Email Sender#View Email Configuration | View Email Configuration]] |
||
| + | * [[ System Email Sender#Configure and Test Email |Configure and Test Emails ]] |
||
| + | * [[System Email Sender#Configuring Project Email Recipients|Configuring Project Email Recipients]] |
||
| + | |||
| + | == [[ Users & Teams ]] == |
||
| + | * [[ Users_&_Teams#View_Users | View Users]] |
||
| + | * [[ Users_&_Teams#Create_and_Configure_Users | Create and Configure Users ]] |
||
| + | * [[ Users_&_Teams#Search and Sort Users | Search and Sort Users]] |
||
| + | |||
| + | * [[ Users_&_Teams#View_Teams | View Teams]] |
||
| + | * [[ Users_&_Teams#Create_and_Configure_Teams | Create and Configure Teams ]] |
||
| + | * [[ Users_&_Teams#Search and Sort Teams | Search and Sort Teams]] |
||
== [[Data Source Credentials ]] == |
== [[Data Source Credentials ]] == |
||
| + | *[[Data_Source_Credentials#View_Data_Source_Credentials | View Data Source Credentials]] |
||
| − | * Configure MT [Admin] |
||
| + | *[[Data_Source_Credentials#Create_and_Configure_Data_Source_Credentials |Create and Configure Data Source Credentials]] |
||
| − | MT |
||
| + | *[[Data_Source_Credentials#Search_and_Sort_Data_Source_Credentials |Search and Sort Data Source Credentials]] |
||
| − | (Tasks per MT) |
||
| + | |||
| − | TMS |
||
| + | == [[Machine_Translation_and_Translation_Management_System | Translation Management System & Machine Translator Connections]]== |
||
| − | (Tasks per TMS) |
||
| + | |||
| − | Tags |
||
| + | *[[Machine_Translation_and_Translation_Management_System#View_MT_Connections | View MT Connections]] |
||
| − | System Logs |
||
| + | *[[Machine_Translation_and_Translation_Management_System#Create_and_Configure_MT_Connections | Create and Configure MT Connections]] |
||
| − | System Files |
||
| + | *[[Machine_Translation_and_Translation_Management_System#View TMS Connections | View TMS Connection]] |
||
| − | Advanced Settings |
||
| + | *[[Machine_Translation_and_Translation_Management_System#Create and Configure TMS Connections | Create and Configure TMS Connections]] |
||
| − | |||
| + | *[[Machine_Translation_and_Translation_Management_System#Search_and_Sort_Connections | Search and Sort Connections]] |
||
| − | Project Overview |
||
| + | |||
| − | Create |
||
| + | == [[ Project Tags & Tokens ]] == |
||
| − | Update |
||
| + | |||
| − | Delete |
||
| + | *[[Project_Tags_&_Tokens#View_Tags | View Tags]] |
||
| − | |||
| + | *[[Project_Tags_&_Tokens#Create_and_Configure_Tags | Create and Configure Tags ]] |
||
| − | Search |
||
| + | *[[Project_Tags_&_Tokens#Search_and_Sort_Tags | Search and Sort Tags ]] |
||
| − | Filter |
||
| + | |||
| − | Sort |
||
| + | == [[ System Logs & Events ]] == |
||
| − | Individual Project |
||
| + | The System Logs and Events card can be accessed by all users. |
||
| − | Run |
||
| + | |||
| − | [...] |
||
| + | *[[System Logs & Events#System Events | View System Events]] |
||
| − | Send Translations ... |
||
| + | *[[System Logs & Events#System Logs | View System Logs]] |
||
| − | [....] |
||
| + | *[[System Logs & Events#Search System Logs | Search & Sort System Logs]] |
||
| − | |||
| + | *[[System Logs & Events#Manage System Logs | Manage System Logs]] |
||
| − | * Troubleshooting |
||
| + | |||
| − | |||
| + | == [[ System Files ]] == |
||
| − | * FAQ |
||
| + | |||
| − | Why am I not seeing all the projects? [Manager, Developer, Translator] |
||
| + | *[[System Files#Creating System Files|Creating System Files]] |
||
| + | *[[System Files#Editing System Files|Editing System Files]] |
||
| + | |||
| + | == [[ Advanced Settings ]] == |
||
| + | |||
| + | *[[Advanced_Settings#System_Environment_Variables| System Environmental Variables]] |
||
| + | *[[Advanced_Settings#Advanced_Git_Settings |Advanced Git Settings]] |
||
| + | *[[Advanced_Settings#Translation_Kit_Due_Dates|Translation Kit Due Dates]] |
||
| + | *[[Advanced_Settings#Task_Schedule|Task Schedule]] |
||
| + | *[[Advanced_Settings#Other Advanced Settings |Other Advanced Settings]] |
||
| + | *[[Advanced_Settings#Dashboard_Issues_Migration|Dashboard Issues Migration]] |
||
| + | |||
| + | = Projects = |
||
| + | |||
| + | When logged in to Command Center, any user can select the Lingoport icon [[File:LingoportIcon.jpg|40px]] to access the Projects page. |
||
| + | |||
| + | [[File:ProjectsPage.jpg|700px|center]] |
||
| + | |||
| + | The projects are listed with their Group Name, the Project Name and the module (which is often the repository branch). The combination of these must be unique for each project. For example, the Group Name is 'CET', the project name is 'IOS' and the module is 'testing'. |
||
| + | The projects the user will see depend on their role and the access they have been given. |
||
| + | * Administrator users will see all the projects. |
||
| + | * Manager, Developer and Translator users will see only the projects their user or team has access to. |
||
| + | * In the example above, only the 'IOS' projects are being searched for. |
||
| + | * Only Administrators and Managers can create, edit or delete projects. |
||
| + | * All users can run or analyze a project and view the results, issues and logs. |
||
| + | |||
| + | == [[ Projects Overview |Projects Overview ]] == |
||
| + | |||
| + | *[[Projects_Overview#Introduction | Introduction to the Projects page]] |
||
| + | *[[Step_by_Step_Project_Creation|Create Projects]] |
||
| + | *[[Projects_Overview#Search_Projects | Search Projects ]] |
||
| + | *[[Projects_Overview#Filter_Projects | Filter Projects ]] |
||
| + | *[[Projects_Overview#Sort_Projects | Sort Projects ]] |
||
| + | |||
| + | == [[ Individual Project Tasks ]] == |
||
| + | *[[Individual_Project_Tasks#Clean_workspace_and_run_project | Clean workspace and run project ]] |
||
| + | |||
| + | *[[Individual_Project_Tasks#Overview | Overview ]] |
||
| + | *[[Individual_Project_Tasks#Globalyzer | Globalyzer ]] |
||
| + | *[[Individual_Project_Tasks#Localyzer | Localyzer ]] |
||
| + | *[[Individual_Project_Tasks#Project_logs | Project logs ]] |
||
| + | *[[Individual_Project_Tasks#Issues | Issues ]] |
||
| + | *[[Individual_Project_Tasks#Project_configuration | Project configuration ]] |
||
| + | |||
| + | = [[API Reference]] = |
||
| + | * [[API_Reference|API Reference Page]] |
||
| + | ** [[API_Reference#List_Command_Center_projects|List Command Center Projects]] |
||
| + | ** [[API_Reference#Command_Center_Project_Status|Command Center Project Status]] |
||
| + | ** [[API_Reference#Command_Center_Translate|Command Center Project Translate]] |
||
| + | ** [[API_Reference#Pseudo-localize_a_Command_Center_Project| Pseudo-localize a Command Center Project]] |
||
| + | ** [[API_Reference#Duplicate_Command_Center_project|Duplicate Command Center Project]] |
||
| + | |||
| + | = [[ Figma API Project ]] = |
||
| + | |||
| + | |||
| + | |||
| + | * Run |
||
| + | * [...] |
||
| + | * Send Translations ... |
||
| + | * [....] |
||
Latest revision as of 16:47, 18 April 2024
Roles
Command Center requires users to login. Each user created in Command Center is assigned a role that defines the operations that can be completed by the user. There are five roles defined:
- The right column shows who is logged in (bold) and when the last time users were logged in.
- An API in the example shows the key in red to indicate that it is expired.
Global Settings
When logged in to Command Center, any user can select the Settings icon 
to access the Global Settings page.
All user roles see the same Global Settings page, but the Administrator has the Maintenance mode slider. Not all users can select the various cards.
Notice that some of the cards have a lock icon 
. This indicates that the card is not selectable unless the system is in Maintenance Mode.
Maintenance Mode
[Administrator]
In order to modify some of the settings, the system must be in Maintenance mode. Only an Administrator user can toggle the mode on and off. When in Maintenance Mode, the lock icon is removed for the Administrator user. For the other users, some of the lock icons are removed. While in Maintenance mode, projects will not be analyzed.
The system needs to be in Maintenance mode to
- Install and Update licenses
- Create and edit machine translation connections and translation management configurations.
- Create and edit data source credentials
- Create and edit system files
When in Maintenance mode, projects don't run, they just get queued. The queue icon at the top of the screen shows if there are jobs queued. Hovering over the icon shows what jobs are in the queue.
Licenses
System Email Sender
Users & Teams
Data Source Credentials
- View Data Source Credentials
- Create and Configure Data Source Credentials
- Search and Sort Data Source Credentials
Translation Management System & Machine Translator Connections
- View MT Connections
- Create and Configure MT Connections
- View TMS Connection
- Create and Configure TMS Connections
- Search and Sort Connections
Project Tags & Tokens
System Logs & Events
The System Logs and Events card can be accessed by all users.
System Files
Advanced Settings
- System Environmental Variables
- Advanced Git Settings
- Translation Kit Due Dates
- Task Schedule
- Other Advanced Settings
- Dashboard Issues Migration
Projects
When logged in to Command Center, any user can select the Lingoport icon 
to access the Projects page.
The projects are listed with their Group Name, the Project Name and the module (which is often the repository branch). The combination of these must be unique for each project. For example, the Group Name is 'CET', the project name is 'IOS' and the module is 'testing'. The projects the user will see depend on their role and the access they have been given.
- Administrator users will see all the projects.
- Manager, Developer and Translator users will see only the projects their user or team has access to.
- In the example above, only the 'IOS' projects are being searched for.
- Only Administrators and Managers can create, edit or delete projects.
- All users can run or analyze a project and view the results, issues and logs.
Projects Overview
Individual Project Tasks
API Reference
Figma API Project
- Run
- [...]
- Send Translations ...
- [....]
