Skip to content

Deploy Extensions via CE-Deploy

Abstract

Extensions enable companies to enhance and personalize the user experience. These extensions can be deployed through Control Hub or CE-deploy. In this lab, we will deploy an extension to accompany our macro from the last lab.

dep-2.6 Lab

dep-2.6.1 Open CE-Deploy and load your environment you created in the previous lab if it's not already loaded

Loading Environments

To load an environment, use the dropdown in the Environment loading section and select your new Environment and select Load Environment.

Then select Design->CE Macro Editor Pro from the main menu

Macro Editor

dep-2.6.2 The Macro Editor can also be used to create our XML file. Copy the text below and paste it into the Macro Editor and save the file as LaunchHalfwake.xml. Be sure to change the default extension from .js to .xml

LaunchHalfwake.xml
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
<Extensions>
  <Version>1.8</Version>
  <Panel>
    <Order>1</Order>
    <PanelId>halfwake</PanelId>
    <Origin>local</Origin>
    <Type>Home</Type>
    <Icon>Power</Icon>
    <Color>#07C1E4</Color>
    <Name>HalfWake</Name>
    <ActivityType>Custom</ActivityType>
  </Panel>
</Extensions>
It should look something like this, ignore that the current file is called New Macro.js. When we save it further on the file name will be updated:

XML File Creation

Save the xml file by clicking the Save As button and name your file LaunchHalfWake.xml. Don't forget to change the file extension to .xml:

Save XML File

You should now see the file under the file manager in the left hand pane of the Macro Editor. Use the Select button to navigate to your desired folder. You wont see all your files though, the file manager filters all the files based on their extension and only shows .js and .xml files.

Saved XML File

dep-2.6.3 Now we have our xml file lets role it out to our endpoint. For a single panel in the deployment panel select Customizations->UIExtensions->Panel. This allows ot deploy or update a single panel.

Add a Panel

Tip

When deploying a single panel using the same panel ID will create a new panel the first time, but subsequent uses of the same ID will overwrite existing panels.

To update more than 1 panel use the Customizations->UIExtensions->Config deployment panel feature. This allows the upload of xml files that contain multiple panels.

dep-2.6.4 In the panel ID text box enter halfwake as the panel ID. Using the Browse file picker select your xml file you created in the last step.

Panel Details

dep-2.6.5 Under deployment Options use the dropdown to select Tags and enter your pod tag for your device.

Tag Options

dep-2.6.6 Ensure the Video Devices Only checkbox is checked.

Warning

An error may occur if this check box is not selected. Just make sure that it is checked if you receive an error while deploying.

dep-2.6.7 Press button Start Deployment.

dep-2.6.8 Ensure the Scheduler has the Run Deployment Now check box selected and click Next.

dep-2.6.9 The Message Console will now appear, you can follow along the deployment process.

Its test time. The halfwake button should now appear on your home screen of your device. Pressing the button should place your endpoint into the halfwake state.

Success

You now have a working Macro and Extension. Look at you go.