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

From Lingoport Wiki
Jump to: navigation, search
(API Reference)
(API Reference)
Line 148: Line 148:
 
Example:
 
Example:
 
curl "http://localhost:8080/command-center/api/listprojects" -d '{"username":"figmaAPI","token":"CTMNzj**********CP"}' --header "Content-Type: application/json"
 
curl "http://localhost:8080/command-center/api/listprojects" -d '{"username":"figmaAPI","token":"CTMNzj**********CP"}' --header "Content-Type: application/json"
  +
  +
or
  +
curl "https://dockertest2.lingoport.io/command-center/api/listprojects" -d @listprojects.json --header "Content-Type: application/json"
  +
  +
listprojects.json:
  +
{
  +
"username":"figmaAPI",
  +
"token":"CTMNzj**********CP"
  +
}
   
 
*get Command Center Project Status
 
*get Command Center Project Status

Revision as of 15:41, 2 August 2023

Roles

CCListofUsers.jpg

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:

  1. Administrator
  2. Manager
  3. Developer
  4. Translator
  5. API User

Administrator

The Administrator user is responsible for:

  • Administering users and teams and assigning them to the users and projects
  • Installing and updating licenses
  • Managing data credentials and assigning them to managers
  • Setting up machine translations and translation management systems

The Administrator user can view all the projects in the system. The Administrator user can create and manage projects, but this role should be left to managers.

Manager

The Manager is responsible for:

  • Creating, managing and running projects
  • Creating project tags and tokens

The Manager can only see the projects for the teams or projects assigned to them.

Developer and Translator

The Developer and Translator can:

  • Analyze projects
  • View project status for the projects in their teams, but cannot make any changes to the system.

API User

The API user is for storing tokens. The API user cannot login to Command Center.

Global Settings

When logged in to Command Center, any user can select the Settings icon SettingsIcon.jpg to access the Global Settings page.

GlobalSettingsPage.jpg

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.

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. While in Maintenance mode, projects will not be analyzed.

MaintenanceMode.jpg

The system needs to be in maintenance mode to

  • Update licenses
  • Edit MT connections
  • Edit data source credentials
  • Edit system files

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.

When in Maintenance mode, projects don't run, they just get queued.

Licenses

Users & Teams

Data Source Credentials

Machine Translation and Translation Management System Connections

Project Tags & Tokens

System Logs & Events

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

System Files

Advanced Settings

Dashboard Issues Migration

You can migrate the Dashboard Globalyzer issues Status to Command Center if the issues exist in Command Center.

First, you need to create a Command Center project, the project name doesn't need to match the Dashboard project because we will map them manually.


Dashmig.png

Connect with the Dashboard

Dashmigmatch.png

Pair the Command Center project with the Dashboard project, you can migrate one project or many projects' issues.

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 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.
  • 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

  • list Command Center projects
 curl "COMMAND_CENTER_URL/api/listprojects" -d '{"username":"API_USER","token":"API_TOKEN"}'  --header "Content-Type: application/json"

Example:

 curl "http://localhost:8080/command-center/api/listprojects" -d '{"username":"figmaAPI","token":"CTMNzj**********CP"}'  --header "Content-Type: application/json"

or

 curl "https://dockertest2.lingoport.io/command-center/api/listprojects" -d @listprojects.json --header "Content-Type: application/json"
 listprojects.json:
 {
  "username":"figmaAPI",
  "token":"CTMNzj**********CP"
 }
  • get Command Center Project Status
 curl "COMMAND_CENTER_URL/api/getStatus" -d '{"username":"API_USER","token":"API_TOKEN", "source":{"group_name": "GROUP","project_name": "PROJECT","module_name": "MODULE"}}'  --header "Content-Type: application/json"


Example:

 curl "http://localhost:8080/command-center/api/getStatus" -d '{"username":"figmaAPI","token":"CTMNzj**********CP", "source":{"group_name": "Lingoport","project_name": "CET-WorldWindExplorer","module_name": "lili"}}'  --header "Content-Type: application/json"
  • duplicate Command Center project
 curl "COMMAND_CENTER_URLapi/createFromTemplateProject" -d '{"username":"API_USER","token":"API_TOKEN","source": {"group_name": "source_group","project_name": "source_project","module_name": "source_module"},"target": {"group_name":"target_group","project_name": "target_project","module_name": "target_module"}}'  --header "Content-Type: application/json"
  • For Git projects:
    • The target group name is the name of the Git organization
    • The target project name is the name of the Git project in that organization
    • The target module name is the branch of the Git Project in the organization


Example: For a target repository name https://github.com/Lingoport/Command-Center, branch 'liliDev', with a template called Lingoport Command-Center liliDev in Command Center using https://github.com, the following call would be make:

 curl "http://localhost:8080/command-center/api/createFromTemplateProject" -d '{"username":"figmaAPI","token":"CTMNzj**********CP","source": {"group_name": "Lingoport","project_name": "Command-Center","module_name": "dev"},"target": {"group_name":"Lingoport","project_name": "Command-Center","module_name": "liliDev"}}'  --header "Content-Type: application/json"

Figma API Project

  • Run
  • [...]
  • Send Translations ...
  • [....]