trueChart Help

KPI Chat Settings

Introduction:

KPI-CHAT now (v2022.7.x onwards)  has settings in the TRUECHART management console that will enable you to do audits on your chats, setup API key tokens and archive chats.

KPI Chat Auto Archiving

With this utility will enable you to setup the archiving of KPI Chat messages automatically after a specified period.

How it works: 

An administrator would need to specify after how many months your chats should be archived starting at 1 month. 

The default is 0 , indicating that no archiving would take place.

KPI Chat Auditing

With this utility you would be able to export audit reports for an specific date range, where you can view what has transpired in KPI Chat Channels & Data Permissions

How it works: 

  • You would first need to select a "Facility" =  Channels, Data permission or All facilities 
  • Choose the "Origin" =  KPICHAT, TCMC or External API 
  • Select a From and To Date to specify which duration you want this audit report for.

  • When you click on the "Export" button an audit report will be downloaded in .csv format 

csv file

Facility,Username,Field,Before,After,Action Date,Action,Origin
Channels,Administrator,Name,,Smoke,2022-11-01 14:29:53,Add,KPICHAT
Channels,Administrator,Description,,Test,2022-11-01 14:29:53,Add,ExternalAPI
Channels,Administrator,Notifications Enabled,,false,2022-11-01 14:29:53,Add,KPICHAT

KPI Chat API Key Token

An API key can be generated for an external application  to connect to KPI Chat

How it works: 

  • You would first need to enter a description
    • It is suggested that this be the name of the application that will be integrating via the API
  • Under "Valid for" you can select how long the API Key should be valid for = 1Month, 1 Year or Custom
  • If you select Custom you would need to select the Expiry Date manually

  • Then click on "Generate API Key"
  • Upon creating an API Key, users will be presented with the authentication string. 

Please Note

This key will only ever be shown once. Please ensure to keep this in a secure location.

Should users need to remove an application's access via the API, they may do so by deleting it from the list of existing keys:

Alternatively, once the key has expired, the application will automatically no longer be able to authenticate using the expired key