Saltar al contendio prinicipal

Branding Data Model

Advertencia

Esta página aún no se encuentra traducida al español.

COTCompany

Description

Within the COTCompany data model, the companies.branding object allows customizing certain aspects of Cotalker's UI, i.e., platform colors, images, and text. It also enables login authentication with an organization's Google and Microsoft accounts.

tip

Visit the Branding Settings section for examples and tips.

JSON Sample

Below is a sample of a COTCompany data model displaying one of the available companies in a database. An example of the companies.branding object can be found between lines 11 to 51.

{
"_id": "62f2b06e9682bd2711a27c46",
"defaultCountry": "US",
"defaultLanguage": "en",
"isActive": true,
"subdomain": "kohannya",
"displayName": "kohannya",
"legalName": "kohannya",
"createdAt": "2022-05-23T14:12:24.879Z",
"modifiedAt": "2022-06-30T16:05:53.011Z",
"branding": {
"isActive": true,
"names": {
"name": "kohannya",
"shortName": "Kohannya"
},
"urls": {
"app": "https://kohannya.cotalker.com",
"api": "https://www.cotalker.com"
},
"translations": {
"en": {
"admin.main_title": "Адміністративна панель",
"subjects.state_machine_groups_other": "Групи робочого процесу",
"subjects.state_machine_other": "Робочі процеси",
"subjects.link_groups": "Групи посилань",
"subjects.group_other": "Групи",
"descriptors.admin_menu_section": "Розділи"
}
},
"style": {
"customCss": ":root { --white-label-primary-color: #FCFEFF; --secondary-color: rgba(var(--white-label-secondary-color), 0.12); --secondary-color-focus: #028AFB; --general-menu-text-color: 150, 150, 150; --profile-background-color: #E7EAED; --profile-name-color: black; --profile-email-color: black; --menu-buttons-shadow: 0px 2px 2px rgba(0, 0, 0, 0.25); --menu-buttons-text-color: #969696; --menu-buttons-text-color-selected: white; --search-bar-background-color: #028AFB;} cotalker-task-list {background-color: white;} cotalker-task-item cotalker-tag .tag-container {background-color: #E2E6EA !important;} cotalker-task-item cotalker-tag span {color: rgba(17,51,85,.56) !important;} cotalker-group-menu .logged-user-status-display {color: green !important;} cotalker-group-menu .cot-icon-font {opacity: 1 !important;} cotalker-group-menu.expanded .cot-icon {filter: contrast(1) brightness(1) opacity(1) !important;} cotalker-group-menu .cot-icon {opacity: 1 !important; filter: contrast(0) brightness(1) opacity(0.85) !important;}"
},
"images": {
"logotype": "62a09637cf27b4b1e16a88c4",
"isotype": "62a00adccf27b45eb96a88be",
"icon512": "62a00af2cf27b464c46a88c0",
"login": "629fadc1cf27b4e7046a88ba"
},
"auth": {
"azureAD": {
"isActive": true,
"clientId": "",
"authority": "",
"redirectUri": ""
},
"googleSignIn": {
"isActive": true
}
}
}
}

Fields

FieldDescriptionTypeNotes
isActiveActivates the use of custom images. If true, the custom images contained in the images object are displayed.boolean
namesAllows overriding the default platform name.object
names.nameCorresponds to the environment build name, i.e., the code name by which the system identifies the customized version of the platform.string
names.shortNameCustomized name to be displayed externally, such as in the web browser tab.string
urlsIndicates the organization's Cotalker platform URLs.string
urls.appThe organization's web app URL.stringExample: "https://company.cotalker.com"
urls.apiThe REST API URL.stringExample: "https://www.cotalker.com"
styleContains platform color and button configurations.object
style.customCssCSS code in string format.stringCheck the Branding Settings section for CSS examples.
authContains settings to enable external credential login.object
auth.azureADSettings needed to enable Microsoft Azure login.objectGo to Microsoft Azure AD Sign-in Configuration for complete setup information.
auth.azureAD.isActiveActivates Azure login settings.boolean
auth.azureAD.clientIdContains the Application (client) ID.stringCheck step 15 of the Microsoft Azure AD Sign-in Configuration for information on how to obtain this value.
auth.azureAD.authorityContains the Directory (tenant) ID.stringCheck step 15 of the Microsoft Azure AD Sign-in Configuration for information on how to obtain this value.
auth.azureAD.redirectUriIndicates the redirect URI used for enabling Azure login.stringPlease ask your Cotalker sales representative or support team to supply the redirect URI.
auth.googleSignInSettings to enable Google Gmail login.object
auth.gooogleSignIn.isActiveIndicates if Google Gmail login is enabled.boolean
imagesIndicates images used to replace the defaults.object
images.loginContains the ObjectId of the custom image to be used on the righthand side of the login screen.ObjectId<COTFile>
images.emailContains the ObjectId of a custom image to be used as a logo on automatically generated emails.ObjectId<COTFile>
images.logotypeContains the ObjectId of a title-with-logo image to be used on the login screen and above the main menu bar.ObjectId<COTFile>
images.isotypeContains the ObjectId of a custom image used to replace the hamburger icon of the retracted main menu bar.ObjectId<COTFile>
images.icon512Contains the ObjectId of a custom image to be used as the in-progress icon.ObjectId<COTFile>
translationsAllows overriding default app text with customized versions or translations into other languages.
The key, i.e., text section identifier, can be obtained through your Cotalker representative or support team.
objectFormat:
"translations": {"en": {[key]: string}}

Example:
"translations": {"en": {"subjects.link_groups": "Групи посилань", "subjects.group_other": "Групи"}}
translations.enThis object overrides the default English platform texts with custom translations or versions.object
translations.en.[key]Indicates the new text to be used in the indicated key or text section.string
translations.esThis object overrides the default Spanish platform texts with custom translations or versions.object
translations.es.[key]Indicates the new text to be used in the indicated key or text sectionsstring