A loop is a sequence of instructions that will continually run a process as many times as is defined in the loop definition. For example, a book can be set up to loop through all the base entities under a particular hierarchy and generate an instance of the same cube view report for each entity.
Loop Type
There are three types of Loops to use when building your book:
Comma Separated List: Select this option to enter values separated by a comma to be referenced later in the book hierarchy.
Dashboard Parameter: Select this option to use a pre-configured Parameter found in the Application Dashboards page.
For example, a ParamSalesRegions parameter returns a list of all Sales Regions within the application resulting in the report book’s loop variables using the same list.
Member Filter: Select this option to utilize the member filter builder to build a member filter based on dimension members.
This loop will run each of the report book items for the specified members.
Loop Definition
When using the loop type Comma Separated List, enter a comma-separated list of text values to loop over. Use brackets [ ] when names have spaces.
For example:
(Houston, Clubs, [Houston Heights])
When using the loop type Dashboard Parameter Loop Type Used, enter the name of a dashboard parameter to create a list based on an existing parameter.
For example, a ParamSalesRegions parameter returns a list of all Sales Regions within the application resulting in the report book's loop variables using the same list.
When using the loop type Member Filter Loop Type Used, enter a member filter to supply a list of members to use in the loop.
For example:
E#Frankfurt, E#Houston, E#Montreal
This loops over each entity and performs the process three times.
E#[NA Clubs].Base
This loops over each base entity under NA Clubs and performs the process for however many base entities there are.
Dimension (only available when Member Filter is the Loop Type)
The name of the specific dimension used by the member filter. Click the ellipsis and select the correct dimension.
Loop Variables
Create loop variables by selecting a variable from the drop down menu.
|Loop1-4Variable|
Allows all Report Book items located in the loop’s hierarchy to reference the loop definition's values by name.
Up to four loop variables can be referenced and all must be enclosed in |pipes|.
For example
|Loop1Variable|.
Use |Loop2Variable| through |Loop4Variable| to create nested loops within a loop.
|LoopDisplay1-4Variable|
Allows all report book items in the loop hierarchy to reference the loop definition's values by description.
For example
|Loop1Display|
|Use |Loop2Display| through |Loop4Display| to create nested loops within a loop.
|Loop1-4Index|
Assigns a number to the values in the loop definition beginning with number one, which can be referenced in the report book items in the hierarchy.
Use |Loop2Index| through |Loop4Index| to create nested loops in a loop.
