Action button parameters
Synchronization parameters are available for action buttons when navigating to another book or running processes that use synchronization.
Navigation
When navigating to another book using an action button, you can choose to have synchronization settings from the source book copy over to the target book. Select the Pass context option under Navigation properties to synchronize settings.
When you pass context from the source book to the target book, default synchronization settings
pass to provide context to the same synchronization group in the target book. Note, this table lists
all of the possible synchronization mappings for the default mode and only one of
them is used when navigating to the target book.
| Source book (default group) | Target book (default group) | Result |
|---|---|---|
| Book | Book | Synchronization settings are copied from the Book synchronization group in the source book to the Book synchronization group in target book. |
| Book | Sheet | Synchronization settings are copied from the Book synchronization group in the source book to all the tabs in target book. |
| Sheet | Book | Synchronization settings are copied from the current tab in the source book to the Book synchronization group in target book. |
| Sheet | Sheet | Synchronization settings are copied from the current tab in the source book to the opened tab in the target book. |
| Custom group | Book | Synchronization settings are copied from the Custom group in the source book to the Book synchronization group in the target book. |
| Custom group | Sheet | Synchronization settings are copied from the Custom group in the source book to all the tabs in the target book. |
| Book | Custom group | Synchronization settings are copied from the Book synchronization group in the source book to the Custom group in the target book. |
| Sheet | Custom group | Synchronization settings are copied from the current tab in the source book to the Custom group in the target book. |
| Custom group 1 | Custom group 2 | Synchronization settings are copied from a Custom group in the source book to another Custom group in the target book. |
Synchronization settings also copy over from the source book to the target book for any synchronization groups that are present in both books. These groups must have names that are an exact match.
Advanced context
When you choose to pass context with an action button, you can override the default synchronization settings described in the section above with Advanced context. The Advanced context feature lets you map a source synchronization group to a target synchronization group and select which hierarchies that are common to both groups, receive context. You can configure multiple action buttons to pass context to a single target book and drill through data easily.
Before you can map a synchronization group from the source book to the synchronization group in the target book, you need to first set up synchronization and the widgets in both books need to be of the same synchronization group. Advanced context supports all three synchronization groups (Book, Sheet, and Custom).
To map synchronization groups and configure context passing, follow these steps:
- In edit mode, add an action button to the source book.
- Go to the action button's Properties and under Navigation, enable Navigate to destination.
- Click Other book and select a target book and the tab that you want to pass context to.
- Click Pass context.
The Advanced context link becomes available.
- Click Advanced context and select Custom group mapping.Note: The Default group mapping displays the default synchronization groups and hierarchies. To edit or configure these settings, go to Custom group mapping.
- Select the source group, which passes the context, the target group that receives the context,
and the hierarchies you want to synchronize.
You can add more mappings or remove existing ones under Custom.
Now, change the hierarchies in a widget in the source book and click the action button. You automatically navigate to the target book and hierarchies that were selected to synchronize, update in the widget.
Run process
You can run a process using synchronization from the Set parameters dialog. Select the synchronization group from the Control Type menu for each parameter. You can now select from the following:
- Synchronize Default group
- Synchronize Book
- Synchronize <tab name>
- Synchronize <custom group name>
When you select a synchronization group, you can also select synchronized dimensions and hierarchies in the Control Detail menu. Only the synchronized dimensions and hierarchies in the selected group display in the Control Detail menu. Dimensions from control cubes are also supported in the Control Detail menu.
