Macro Security Configuration - 4.x

After upgrading or installing Macro Security for Confluence, navigate to the Global Configuration screen:

  1. Log in with the System Administrator Global Permission.
  2. Select Add-ons from the cog icon at the top right corner of your screen.
  3. Scroll down to Bob Swift Configuration on the sidebar.
  4. Select Macro Security. This navigates you to the 'Macro Security for Confluence - Configuration' page, which allows you to manage the required configuration.

Secured Macros

This tab contains a list of macros that have been secured, along with their restrictions (Key Concepts explain in detail how to use Macro Security restrictions). This screen allows you to add, edit, enable or disable, and delete entries. The following image succeeded by the details of the usage of each option on the page:

A. Restrict a Macro (Add)

You can add a new entry to either restrict a new macro or a new macro parameter by performing the following:

  1. Enter the macro name by typing and selecting from the pick list, or enter the exact name of your macro. Note: The names are case sensitive. 

  2. Enter the user(s), group(s), space name, or space key (includes personal spaces) to which the macro is restricted.

    Space keys are case sensitive. While adding a space key for macro restrictions, ensure that you search for the exact space key name.

  3. Click the Add button.

B. Import Macro Properties

You can replace your entire configuration as shown on the Secure Macros tab by doing the following. You must already have a valid properties file available that you created previously.

  1. Click the ellipses next to the Add button.
  2. Select Import Macro Properties from the available options. The Import Macro Properties dialog is displayed.
  3. Click Browse to browse and select the required properties file.
  4. (Optional) Select the Save local backup copy check box to save a local copy. This is saved to the download folders set in your browser's preferences
  5. Click Import to import the selected file. A successful import message is displayed.

C. Export Macro Properties

You can save your current configuration as shown on the Secure macros tab by exporting it to a properties file. This allows you to revert to it at a later point using the Import Macro Properties feature or load that configuration to another Confluence instance. 

  1. Click the ellipses next to the Add button.
  2. Select Export Macro Properties from the available options. The Export Macro Properties dialog is displayed.
  3. Click Export and save the file when prompted, to export the enabled macro settings to a properties file.

D. Modify Restrictions (Edit)

You can modify an existing entry to add, change, or remove restrictions.

  1. Hover over the Macro Restrictions field.
  2. Click the pencil icon.
  3. Make your change(s).
  4. Click  check mark to apply your modification.

E. Enable Macro (On)

To enable the restrictions on a specific macro, ensure that the Enable toggle switch is set to the "On" (green) position.

F. Disable Macro (Off)

Although you can disable Macro Security entirely via the Global Configuration tab, it is sometimes useful to disable entries individually. This allows you to disable the restrictions for an entry without losing its configuration in case you want to enable it in the future. It is also useful to disable the restrictions while testing. To disable the restrictions on a specific macro, ensure that the Enable toggle switch is set to the "Off" (gray) position.

G. Remove Entries (Delete)

You can remove an entry when you no longer need it. Use the Export Macro Properties feature to save your configuration before doing this.:

  1. Find the row that you would like to remove within the table.
  2. Click the delete icon.

Global Configuration

This tab contains global settings that control the behavior of the Macro Security app. Once saved, settings provided on this page are immediately applied.

Table: Configuration options explained

Enable Macro SecurityOnThis configuration setting allows you to secure macros and macro parameters at a global level. Use the Secured Macros tab to secure individual macros and macro parameters.
Help Us Improve the ProductOnAs part of building awesome apps, we sometimes need to gather some usage data to continually improve. This app collects and sends some very basic data for us to process. No private user data or personally identifiable information is sent. View the documentation for more details on what is being sent.