Creating Snippets

Create a snippet

The following steps are common to all snippet types. Steps may vary slightly depending on the specific snippet type.

1. In the Explorer, select a sheet, standard model, or virtual model to base the snippet on.

   Note: OData snippets can only be created for sheets.

2. Click the Snippets icon on the level 2 header. The Snippets pane displays.

3. Click Create Snippets at the bottom and select a snippet type: Report, Visual, Input, Control, or OData. The Snippet Design Pane opens.

4. Design the snippet details as below. The UI options may vary slightly depending on the snippet type.

   • Name: Name of the snippet.

   • Title: Snippet name to be displayed.

   • Technical ID: This property is only available to OData snippets. It should be a unique ID across all snippet types.

   • Private: Checked by default.

   • Fields pane: All the fields and their attributes can be viewed by expanding the sections. Move the desired attributes to rows, columns, or filters in the design pane layout, by hovering over an item and then clicking the down arrow, right arrow, or Filter icon.

   • Layout: Field attributes moved from the Fields pane will appear here. Click the Filter icon to select members. Click the ellipsis icon to move fields within the layout or remove them.

     For the Visual type snippet, Axis (Categories) represents the data displayed in rows, while Legend (Series) pertains to the data presented in columns.

     Note: OData snippets do not have columns.

   • Options: Configure the options as you want.

   For more information, see Snippet Design Pane.

5. Click Refresh to apply the settings and view updated data.

6. Click Publish to publish the snippet.

7. For Visual snippets, you can convert within visual types using the charts option from the level 2 header, apply styles, and manipulate visual display elements like data labels, axis titles, legends, etc.

Video for Creating a Report Snippet

Video for Creating a Visual Snippet

Example of Creating a Report Snippet

1. In the Explorer, expand Financial Planning & Analysis.

2. Expand the Standard App, then Revenue Planning and then click the Gross Sales sheet to proceed.

3. Make sure that your Gross Sales sheet contains these assignments:

   1. Plan - Current Plan

   2. 2024 - 2024

   3. All-Customer

   4. PS-Standard

   5. All-Company

   

4. In the sheet, click the Snippets icon.

5. At the bottom of the pane, click Create Snippets and select Report.

6. In the Report Details pane, type Gross Sales in the Name and Title fields.

   Note: The Name must be unique in your JustPerform environment.

7. Ensure that the Private checkbox is unchecked to make the report accessible to others.

8. Next, organize the report layout into the desired Columns and Rows.

   • Drag and drop the Products field into the Rows section.

   • Drag and drop Company field to the Columns section.

   • Drag and drop Customers field to the Filters section.

   • Drag and drop Time from the Fields section and Metrics from the Rows section to the Filters section.

9. Now we want to use filters to identify which products to include. Click the Filter icon beside the Products field.

10. From the MEMBER SELECTOR window expand the All-Products folder, the PO-All Types folder, and then enable the checkbox beside PS-Standard products.

11. Click the Relationship dropdown and scroll to select Current Member & Leaf Members and then click Insert Members.

    • The filtered products now appear on the right side of the MEMBER SELECTOR popup.

12. We will check the box beside FAContext - FAContext on the right and click the trashcan icon to remove the selection focusing on Standard Products only.

13. Click OKAY.

14. Repeat the same steps for Company field.

    • Click the Filter icon beside the Company field.

    • From the MEMBER SELECTOR window, expand the All-Company folder.

    • Click the Relationship dropdown and select Leaf Members and then click Insert Members.

    • Check the box beside FAContext - FAContext and then click the trashcan icon to remove the selection.

    • Click OKAY.

15. Repeat the same steps for Customers field.

    • Click the Filter icon beside the Customers field.

    • From the MEMBER SELECTOR window, select the All-Customer folder.

    • Click the Relationship dropdown and select Current Member and then click Insert Members.

    • Check the box beside FAContext - FAContext and then click the trashcan icon to remove the selection.

    • Click OKAY.

16. Select the Filter icon next to Metric Gross Sales.

17. Check the box next to Gross Sales.

18. Click the Relationship dropdown and select Leaf Member and then click Insert Members.

19. Click the Publish icon.