Reviewing the Sample Bursting Definition Files

The Bursting definition samples are provided for you to see and use examples of the bursting functionality. This section describes the bursting samples.

Note: In this section, any reference to the sample bursting CSV file is available for Narrative Reporting Deployments only.

After the service administrator deploys the Sample Content, you can review the sample bursting definitions. For more information, see Installing Samples.

Use the samples as a guideline to create your own bursting definitions.

The sample bursting files include the following:

  • Sample Targeted Distribution files:

    • bursting_file_segments.csv

      This Targeted Distribution CSV file that is used in the Sample Bursting Definition 1, which contains level 0 members from the Segments dimension and some fictitious (not real) user IDs and email addresses for the first five members.


      Bursting csv file with segments
    • bursting_file_empty.csv

      This Targeted Distribution CSV file contains only the column headings so that you can use it as a starting point for creating a new Targeted Distribution file.


      Bursting csv file with the column heading
  • Sample Bursting Definition files:

    • Sample Bursting Definition 1

    • Sample Bursting Definition 2

    • Sample Bursting Definition 3

Sample Bursting Definitions

These sample bursting definitions use some fictitious (not real) email addresses for Success and Failure notifications and utilize the Samples folder as a Root Folder for all the output file published to the Library.

All Sample Bursting Definition files use the text function called ArtifactName() for the folder path, which is created under the Root Folder and contains all the output file.

Sample Bursting Definition 1

The Sample Bursting Definition 1 contains a Targeted Distribution File to burst output of a report across the Segments dimension, both emailing the output files to respective users and publishing the output files to the Library.

This Bursting Definition uses Sample Report 1 as the bursting artifact and utilizes the bursting_file_segments.csv file as a Targeted Distribution file, with five of the Segment members selected in the Bursting POV Dimension.

Review the following image, which shows the Sample Bursting Definition 1 selections:


Sample Bursting Definition 1

Let’s review the following example:

  • The Fiscal Calendar dimension is a Global Dimension, with June selected

  • Both Email and Library channels are selected with the following information:

    • Under Email, in the Attachment Name field displays the following text: ArtifactDescription() - MemberAlias("Segments").

    • Under Library, in the Artifact Name field displays the following text: ArtifactDescription() - MemberAlias("Segments").

  • The resulting PDF file names are displayed based on the Report Description and the Segment Member Name. For example, Income Statement Act vs Plan - Bookshelf Audio System.pdf

After executing the Sample Bursting Definition:

  • The output file is generated for the five Segments selected in the Bursting POV Dimension.

  • For the Email channel, the email addresses in the distribution file listed for each member, in both the external_emails and user_emails columns, the respective users will be emailed their corresponding output file.

    For example, for the BAS member, jane.q.public@example.com and user0001 will be emailed the resulting output, and so on.

  • For the Library channel, all five output files will be published to the Library under the Root Folder - Samples, under the subfolder of " Sample Report 1 " (As the result of text function used in the ArtifactName, and Path Hierarchy).

    The Library access permissions will be granted for each output based on the distribution file in the user_names column. For example, for the BAS member, user0001 will be granted access to the resulting output, and so on.

  • The email address specified in the Success Notification, jaime.sommers@example.com, will be sent an email with the successful execution information for the bursting definition.


publishing the pdf files to the library sample bursting def 1

Sample Bursting Definition 2

This Sample Bursting Definition generates a output of a report across the Segments dimension without a Targeted Distribution file, both emailing all the output files to specified users and publishing the output files to the Library.

This Bursting Definition uses Sample Report 1 as the bursting artifact, with 5 of the Segment members selected in the Bursting POV Dimension.

Review the following image, which shows the Sample Bursting Definition 2 selections:


sample bursting definition 2

Let’s review the following example:

  • The Fiscal Calendar dimension is a Global Dimension, with June selected

  • Both Email and Library channels are selected with the following information:

    • Under Email, the Attachment Name field displays the following text: ArtifactDescription() - MemberAlias("Segments").

    • Under Library, the Artifact Name field displays the following text: ArtifactDescription() - MemberAlias("Segments").

  • The resulting output file names are displayed based on the Report Description and the Segment Member Name. For example, Income Statement Act vs Plan - Bookshelf Audio System.pdf

After executing the Sample Bursting Definition:

  • The output file is generated for the five Segments selected in the Bursting POV Dimension.

  • For the Email channel, the Send all generated reports to all recipients in a single email option is selected and the Distribution File is not used, the two user emails specified in the Distribution List, both zachary.smith@example.com, and jane.q.public@example.com will get an email with all the five output files attached.

  • For the Library channel, the Assign all permissions to the generated reports option is selected and the Distribution File is not used. Only users specified in the User List will be granted permissions to the resulting output files.

    Note:

    This is a sample Bursting File and every customer will have different users in their system, so there are no system users in the User List.

    All five output files will be published to the Library under the Root Folder - Samples, under the subfolder of " Sample Report 1 " (As the result of the text function used in the ArtifactName and Path Hierarchy).

  • The email address specified in the Success Notification, jaime.sommers@example.com, will be sent an email with the successful execution information for the bursting definition.


publishing the pdf files to the library sample bursting def 2

Sample Bursting Definition 3

This Sample Bursting Definition generates a single output of a Book, with no bursting across a dimension, and the outcome of the output file will be sent through email to the specified users, and publish the output file to the Library.

This Bursting Definition uses Sample Book 1.1 as the bursting artifact, with the Bursting POV dimension set to None, therefore only one output file will be generated, and the Targeted Distribution file is not used.

Review the following image, which shows the Sample Bursting Definition 3 selections:


sample bursting definition 3

Let’s review the following example:

  • The Fiscal Calendar dimension is a Global Dimension, with June selected

  • Both Email and Library channels are selected with the following information:

    • Under Email, the Attachment Name field displays the following text: ArtifactName() - MemberName("Fiscal Calendar").

    • Under Library, the Artifact Name field displays the following text: ArtifactName() - MemberName("Fiscal Calendar").

  • The resulting output file names are displayed based on the Book Name and the Fiscal Calendar Member Name. For example, Sample Book 1.1 – June.pdf

After executing the Sample Bursting Definition:

  • One output file is generated because the Bursting POV Dimension is set to None and bursting across multiple members is not available.

  • For the Email channel, as the Distribution File is not used, the two user emails specified in the Distribution List, both zachary.smith@example.com, and jane.q.public@example.com will get an email with only one output file attached.

  • For the Library channel, the Distribution File is not used and only users specified in the User List will be granted permissions to the resulting output file.

    Note:

    This is a sample Bursting File. Every customer will have different users in their system, so there are no system users in the User List.

    The output file will be published to the Library under the Root Folder - Samples, under the subfolder of " Sample Book 1.1 " (As the result of the text function used in the ArtifactName and Path Hierarchy).

  • The email address specified in the Success Notification, jaime.sommers@example.com, will be sent an email with the successful execution information for the bursting definition.


publishing the pdf files to the library sample bursting def 3