A macro is a small program that runs natively on the room or desk device or board. A macro is written in JavaScript / ECMAScript 2017 with support for features such as arrow functions, promises, classes, and async/await. All room and desk devices and boards except SX10, support macros.

A macro can register feedback from events, configuration changes, and status changes on the device. The macro can listen for these events and changes, and use the API of the device to invoke further commands and configuration changes. If you combine the use of macros with custom user interface panels, you can augment the user interface with local functionality, for example speed dial buttons.

To learn more about how to make custom user interface panels, check the in-room controls article.

Create and Administer Macros

You can use the Macro Editor to create and activate macros. The editor is available from the web interface (Advanced Settings) of the device. In order to use the editor, you must either sign in through the Control Hub, or with a local Admin user on the device.

Also, there is a set of API configurations and commands for macro administration. You need a local Admin user on the device to work with macros in the API.

Read the Local User Administration article and the Advanced Settings article for more information about local users, how to access the web interface, and how to use the API.

Launch the Macro Editor

  1. Open the web interface of the device.

    • From the customer view in https://admin.webex.com, go to the Devices page, and select your device in the list. Scroll down the devices pane, and click Launch Advanced Settings. Now the web interface of the device opens.

    • Or, if you have set up a local Admin user on the device, you can access the web interface directly. Just open a web browser and type in http(s)://<endpoint ip or hostname>.

  2. From the Integration tab, select Macro Editor.

    If macros are disabled, you are offered the choice to Enable Macros when you try to launch the editor. Alternatively, you can enable the use of macros from the configuration page: From the Setup tab, select Configuration, and set Macros > Mode to On.

Further Information

Find more details about macros and how to use the Macro Editor in the Customization guide. Choose the latest version.

Extra learning resources are embedded in the editor:

  • Click Tutorial to open the Cisco Macro Scripting Tutorial. You can also download the tutorial from the editor.

  • Click Help to find a short introduction to using macros on a device, and some code examples to study or use.

Cisco support (TAC) doesn’t support debugging of third-party code, including macros. Please check the Cisco Collaboration Developer community if you need help with macros and third-party code. Also, there are many developer and integrator resources on this site. You can find several macro coding examples here.