Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
b-venter authored Nov 24, 2021
1 parent 589e88c commit d785142
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ Quite simply, this is a wallboard for Mitel's MiContact Center Business (MiCCB).
Below you will find instructions on installation and settings.

## 1 - Setting up an API user on MiCCB
So you could run this using your admin user - but that is just a **bad idea** on so many levels. Therefore, to encourage good security, here is a step-by-step guide on how you can create a user just for the wallboard with only as much as access as needed (which, if you are curious, is very little).
While you could run this using your admin user, that is just a **bad idea** on so many levels. Therefore, to encourage good security, here is a step-by-step guide on how you can create a user just for the wallboard with only as much as access as needed (which, if you are curious, is very little).

#### Add a security role
- In *YourSite Explorer*, go to *Security role*, and choose ***Add***
- **Name:** Wallboard API
- Under **General**, *only* enable "May access contact center client and ignite"
- Under **Realtime control**, *only* enable "May view realtime monitor"

#### Now create the AP user
#### Now create the API user
- In *YourSite Explorer*, go to *Employee*, and choose ***Add***
- **First name:** Wallboard
- **Last name:** Display
Expand All @@ -24,7 +24,13 @@ So you could run this using your admin user - but that is just a **bad idea** on
Nice! Never compromise on security

## 2 - Wallboard settings
In the `assets` folder is a file called **settings.json**. Here is what each entry can contain:
In the `assets` folder is a file called **settings.json**. Here is what each entry can contain:
`"refreshTime":` A measurement in seconds, specifying how often fresh data should be retrieved. Take into account your server load, etc.
`"serverUrl":` IP address or pingable hostname / FQDN for the MiCCB server. No "http" or "/".
`"apiUsername":` As per the userid created on MiCCB ("wallboard" in the example above).
`"apiPassword":` Also as per the password you created for said user.
`"activeQ":` If you have multiple queues, the wallboard will retrieve them in a list - starting with 0. Leave as is to start with. Once the wallboard is connected and running, you will be able to see a list of each queue and its associated position.
`"wallBanner":` Change at will.

## 3 - Hosting with IIS
## 4 - Building from source
Expand Down

0 comments on commit d785142

Please sign in to comment.