Install API plugin
Note
Please note that this plugin can only be utilized for AnywhereNow related products.
Prerequisites
-
Installed and working Installing Event Forwarder Plugin
Installation or Update of the plugin per UCC
- Log in on the server on which the A Unified Contact Center, or UCC, is a queue of interactions (voice, email, IM, etc.) that are handled by Agents. Each UCC has its own settings, IVR menus and Agents. Agents can belong to one or several UCCs and can have multiple skills (competencies). A UCC can be visualized as a contact center “micro service”. Customers can utilize one UCC (e.g. a global helpdesk), a few UCC’s (e.g. for each department or regional office) or hundreds of UCC’s (e.g. for each bed at a hospital). They are interconnected and can all be managed from one central location. service is running.
- Go to the plug ins folder (‘DRIVE:\program files\core\anywhere365\plugins\'). If it doesn't exist, create it.
- Create a folder "Wsp.Anywhere365.ApiPlugin" for the plugins folder.
- Copy the dlls and included config files from the A bundle is a fixed combination of our software platform elements of very specific versions. These are designed and tested to optimally work together to assure their intended function and interoperability. Plugin package to this folder.
Note
In case the folder is already created and the plug in is in use by the UCC, the UCC will have to be stopped (check if stopping of the UCC is allowed).
Warning
Please note that it is necessary to restart the UCC service in order for the UCC service to use the plugin.
Add plugin to config
Per UCC
- Open file ‘Config.xml’ for editing purposes.
Tip
It is highly recommended that you make a backup of the Config.xml.
The default path of this file is:
C:\ProgramData\Anywhere365\Core\Service\UnifiedContactCenterService\Config.xml
-
Add "Plugin" value below ‘SettingsURL’ of the UCC.
XML<Plugin name="ApiPlugin" path="C:\Program Files\Anywhere365\Core\plugins\Wsp.Anywhere365.ApiPlugin" file="Wsp.Anywhere365.ApiPlugin.dll" />
For UCC Service
-
Open file ‘Config.xml’ for editing purposes.
Tip
First make a backup of the file to prevent problems!
The default path of this file is:
C:\ProgramData\Anywhere365\Core\Service\UnifiedContactCenterService\Config.xml
-
Add "Plugins" value below ‘Presence Provider’.
XML<Plugins> <Plugin name="ApiPlugin" path="C:\Program Files\Anywhere365\Core\plugins\Wsp.Anywhere365.ApiPlugin" file="Wsp.Anywhere365.ApiPlugin.dll" /> </Plugins>
Configure UCC Settings
Add Plugin Settings
- Open the UCC Config page on SharePoint
- Open the Plugin Settings list
- Add the following settings:
| Setting | Value | Scope |
|---|---|---|
Enabled |
TRUE | ApiPlugin |
Uri |
http://FDQN stands for Fully Qualified Domain Name and specifies the exact location in the tree hierarchy of the Domain Name System (DNS). An example for [hostname].[domain].[top level domain] is [www].[microsoft].[com]:port | ApiPlugin |
|
Note FQDN = Can be internal facing address (Dialogue Manager to UCC) Port = Can be any free port. Warning The first UCC to start sets the port number. All subsequent UCCs in the same service must use this port. Warning Make sure to leave the fqdn to this service configured as a ".local" URL, especially when using multiple UCC services in the same region. If this is not done, the UCC cannot reach the right webserver internally leading to undesired or non-functional WebAgent behavior. |
||
Restart UCC and validate
-
Login to the AnywhereNow Application Server
-
Start Services
-
Restart "Anywhere365 Unified Contact Center"
-
See the UCC logs if API Plugin is successfully loaded
C:\ProgramData\Anywhere365\Core\Service\UnifiedContactCenterService\logs
Logs2021-07-05 18:00:24,399 [5] acp DEBUG - ApiPlugin - InitAsync() starting 2021-07-05 18:00:24,399 [5] acp INFO - ApiPlugin.InitAsyncInternal 2021-07-05 18:00:24,399 [5] acp DEBUG - ApiPlugin - InitAsync() completed with result PluginInitializationResult(IsSuccessful=True, RequiredLists=ListConfiguration(ListName=PluginSettings, FieldNames=ID, Title, wsp_ucc_ps_value, wsp_ucc_ps_scope, wsp_ucc_ps_prompt_LookupValue, wsp_ucc_ps_prompt)) 2021-07-05 18:00:24,399 [5] acp INFO - PluginManager::StartAsync initialized [ApiPlugin]. Will attempt to provide with lists [PluginSettings]