Companies Data Model

Advertencia

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

COTCompany

Description

The Companies Data Model (COTCompany) is the underlying configuration for the platform. Most data models are associated with it. It contains basic company information, such as its name, tax identification number, and country. It also establishes platform display settings such as language, icon display, colors, authentication, and other branding options.

JSON Sample

{
    "__v" : 14,
    "_id" : "6136968b580aaf2b0e49d844",
    "admin" : [ 
        "6136969432d0379f7490cdf3"
    ],
    "appContacts" : true,
    "contactMode" : "default",
    "conversationGroup": "6197b98d6b60e7b6db7a61cf",
    "createdAt" : "2018-10-19T15:06:35.726Z",
    "defaultCountry" : "US",
    "defaultLanguage" : "en",
    "displayName" : "ACME",
    "emailDomains" : [ 
        "company.com"
    ],
    "help" : "6136969de063469044d87926",
    "hideSummary": false,
    "isActive" : true,
    "legalName" : "ACME INC.",
    "legalIdentifierCode": "EIN",
    "legalIdentifier": "123-45-6789",
    "modifiedAt" : "2021-08-20T19:35:11.648Z",
    "offline" : {
        "isActive" : false,
        "maxSyncTimeMs" : 0
    },
    "permissions" : {
        "receiveNotifications" : true,
        "readLocation" : true,
        "showTos" : {
            "value" : true
        }
    },
    "subdomain" : "acme",
    "system" : "613696a4a43cf12cb25c7de5"
}

Fields

Field	Description	Type	Notes
_id	System generated company ID number.	ObjectId<COTCompany>	Only lowercase letters are accepted.
admin	List of admin users' ID number	ObjectId<COTUser>[ ]
appContacts	Displays contact button in the main menu bar	boolean	View Main Menu Bar
branding	Allows customizing certain aspects of Cotalker's UI, i.e., platform colors, images, and text. Also enables login authentication with an organization's Google and Microsoft accounts.	object	View the COTCompanyBranding section for complete object specifications. Visit the Branding Settings section for examples and tips.
contactMode	This option will limit users' ability to see other users in their contact lists and other places, like surveys where user lists are used as options for answering survey questions.	string	Valid options are:default and local (allows users to view only contacts in their current channels); all (permits viewing all company users)
conversationGroup	Group that holds quick access to important company channels	ObjectId<COTGroup>
createdAt	Creation date	ISODate	YYYY-MM-DDTHH:mm:ss.SSSZ
displayName	Company Name as viewed by users	string
defaultCountry	Country where the company resides.	string	Use ISO 3166-1 alpha-2 country codes, e.g., US, CL.
defaultLanguage	Determines the language the platform displays responses. This option is independent of the device or web browser language. For example, bot names will be displayed in the chosen language, but generic displays will be in the web browser's language.	string	en (English) or es (Spanish)
emailDomains	Indicates company's email address domains	string[ ]	Example: company.com
help	Indicates the user ID of help contact	ObjectId<COTUser>
hideSummary	If false, it displays the home icon in the Main Menu Bar.	boolean	Pressing the home icon shows all recent conversations in the group panel.
isActive	Indicates if a company is active or if it has been deactivated	boolean
legalName	The official name of the company	string
legalIdentifierCode	Indicates a country's taxpayer identifier; doesn't have to be exact.	string	For example, RUT in Chile, EIN or TIN in the USA
legalIdentifier	Company's legal identification number; any legal format is valid.	string	Format examples: 123-45-6789 (EIN); 12.345.678-9 (RUT)
modifiedAt	Last modification date	ISODate	YYYY-MM-DDTHH:mm:ss.SSSZ
offline	Sets offline mode for mobile apps	object	Only available in enterprise edition
offline.isActive	Turns offline mode on or off	boolean
offline.maxSyncTimeMs	Indicates object synchronization time	number
passwordRotation		object
passwordRotation.enabled	Activate to make users change their password after the number of days indicated in the following field.	boolean	After the indicated time, users will be prompted at login to renew their password.
passwordRotation.days	Indicates the number of days after which users will have to change their password.	number
passwordRules	Establishes the security rules user passwords must comply with.	object	By default, no rules are applied.
passwordRules.minLength	The mínimum amount of characters a password must have.	number
passwordRules.lowerCase	The mínimum amount of lower case letters a password must have.	number
passwordRules.upperCase	The mínimum amount of upper case letters a password must have.	number
passwordRules.numbers	The mínimum amount of numbers a password must have.	number
passwordRules.symbols	The mínimum amount of symbols or special characters a password must have.	number	Accepted symbols: ! @ # $ % ^ & ( ) _ [ ]
passwordRules.zxcvbn	Password strength score required for creating valid user passwords.	number 0 | 1 | 2 | 3 | 4	0 = disabled 1-4 = Define the strength the password must have. More information on password security.
permissions		object
permissions.showTos	Displays "terms of service" document when new users log in for the first time	object
permissions.showTos.value	Determines whether or not to display the "terms of service"	boolean	If no URL is indicated, Cotalker will display its generic terms of service.
permissions.showTos.url	Indicates the URL of the "terms of service" document to display; a Google document will work just fine	string	URL
searchEngines	An array of objects that represent parameters used to customize the platform's search tool.	object[ ]	The array contains objects with the following structure: [{"name": string, "options": string}]. Vist the COTCompanySearchEngine section for specifications.
startGroup	Indicates which group appears in the group panel at startup	ObjectId<COTGroup>	If left null, a summary of most recent conversations will show up in the group panel.
subdomain	Used to internally reference the company; also used to indicate subdomain name for web client	string
system	Indicates the user ID of system manager contact	ObjectId<COTUser>

Fields Currently on Standby

Field	Description	Type	Notes
plan		string
maxUsers		number
appFiles		boolean
appLogo		string	URL

SHOULD NOT BE USED

Field	Description	Type	Notes
__v	version number	number
propertyTypes		string[ ]

Soon to be deprecated

Field	Description	Type	Notes
accessRolesVersion		string
allowUserCreation		boolean
hideHome		boolean
permissions.receiveNotifications	Notification pop-ups	boolean
permissions.readLocation	Obtain GPS location data	boolean
appSearch		boolean

DEPRECATED

Field	Description	Type	Notes
specs	array	[ ]	DEPRECATED
permissions.readContacts	Contact search on device	boolean	DEPRECATED
messages	Sends a welcome message	object	DEPRECATED
products	Integration for special products	object	DEPRECATED
sidemenu	Side menu configuration	object	DEPRECATED
appBadge		boolean	DEPRECATED
appToolbarText	Toolbar text color (hex color code)	string	DEPRECATED
appToolbarColor	Toolbar background color (hex color code)	string	DEPRECATED
hierarchyLevel		string	DEPRECATED
hierarchy	array	[ ]	DEPRECATED
jobs	Array of job titles that can be assigned to users	string[ ]	DEPRECATED
newsPropertyTypes	array	[ ]	DEPRECATED
signatureDuration	Indicates the time period for which the authentication signature is valid	number; the value is in seconds; default is 604800, i.e., seven days.	DEPRECATED

Additional Resources

• Configuration: Configure some of the company settings from the Administrative Panel
• "Company" REST API documentation: basic "Company" API requests
• API documentation in Swagger: complete with data models (schemas)
• COTLang: use COTLang for extracting data from models in routines
• Triggers and Contexts: more information on using data models within routines

Help

• Cotalker Platform Community: post your questions or search for previous answers given in the forum