Difference between revisions of "Command Center User's Guide"

From Lingoport Wiki
Jump to: navigation, search
(API Reference)
(Roles)
 
(23 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
= Roles =
 
= Roles =
[[File:CCListofUsers.jpg|600px|center]]
+
[[File:ListofUsers.png|600px|center]]
   
 
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:
 
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:
Line 9: Line 9:
 
*[[Command_Center_Roles#Developer and Translator|Translator]]
 
*[[Command_Center_Roles#Developer and Translator|Translator]]
 
*[[Command_Center_Roles#API User|API User]]
 
*[[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.
  +
* An API in the example shows the key in red to indicate that it is expired.
   
 
= Global Settings =
 
= Global Settings =
Line 14: Line 17:
 
When logged in to Command Center, any user can select the Settings icon [[File:SettingsIcon.jpg|40px]] to access the Global Settings page.
 
When logged in to Command Center, any user can select the Settings icon [[File:SettingsIcon.jpg|40px]] to access the Global Settings page.
   
[[File:GlobalSettingsPageLocked.jpg|700px|center]]
+
[[File:GlobalSettings.png|700px|center]]
   
 
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.
 
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.
Line 23: Line 26:
 
[Administrator]
 
[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. While in Maintenance mode, projects will not be analyzed.
+
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]]
+
[[File:MaintenanceMode.png|700px|center]]
   
  +
When clicking on any of the cards, a navigation bar and the license toggle appear. The Administrator can switch the toggle to set or reset the maintenance mode:
The system needs to be in maintenance mode to
 
*Update licenses
 
*Edit MT connections
 
*Edit data source credentials
 
*Edit system files
 
   
  +
[[File:License View.png|700px|center]]
You can create MT connections, datasource credentials and system files without being in Maintenance mode. Changes and deletions can only be made in Maintenance mode.
 
   
  +
The system needs to be in Maintenance mode to
When in Maintenance mode, projects don't run, they just get queued.
 
  +
*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 ]] ==
Line 103: Line 108:
 
[[File:ProjectsPage.jpg|700px|center]]
 
[[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.
 
The projects the user will see depend on their role and the access they have been given.
 
* Administrator users will see all the projects.
 
* Administrator users will see all the projects.
* Manager, Developer and Translator users will see only the projects their user or team has access to.
+
* 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.
 
* 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.
 
* All users can run or analyze a project and view the results, issues and logs.
Line 112: Line 119:
   
 
*[[Projects_Overview#Introduction | Introduction to the Projects page]]
 
*[[Projects_Overview#Introduction | Introduction to the Projects page]]
*[[Step_by_Step_Project_Creation|Create and Configure Projects]]
+
*[[Step_by_Step_Project_Creation|Create Projects]]
 
*[[Projects_Overview#Search_Projects | Search Projects ]]
 
*[[Projects_Overview#Search_Projects | Search Projects ]]
 
*[[Projects_Overview#Filter_Projects | Filter Projects ]]
 
*[[Projects_Overview#Filter_Projects | Filter Projects ]]
Line 123: Line 130:
 
*[[Individual_Project_Tasks#Globalyzer | Globalyzer ]]
 
*[[Individual_Project_Tasks#Globalyzer | Globalyzer ]]
 
*[[Individual_Project_Tasks#Localyzer | Localyzer ]]
 
*[[Individual_Project_Tasks#Localyzer | Localyzer ]]
*[[Individual_Project_Tasks#Console_logs | Console logs ]]
+
*[[Individual_Project_Tasks#Project_logs | Project logs ]]
 
*[[Individual_Project_Tasks#Issues | Issues ]]
 
*[[Individual_Project_Tasks#Issues | Issues ]]
 
*[[Individual_Project_Tasks#Project_configuration | Project configuration ]]
 
*[[Individual_Project_Tasks#Project_configuration | Project configuration ]]
   
 
= [[API Reference]] =
 
= [[API Reference]] =
  +
* [[API_Reference|API Reference Page]]
 
* [[API_Reference#List_Command_Center_projects|List Command Center Projects]]
 
* [[API_Reference#Get_Command_Center_Project_Status|Get Command Center Project Status]]
 
* [[API_Reference#Duplicate_Command_Center_project|Duplicate Command Center Project]]
 
   
 
= [[ Figma API Project ]] =
 
= [[ Figma API Project ]] =
 
 
 
* Run
 
* [...]
 
* Send Translations ...
 
* [....]
 

Latest revision as of 17:11, 29 October 2025

Roles

ListofUsers.png

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 SettingsIcon.jpg to access the Global Settings page.

GlobalSettings.png

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 LockIcon.jpg. 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.

MaintenanceMode.png

When clicking on any of the cards, a navigation bar and the license toggle appear. The Administrator can switch the toggle to set or reset the maintenance mode:

License View.png

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

Translation Management System & Machine Translator Connections

Project Tags & Tokens

System Logs & Events

The System Logs and Events card can be accessed by all users.

System Files

Advanced Settings

Projects

When logged in to Command Center, any user can select the Lingoport icon LingoportIcon.jpg to access the Projects page.

ProjectsPage.jpg

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