Using UI extensions and Macros, you may develop user-specific controls for your users.
Macros
A Macro is a brief piece of JavaScript code that is executed locally on the video device you are using. For instance, you can program your device to automatically answer incoming calls from certain numbers. This can be done through the device’s settings.
Commands written for the Application Programming Interface (API) of third-party systems can be executed by macros as well as those written for your Webex devices.
The term “Runtime” refers to the single process on the video device that is responsible for executing all of the active macros. The runtime can be started and stopped whenever necessary directly from the web interface of the device. The Runtime is contained within a sandbox, and the code is safely separated from the software that comes pre-installed on the device.
Control Hub or the Macro Editor included in the web interface of the device are also options for managing macros. In order to configure macros using Control Hub, you will first need to enable macro provisioning for the devices you plan to use Control Hub with.
UI extensions
A user interface extension, also known as a custom button or panel, is something that you make on your own and then add to the display of the touch screen on your device. For instance, you might add a “Quick Dial” button to your smartphone, which would allow you to contact a number that is regularly used, or you could set your device to automatically answer calls from certain numbers.
Control of third-party peripherals, such as lights, blinds, and video switches, can also be accomplished through UI extensions. In the conference room, you will have a consistent user experience when the video device and peripherals are controlled from the same user interface. The third-party application programming interface is used to facilitate communication with the third-party control systems.
You are able to develop customizations that attach to your existing processes thanks to the open platform, which gives you the ability to provide more value in addition to what Webex already provides.
Some examples include:
- Putting data from a user-defined web server front and center on the main page.
- Bringing issues to the attention of a ticketing system.
- Data about the room’s acoustics are gathered and uploaded to a webpage so that they can be plotted.
- Controlling external components such as lighting, blinds, and video switchers provided by a third party.
Using the UI Extensions Editor found within the device web interface, you are able to develop new UI extensions.
Enable Control Hub provisioning of macros
When you turn on macro provisioning, Control Hub will grant you read and write access to macros on a device-by-device basis, giving you more control over your workflow. When the feature is activated, the Control Hub will receive the macros of any devices that have been registered in shared mode. The source code of the macro can then be edited by administrators, local copies can be downloaded, and the macros can be uploaded to other devices.
To make macro provisioning available, open Control Hub, navigate to Devices > Settings > Macros, and then toggle on the Allow Control Hub to manage macros option.
- You should be aware that the Cisco Cloud will be used to store and encrypt all of your macros. You shouldn’t enable Control Hub macro provisioning if your macros contain sensitive data since that data could be compromised.
- The provisioning of macros over the Control Hub is only applicable to shared mode devices.
Configure macros from Control Hub
- Create, edit, and delete macros.
- Macro files (*.js) can be uploaded and downloaded.
- Enable or disable macros.
- Save your changes.
- Check out the macro logs.
You are need to first execute the actions indicated above in order to make the Control Hub provisioning of macros a viable option.
Each and every device is accountable for the macro provisioning of its own system. It is possible to share macros between various devices by downloading a macro from one device and then uploading it to another device. This can be done in order to share macros.
To access macros for shared mode devices:
You can configure a device by first going to the Devices area of the customer view on https://admin.webex.com, and then selecting the device you want to configure from the list of available options.
Go to the Configurations menu, then select Macros from the submenu that appears.
You have the ability to:
You will be given the choice to download a copy of your version, trash your version, or overwrite the other version if someone else is editing the same macro(s) from another web location at the same time as you are.
Create macros from the device web interface
A code editor, logging tools, and controls that allow for the rapid testing of macros are all included in the Macro Editor.
Use your Admin credentials to log in to the device’s web interface, and then go to the Customization menu and select Macro Editor. You have the ability to:
Create, edit, and delete macros.
Import or export macros (*.js).
Enable or disable macros.
Review debug logs.
Save your changes (Ctrl+S)
You will be given the choice to download a duplicate of your version, reject your edit, or overwrite the other version if someone else is simultaneously editing the same macro from a different online location.
Create UI extensions from the device web interface
Panels: A control panel can have several different user interface elements within it (such as buttons, text fields, switches, and sliders), and each of these elements can be programmed to carry out specific tasks. Because of this, it might be possible for you to consolidate your own set of controls into a single spot.
Web Applications A shortcut to a web application that has been placed to the home page. A pre-defined web page will load in full screen mode when you run the web app. This feature is accessible on all of the devices that include a Web Engine, which includes the Board and Desk Series but not the DX.
Log in to the device’s web interface as an Admin, RoomControl, or Integrator, and then browse to the Customization > UI Extensions Editor menu item.
You have the ability to:
You can add a UI extension, upload one, download one, or delete one.
Make and adjust the settings for a wide variety of control types.
Alter the state of a UI extension between active and inactive.
Define the conditions under which the UI extension will be displayed.
You can export your UI Extensions to a file on your computer or to the video device.
You will need to make advantage of the item’s one-of-a-kind identifier in order to link a UI extension to a macro. “lights_on” may be the Id of your toggle, for instance. Then, you would need to develop a macro that monitored screen taps and, when it found that the “lights_on” button had been touched, it would execute the desired command (for example, switch the lights on/off).
You can find some examples of how to attach UI extensions to macros in the part of the Customization Guide titled “UI Extensions.”
