Integrations/cuculus/cuculus.zonoscontrolcenter pimA

This page documents the enPortal integration for Cuculus Zonos Control Center.

• Vendor: Cuculus
• Product: Zonos Control Center
• Supported Version(s): 4.11.0.6087
• Name of enPortal Integration Package: cuculus.zonoscontrolcenter_pimA
• Required enPortal Version: 4.6.1 and above

The following section documents supported platforms, installation, and configuration of the Zonos Control Center Product Integration Module on enPortal versions 4.6.1 and above.

Support Matrix

The following Operating System, Database, and Web Browser platforms are supported:

Operating System

Please see the list of supported Operating Systems on the System Requirements page.

Database

A special database is not required to implement this integration module. The AppBoard/enPortal database is used to store all configurations related to this integration module.

Web Browser

Please see the list of supported Web Browsers on the System Requirements page.

Installation

Perform the following steps to install the Zonos Control Center PIM:

1. Install AppBoard/enPortal as detailed in the Installation documentation
2. Download the file cuculus.zonoscontrolcenter_pimA.jar
3. Start enPortal and login as a portal administrator

{{#ifeq: "5.3" | "{{{3}}}" |

1. Under the Advanced tab, select PIMImport

|

1. Under the Web Integrations tab, select PIM Import

}}

1. Click the Browse... button
2. Locate the file cuculus.zonoscontrolcenter_pimA.jar in the Open dialog
3. Click the Start button to extract the files from the PIM .jar archive

{{#ifeq: "5.3" | "{{{3}}}" |

1. Under the Advanced tab, select XMLImport
2. Click the Start button to load the PIM into the system
3. Confirm that the following message is displayed: "Import completed; loaded the following file(s): load_cuculus.zonoscontrolcenter_pimA.txt"
4. Under the Advanced tab, select Explore System
5. Navigate to the /Directory/system/proxy/ folder and locate the “Manage Proxy” channel
6. Right-click on the “Manage Proxy” channel and select Open to launch the channel
7. In the Manage Proxy tool, click “Reset All”

|

1. Confirm that the following messages are displayed:
   1. "Upload completed."
   2. "Loaded the following file(s): load_cuculus.zonoscontrolcenter_pimA.txt"
   3. "CRS cache cleared."

}}

Integration Details

The following sections provide special details for configuring the integration module after installation.

Channel Types

• Home - Channel that displays the default Home page for the logged in user, including full navigation controls (no custom configuration required)
• Proxy - Channel that is used by the system to display Zonos Control Center channels (no custom configuration required)

Configuration

After installing the Zonos Control Center PIM, perform the following steps to configure access to the host Zonos Control Center server:

{{#ifeq: "5.3" | "{{{3}}}" |

1. Click on the Applications tab

|

1. Under the Web Integrations tab, select Applications & Licenses

}}

1. Right-click on the name sample in the row for Zonos Control Center (cuculus.zonoscontrolcenter_pimA) and select Modify
2. Fill in the items in the Modify Application Wizard dialog:
   1. Select the protocol used to access your Zonos Control Center server (http or https)
   2. Change the host name from "changeme" to the hostname or ip address that will resolve to your Zonos Control Center server
   3. Change the port to the port number of your Zonos Control Center server
   4. Click "Save" to keep your changes

{{#ifeq: "5.3" | "{{{3}}}" |

1. Click on the Integrations tab

|

1. Under the Web Integrations tab, select Explorer

}}

1. In the Explorer, under Packages, expand the cuculus.zonoscontrolcenter_pimA tree and click on the sample target. Confirm that the information you entered is displayed for your Zonos Control Center server
2. Under the sample target, click on the Home channel. A login prompt should be displayed.
3. Log in using the same credentials you would use for accessing the Zonos Control Center application in a browser. Confirm that the Zonos Control Center Home page is displayed.

Create Channels

After installing the Zonos Control Center PIM and configuring access to the host Zonos Control Center server, perform the following steps to create channels to display Zonos Control Center content:

{{#ifeq: "5.3" | "{{{3}}}" |

1. Click on the Applications tab
2. Right-click on the name "sample" in the row for cuculus.zonoscontrolcenter_pimA and select a channel type
3. In the "Channel Name" box, enter the name you want to give to the new channel
4. For "Channel Type", select "3rd Party Pims"
5. Select Pim, Class, and Target for your channel
6. Click Next
7. Click Finish
8. Click on the Integrations tab

|

1. Under the Web Integrations tab, select Applications & Licenses
2. Right-click on the name sample in the row for cuculus.zonoscontrolcenter_pimA and select a channel type
3. In the "Channel Name" box, enter the name you want to give to the new channel
4. Click Next
5. Click Finish
6. Under the Web Integrations tab, select Explorer

}}

1. In the Explorer, under Packages, expand the cuculus.zonoscontrolcenter_pimA tree and click on the sample target. Confirm that the new channel is listed along with the other sample channels

Repeat the above steps to create additional channels. Select a different Channel Type in step 2 to create a different type of channel.

Known Issues

The following known issues are associated with this PIM:

• There are currently not any known issues associated with this PIM

License Usage

In order for the AppBoard/enPortal administrator to configure the cuculus.zonoscontrolcenter_pimA PIM, the AppBoard/enPortal license.properties file must include licensing for at least one cuculus.zonoscontrolcenter_pimA server. The administrator can create one additional host ("target") in AppBoard/enPortal for each server license included in the license file.

Each AppBoard/enPortal user maintains one user session with the Zonos Control Center server. The Zonos Control Center application must be licensed to support the number of users that will be accessing the application through AppBoard/enPortal.

Version Support

The following matrix details the supported Zonos Control Center and compatible AppBoard/enPortal versions:

Version Support

Package Name	enPortal Version	Zonos Control Center Supported Versions
cuculus.zonoscontrolcenter_pimA	{{{3}}}+	{{{4}}}

To see the current enPortal version, run the portal version command from the [AppBoard_Home]/server/bin directory.

Upgrades

Upgrading from an older version

Older versions of Zonos Control Center are not supported by this PIM, so this upgrade path is not supported. It is recommended that you validate the PIM in your Zonos Control Center environment to confirm that it supports the required functionalities.

Upgrading to a newer version

Perform the following steps when the Zonos Control Center server is upgraded to a newer version of Zonos Control Center:

1. Check the AppBoard/enPortal PIM online documentation to see if the new Zonos Control Center version is supported by the existing cuculus.zonoscontrolcenter_pimA PIM.
2. Test if the new Zonos Control Center version is supported by the existing PIM that you have installed, perform the following steps:

{{#ifeq: "5.3" | "{{{3}}}" |

1. 1. Click on the Applications tab

|

1. 1. Under the Web Integrations tab, select Applications & Licenses

}}

1. 1. Right-click on the row for the old Zonos Control Center server and select "Modify"
   2. Update the protocol, host, and port to reference the server where the new version of Zonos Control Center is running
2. If the new Zonos Control Center version is not supported by the existing PIM that you have installed, perform the following steps to upgrade the PIM:
   1. Download the new PIM version from the PIM download site
   2. Follow the steps in the Installation section above to install and configure the new PIM version
   3. Re-create all Zonos Control Center channels to reference the new PIM
   4. [Optional] Perform the steps outlined in the Uninstall section below to remove the old PIM from the system

Uninstall

Perform the following steps to uninstall the cuculus.zonoscontrolcenter_pimA PIM:

Uninstalling the cuculus.zonoscontrolcenter_pimA PIM will break all of the channels in your AppBoard/enPortal system that reference this integration.

{{#ifeq: "5.3" | "{{{3}}}" |

1. Click on the Integrations tab

|

1. Under the Web Integrations tab, select Explorer

}}

1. In the Explorer, under Packages, locate the cuculus.zonoscontrolcenter_pimA integration
2. Right click on the integration name, and select "Delete"
3. Click "Ok" to confirm that you want to delete the integration package