On this page
Configure Macro Security for Confluence
After upgrading or installing Macro Security for Confluence, navigate to the Global Configuration screen:
- Log in with the System Administrator Global Permission.
- Select Add-ons from the cog icon at the top right corner of your screen.
- Scroll down to Bob Swift Configuration on the sidebar.
- 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. This screen allows you to add, edit, enable or disable, and delete entries. Refer to the following image succeeded by the details of the usage of each option on the page:
A. Restrict a Macro (Add)
To restrict a new macro:
- 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.
- Enter the user(s), group(s) and/or Space names that usage of this macro is restricted to.
- Click the Add button.
B. Import Macro Properties
To import macro properties:
- Click the ellipses next to the Add button.
- Select Import Macro Properties from the available options. The Import Macro Properties dialog is displayed.
- Click Browse to browse and select the required properties file.
- (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
- Click Import to import the selected file. A successful import message is displayed.
C. Export Macro Properties
To export macro properties:
- Click the ellipses next to the Add button.
- Select Export Macro Properties from the available options. The Export Macro Properties dialog is displayed.
- Click Export and save the file when prompted, to export the enabled macro settings to a properties file.
D. Modify Restrictions (Edit)
To change, add, or remove certain restrictions for a given macro:
- Hover over the Macro Restrictions field.
- Click the pencil icon.
- Make your change(s).
- Click check mark to apply your modification.
E. Enable Macro (On)
To enable security for a specific macro, ensure that the Enable toggle switch is set to the "On" (green) position.
F. Disable Macro (Off)
To disable security for a specific macro, ensure that the Enable toggle switch is set to the "Off" (gray) position.
G. Remove Entries (Delete)
To remove an entry for a specific macro:
- Find the row that you would like to remove within the table.
- 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
Option | Default | Description |
---|---|---|
Help Us Improve the Product | On | As 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. |
Enable Macro Security | On | This 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. |
Next Step: Understanding How Macro Security Works
With global settings and macro security in place, the next step is to bring you up to speed on how macro security works.