User flow
Navigation
The Parameters feature is available for stories in the JustPerform Excel Add-in. Under the Tasks menu, the Parameters section is available for configuration and maintenance as described below. Parameters created at the workbook level can be used in any of the reports created in the workbook.
User flow
In the image below are the detailed steps or task list for the definition and usage of parameters.
Create Parameter
To define the parameters, click on the +Add button and populate the following information:
- Name: The parameter name used to define the variable that can be used dynamically.
-
Type: Select the type of context:
- User Context: If the parameter value is to be read from the user context selected.
- Book Context: If the parameter value is to be read from a specific Excel book cell value.
-
Fields: Select the field/property from the field member selector grouped by models.
Note: ID or Property can be selected based on the relationship scenario defined.
-
Reference: Select the cell in the Excel workbook to read the parameter context value.
Note: Applicable only for Type = Book Context.
- Relationship: Leaf members.
Note: The output of parameter value can be single/multiple members.
Example: Profit center parameter defined based on user context.
Using a Parameter
Parameters can be used in any of the reports. Under report definition, parameters are available for selection in both:
Member selector of the respective field (for which the parameter has been created).
Member selector of all fields where the parameter field is used as Linked to property.
Parameters are identified in variable format such as %Parameter name%.
Users can select the parameter and relationship.
When the report is refreshed, the parameter will be read from the context and passed to the report definition. The dynamic report is refreshed with all values possible based on the context.