Elixir Ad-hoc Reportdocs.elixirtech.com/Ambience/4.0.0/AdhocRpt/fo-xep... · Introduction Elixir...

Elixir Ad-hoc Report

Release 4.0.0

Elixir Technology Pte Ltd

Elixir Ad-hoc Report: Release 4.0.0Elixir Technology Pte Ltd

Published 2015Copyright © 2015 Elixir Technology Pte Ltd

All rights reserved.

Java is a trademark or registered trademark of Oracle Corporation in the United States and other countries. Microsoft and Windows are trademarksof Microsoft Corporation.

Table of Contents1. Introduction ............................................................................................................... 1

Report Level Actions .............................................................................................. 1Creating an Ad-hoc Report ............................................................................... 1Filtering Information ...................................................................................... 2Saving an Ad-hoc Report ................................................................................. 3Viewing an Ad-hoc Report ............................................................................... 3Publishing an Ad-hoc Report ............................................................................ 3Deleting an Ad-hoc Report ............................................................................... 3

Band Level Actions ................................................................................................ 3Creating a Band ............................................................................................. 3Moving a Band .............................................................................................. 4Deleting a Band ............................................................................................. 4

2. Information Band ....................................................................................................... 5Adding a Date element ............................................................................................ 5Adding an Image element ........................................................................................ 6Adding a Section element ........................................................................................ 6Adding a SVG element ........................................................................................... 7Adding a Text element ............................................................................................ 7Adding User information ......................................................................................... 8

3. Table Band ................................................................................................................ 9Adding Groups ...................................................................................................... 9Adding Fields ...................................................................................................... 10Searching Information ........................................................................................... 11

4. Chart Band .............................................................................................................. 13Common Properties .............................................................................................. 13Pie Chart ............................................................................................................ 16Bar Chart ............................................................................................................ 19Column Chart ...................................................................................................... 23Line Chart ........................................................................................................... 23Area Chart .......................................................................................................... 23Scatter Chart ....................................................................................................... 24Exporting a Chart as an Image ................................................................................ 24

5. Pivot Band ............................................................................................................... 25Exporting a Pivot as a CSV, PNG or PDF File ............................................................ 25

6. IFrame .................................................................................................................... 277. Section Break ........................................................................................................... 288. Report Walkthrough - Creating Your Report ................................................................... 29

iii

List of Figures1.1. Report Main Screen .................................................................................................. 21.2. Select Filter Columns ................................................................................................ 21.3. Enable Filters .......................................................................................................... 21.4. Report Bands ........................................................................................................... 42.1. Report Elements for the Information Band .................................................................... 52.2. Date Element for the Information Band ........................................................................ 52.3. Date Output for the Information Band .......................................................................... 62.4. Image Element for the Information Band ...................................................................... 62.5. Section Element for the Information Band ..................................................................... 62.6. SVG Element for the Information Band ........................................................................ 72.7. Text Element for the Information Band ......................................................................... 72.8. Text Element Editor for the Information Band ................................................................ 82.9. User Element for the Information Band ........................................................................ 83.1. Export to CSV ......................................................................................................... 93.2. Report Elements for the Table Band ............................................................................. 93.3. Column Chooser for the Table Band ........................................................................... 103.4. Group Output for the Table Band ............................................................................... 103.5. Field Output for the Table Band ................................................................................. 113.6. Search Table Band .................................................................................................. 113.7. Search Table Criteria ............................................................................................... 124.1. Report Elements for the Chart Band ........................................................................... 134.2. Data Properties ...................................................................................................... 134.3. General Properties .................................................................................................. 144.4. Background Properties ............................................................................................ 144.5. Title Properties ....................................................................................................... 154.6. Legend Properties ................................................................................................... 154.7. Value Properties ..................................................................................................... 164.8. Pie Chart ............................................................................................................... 164.9. Pie Chart With Format None ..................................................................................... 174.10. Pie Chart With Format Key ..................................................................................... 174.11. Pie Chart With Format Key:Value ............................................................................ 184.12. Pie Chart With Format Key:Value% .......................................................................... 184.13. Pie Chart With Format Value ................................................................................... 194.14. Pie Chart With Format Value% ................................................................................ 194.15. Bar Chart ............................................................................................................ 194.16. Stacked Bar Chart ................................................................................................. 204.17. Unstacked Bar Chart .............................................................................................. 214.18. Bar Chart Spacing ................................................................................................. 214.19. Horizontal Axis .................................................................................................... 224.20. Vertical Axis ........................................................................................................ 224.21. Column Chart ...................................................................................................... 234.22. Line Chart ........................................................................................................... 234.23. Area Chart ........................................................................................................... 234.24. Scatter Chart ........................................................................................................ 244.25. Scatter Chart Bubble Properties ............................................................................... 244.26. Export as Image Icon ............................................................................................. 245.1. Example of a Pivot Report ........................................................................................ 255.2. Exporting a Pivot .................................................................................................... 266.1. Example of an IFrame ............................................................................................. 278.1. Create Ad-hoc Report .............................................................................................. 298.2. Select Repository Location ....................................................................................... 308.3. System Creates a Blank Report ................................................................................. 308.4. Setting up the Information Band ................................................................................ 308.5. Setting up the Table Title .......................................................................................... 318.6. Setting up Groups ................................................................................................... 31

iv

8.7. Setting up Fields .................................................................................................... 328.8. Sample Report ....................................................................................................... 32

v

Elixir Ad-hoc Report

Chapter 1Introduction

Elixir Ad-hoc Report is a Web application that enables the designing and navigation of BusinessIntelligence reports. Ad-hoc Report provides several categories of bands for you to design tailor-madereports with numerous pieces of useful information, including tables, charts, cubes, images, date, timeand user-input text. Ad-hoc Report features drag & drop editing without any requirement of writingcode. You can easily create custom reports in a few clicks.

An Ad-hoc Report has two modes - the Analysis mode for editing and the Report mode for viewing.The modes can be easily changed to fit into different situations.

The two modes help you maintain user permissions according to your organization's access policies.Certain users might only be given viewing permissions and not editing permissions. Those users canview the reports in repost mode. For example, the default user called test has only viewing permis-sions.

You can easily structure your report into different sections by adding section breaks as required. Thishelps to organize the report cleanly and present the info in a clear and concise format to the user.

You can easily preview the report in real time, as you construct your report, by clicking the variousbands.

Navigate to http://<host>:8080/elx/ to view the Elixir Ambience Web Console. Type the domain name(for example, “eno”, “foxx”, etc), user name and password to sign in.

The default domain is eno. The default user name is admin. The default password is sa.

Report Level ActionsThis section describes the various report level actions.

Creating an Ad-hoc ReportNavigate to http://<host>:8080/elx/ to view the Elixir Ambience Web Console. Type the domain name(for example, “eno”, “foxx”, etc), user name and password to sign in. After signing into the ElixirAmbience Web Console, you can create an Ad-hoc Report by completing the following steps:

1. Navigate to the Create tab, click Ad-hoc Report, and click the universe (in the following screenshot, CARS is the universe that is present) in which to create the report.

1

Figure 1.1. Report Main Screen

2. Select a location in the repository from the drop-down list. Enter the file name for the report inthe Filename field. Click Create. A blank Ad-hoc Report opens in the Analysis mode, ready forediting. Read on for more detailed information.

Filtering InformationTo filter information in all bands to just the information you want to view:

1.Click the Filter icon ( ).

2.Click the Add Filter icon ( )

3. Select the columns to filter as shown:

Figure 1.2. Select Filter Columns

4. Enable the filters as desired. An example is as follows:

Figure 1.3. Enable Filters

To add more filters, click the Add Filter icon ( ).

2

Introduction

To delete a filter, click the Delete Filter icon ( ).

NoteYou can only filter on dates and enumerated fields (nominals and ordinals). Databaseadministrators who design the Universe, decide on which fields are enumerated and can befiltered.

Saving an Ad-hoc ReportTo save your Ad-hoc Report, complete one of the following:

• Click the Save button. A message pops up, saying “Save successful”.

• Click the Save As... button. The Save As window opens, allowing you to select a location in therepository and enter the new file name.

Viewing an Ad-hoc ReportWhen you need to view your work-in-progress Ad-hoc Report, click the Report button. The outputof the Ad-hoc Report displays in the browser.

Publishing an Ad-hoc ReportTo publish an Ad-hoc Report, click the Publish button. The Publish As window opens, allowingyou to select a location in the repository and enter the new file name. By default, the new file namewill end with -published.report to distinguish it from the original editable report. If you launchthe published report later by opening it from Ambience Web Interface > Repository, it displays asa read-only report in the browser.

After publishing your report, you can view it as many times as you want. Users only need to have viewpermisions to view the report.

NoteOne Ad-hoc Report can have multiple published files. Even if the original editable report isdeleted, the published reports will still exist and allow viewing, though there might be errorsduring record loading.

Deleting an Ad-hoc ReportDeleting an Ad-hoc Report is done from Ambience Web Interface > Repository. Locate the Ad-hocReport file in the repository, click the file and click Delete from the right pane.

Band Level ActionsThis section describes the various band level actions of an Ad-hoc Report. The following instructionsapply to all categories of bands and the Section Break option.

Creating a BandComplete the following steps to create a Band:

1. From the Ambience Web Interface, click Repository, to open an existing Ad-hoc Report, orcreate a new one. The report is opened in Analysis mode, ready for editing.

3

Introduction

2. Click Information Band / Table Band / Chart Band / Pivot Band / Section Break. A blankBand is created.

3. You have the option to rename the Band by entering a new name in the text field below the Bandtitle on the left pane.

Figure 1.4. Report Bands

Moving a BandYou have the option to move a Band to an upper or lower position in the band list. Click the Move

Up ( ) or Move Down ( ) button on the Band according to your needs.

Deleting a BandComplete the following steps to delete a Band:

1. Click the Delete Band ( ) button on the Band.

2. A message displays, asking “Are you sure you want to delete this band?” Click Yes to confirmdeletion.

4

Introduction

Chapter 2Information Band

This chapter describes how to add the following elements to the left, centre or right side of anInformation Band. Expand the Left, Centre or Right drop-down lists, and follow the instructions toadd the elements you want.

Figure 2.1. Report Elements for the Information Band

Adding a Date elementFigure 2.2. Date Element for the Information Band

1. Select Date from a drop-down list as required.

2. Select a date format from the Date drop-down list.

3. Select a time format from the Time drop-down list.

4. Expand the corresponding band on the right pane to view the output.

5

Figure 2.3. Date Output for the Information Band

Adding an Image elementFigure 2.4. Image Element for the Information Band

1. Select Image from a drop-down list as required.

2. Click the Choose File icon. The Choose Image window opens. Locate the image file (GIF,PNG or JPG format) from Repository.


Adding a Section elementThe Section element allows you to organize your report into various HTML sections for clarity.

Figure 2.5. Section Element for the Information Band

1. Select Section from a drop-down list as required.

2. Select a page number format from the Format drop-down list.

6

Information Band


Adding a SVG elementFigure 2.6. SVG Element for the Information Band

1. Select SVG from a drop-down list as required.

2. Click the Choose File icon. The Choose SVG window opens. Locate the SVG file fromRepository.


Adding a Text elementFigure 2.7. Text Element for the Information Band

1. Select Text from a drop-down list as required.

2. Click the Edit Text icon. An embedded Text Editor opens on the right pane. Input your text andcustomize the format.

7

Information Band

Figure 2.8. Text Element Editor for the Information Band


Adding User informationFigure 2.9. User Element for the Information Band

1. Select User from a drop-down list as required.

2. Select a user name or domain format from the Format drop-down list.


You also have the option to select None from a drop-down list. This will leave the specific area of theInformation Band blank.

8

Information Band

Chapter 3Table Band

This chapter describes how to add Groups and Fields to a Table Band. After you finish designing thereport, you can export a Table Band to Excel by clicking the Export to CSV icon:Export to CSV.

Figure 3.1. Export to CSV

Perform the following actions to add elements to the Table Band.

Figure 3.2. Report Elements for the Table Band

Adding Groups1.

Click the Add Column icon ( ) that is below Groups. The Column Chooser window opens.

9

Figure 3.3. Column Chooser for the Table Band

2. Select one or more columns from the window. Click OK.

3. Expand the corresponding band on the right pane to view the output. There will be embeddedtables, and the upper column will contain the lower column, while the lowest column in Groupswill contain the highest column in Fields.

Figure 3.4. Group Output for the Table Band

Adding Fields1.

Click the Add Column icon ( ) that is below Fields. The Column Chooser window opens.

2. Select one or more columns from the window. Click OK.

10

Table Band

3. Expand the corresponding band on the right pane to view the output. There will be embeddedtables, and the upper column will contain the lower column, while the lowest column in Groupswill contain the highest column in Fields.

Figure 3.5. Field Output for the Table Band

Searching InformationTo search a report in a table band and filter information:

1. Click Search, as shown:

Figure 3.6. Search Table Band

2.Click the Add Criteria icon .

3. Define the search criteria and enable it. An example is shown as follows:

11

Table Band

Figure 3.7. Search Table Criteria

To add more search criteria, click the Add Criteria icon .

To delete a search criteria, click the Remove Criterium icon .

12

Table Band

Chapter 4Chart Band

This chapter describes adding a variety of charts to your report. Charts enhance the visual appeal ofthe reports and help the user discern the information easily. Each type of chart contains its own set ofproperties. Follow the instructions to get started with chart designing.

Figure 4.1. Report Elements for the Chart Band

Common PropertiesThis section lists the properties that are common to all the chart types.

• Data:

Figure 4.2. Data Properties

•Key: Describes the fields used to group the data. Click the Choose Column icon ( ). TheColumn Chooser window opens. Make your selection as required.

13

•Value: The values to be plotted on the chart. Click the Choose Column icon ( ). The ColumnChooser window opens. Make your selection as required.

After adding a column, you have the option to edit it by clicking the Edit Column icon ( ).Available operations include Average, Count, Count Distinct, Min, Max, Standard Deviation,Sum, and Variance.

• Sort: Sorts the data before plotting. Available sorting options include Key Ascending, KeyDescending, Value Ascending, Value Descending, and None.

• General Properties:

Figure 4.3. General Properties

• Width: Width of the chart in pixels.

• Height: Height of the chart in pixels.

• Padding: Padding properties insert some separation between the item and the surroundinggraphics. They can be used to tweak the charts to prevent certain items overlapping.

• Palette: Denotes the colour shades for the chart.

• Background: Lets you choose how to fill the background - either solid or gradient. Select the desiredbackground colours from a wide range of colour options. You can also customize the border, byspecifying border width, radius and colour.

Figure 4.4. Background Properties

• Titles: Set the formats for titles and subtitles, including position, alignment, rotation, font andcolour.

14

Chart Band

Figure 4.5. Title Properties

• Legend: Set the legend style, including position, alignment, font, colour, and fill pattern.

Figure 4.6. Legend Properties

• Value: Allows you to customize the display of values. Available options include whether to showor hide the Value, position, padding, font, colour, and border properties.

15

Chart Band

Figure 4.7. Value Properties

Pie ChartFigure 4.8. Pie Chart

The properties are as described in the section called “Common Properties”.

In addition, the following properties are unique to Pie Charts:

Top Count: Indicates the number of largest values to plot. Drag the slider to set the top count.

You can display the values on the pie chart in the following formats. Select one from the Value dropdown:

• None: Netiher the key nor the value is displayed on the pie chart.

16

Chart Band

Figure 4.9. Pie Chart With Format None

• Key: Displays the Key on the pie chart.

Figure 4.10. Pie Chart With Format Key

• Key:Value: Displays the Key and the Value on the pie chart.

17

Chart Band

Figure 4.11. Pie Chart With Format Key:Value

• Key:Value%: Displays the Key and the Value (as a %) on the pie chart. This is especially usefulwhen values such as average are being computed and the value cannot be computed accuratelydue to rounding errors.

Figure 4.12. Pie Chart With Format Key:Value%

• Value: Displays the Value on the pie chart.

18

Chart Band

Figure 4.13. Pie Chart With Format Value

• Value%: Displays the Value (as a %) on the pie chart. This is especially useful when values suchas average are being computed and the value cannot be computed accurately due to rounding errors.

Figure 4.14. Pie Chart With Format Value%

Bar ChartFigure 4.15. Bar Chart

• Data:

19

Chart Band

The properties are as described in the section called “Common Properties”.

In addition, you can set the following Data properties for Bar Charts.

• To add more columns, click the Add Column icon (the + sign), and select another columnfrom the Column Chooser window. To delete an unwanted column, click the Delete Column(the Trash Bin sign) icon.

• Series: Indicates the order in which the data is to be sorted and displayed. The options areAscending, Descending and None (which displays the data as-is without sorting it.)

• Invert Data: Selecting this option enables you to invert data (swap data) from Key and Values.The vertical axis and the chart output will also change.

• General Properties: The properties are as described in the section called “Common Properties”.

• Bar: Allows you to customize the appearance of the chart.

This property is called as Column for column charts. The functionality is identical.

• Stack: Enable this option to stack the bars for the attributes being compared.When this is turned off, the chart is displayed as a clustered graph.

Figure 4.16. Stacked Bar Chart

20

Chart Band

Figure 4.17. Unstacked Bar Chart

• Before: Set the gap (in pixels) before each bar is drawn.

• Between: Set the gap (in pixels) between each bar.

• After: Set the gap (in pixels) after each bar is drawn.

Figure 4.18. Bar Chart Spacing

• Horizontal Axis: Allows you to customize the appearance of the X-axis, labels and stripes.

21

Chart Band

Figure 4.19. Horizontal Axis

• Vertical Axis: Allows you to customize the appearance of the Y-axis, labels and stripes.

Figure 4.20. Vertical Axis

• Background: The properties are as described in the section called “Common Properties”.

• Titles: The properties are as described in the section called “Common Properties”.

• Legend: The properties are as described in the section called “Common Properties”.

• Value: The properties are as described in the section called “Common Properties”.

22

Chart Band

Column ChartFigure 4.21. Column Chart

The properties are as described in the section called “Bar Chart”.

Line ChartFigure 4.22. Line Chart


In addition, there are two Data properties that are specific to Line Charts.

•X Value: Click the Choose Column icon ( ). The Column Chooser window opens. Makeyour selection as required.

The values from the selected column are plotted on the X-axis.

•Y Value: Click the Choose Column icon ( ). The Column Chooser window opens. Makeyour selection as required. After adding a column, you have the option to edit it by clicking the

Edit Column icon ( ). Available operations include Average, Count, Count Distinct, Min, Max,Standard Deviation, Sum, and Variance.

The values from the selected column are plotted on the Y-axis.

Area ChartFigure 4.23. Area Chart

The properties are as described in the section called “Line Chart”.

23

Chart Band

Scatter ChartFigure 4.24. Scatter Chart


In addition, there are two properties that are specific to Line Charts.

• R Value (Data Property): This sets the selected data column to be the scaled radius of the individualpoints (bubbles) of the chart .

• Bubble: Allows you to set the radius and the opacity level of the individual points (bubbles) of thechart.

Figure 4.25. Scatter Chart Bubble Properties

Exporting a Chart as an ImageTo export a chart as a PNG image, click the Export as Image icon. Save the image.

Figure 4.26. Export as Image Icon

24

Chart Band

Chapter 5Pivot Band

This chapter shows how to add a Cube to your report, which makes it convenient to visualize multi-dimensional data. Follow the instructions to customize your Cube by setting a few properties.

•Columns: Click the Add Column icon ( ). The Column Chooser window opens. Make yourselection as required. You have the option to add multiple columns, or delete the unwanted columns.

•Rows: Click the Add Row icon ( ). The Column Chooser window opens. Make your selectionas required. You have the option to add multiple columns, or delete the unwanted columns.

•Measures: Click the Add Column icon ( ). The Column Chooser window opens. Make yourselection as required. You have the option to add multiple columns, or delete the unwanted columns.

• Row Header: Available options include showing the row's root, totals, totals first and header labels,enforcing hierarchical levels, as well as naming the row's root label and total label.

• Column Header: Available options include showing the column's root, totals, totals first and headerlabels, enforcing hierarchical levels, as well as naming the column's root label and total label.

The following screenshot shows an example of a Pivot Report.

Figure 5.1. Example of a Pivot Report

Exporting a Pivot as a CSV, PNG or PDF FileTo save a Pivot as either a CSV, PNG or PDF file, click the relevant option as shown.

25

Figure 5.2. Exporting a Pivot

Save the exported file.

26

Pivot Band

Chapter 6IFrame

This chapter shows how to add a IFrame to your report. An inline frame is used to embed anotherdocument within the current report.

You can even embed a published dashboard into a report, thus making the report very interactive.

• URL: The URL of the page to be embedded into the IFrame.

• Height: The height of the IFrame in pixels. The width is automatically adjusted based on the height,to maintain the correct aspect ratio.

The following screen shot shows an example of a Ad Hoc Dashboard embedded into an IFrame.

Figure 6.1. Example of an IFrame

27

Chapter 7Section Break

This chapter describes the simple step of adding a Section Break.

Adding section beaks allows you to organize your report into multiple HTML sections for clarity.

Click Section Break. You will see a new Section Break immediately showing in your report.

28

Chapter 8Report Walkthrough - CreatingYour Report

This chapter walks you through creating an example report step-by-step. To create a report:

1. Login to the application.

Navigate to http://<host>:8080/elx/ to view the Elixir Ambience Web Console. Type the domainname (for example, “eno”, “foxx”, etc) and the appropriate user name and password to sign in.

2. Click Create - Ad-hoc Report and then click the relevant universe - in this example Cars asshown in Figure 8.1, “Create Ad-hoc Report”:

Figure 8.1. Create Ad-hoc Report

3. Select a location in the repository from the drop-down list, as shown in Figure 8.2, “SelectRepository Location”. Enter the file name and click Create.

29

Figure 8.2. Select Repository Location

4. The system creates a blank report, and opens it in a new browser tab as shown in Figure 8.3,“System Creates a Blank Report”.

Figure 8.3. System Creates a Blank Report

5. Click the Information band and enter a title. Select the page number to be on the left, and the dateand time to be on the right side of the page, as shown in Figure 8.4, “Setting up the InformationBand”.

Figure 8.4. Setting up the Information Band

6. Click the Table Band and enter a title as shown in Figure 8.5, “Setting up the Table Title”.

30

Report Walkthrough - Creating YourReport

Figure 8.5. Setting up the Table Title

7. Click the Add Column icon (+ sign) under Groups and select the Groups for display, as shownin Figure 8.6, “Setting up Groups”.

Figure 8.6. Setting up Groups

8. Click the Add Column icon (+ sign) under Fields and select the Fields for display, as shown inFigure 8.7, “Setting up Fields”.

31


Figure 8.7. Setting up Fields

9. Click Report on the main toolbar to preview your report, as shown in Figure 8.8, “Sample Report”.

Figure 8.8. Sample Report

32


Elixir Ad-hoc Reportdocs.elixirtech.com/Ambience/4.0.0/AdhocRpt/fo-xep... · Introduction Elixir...

Documents

Transcript of Elixir Ad-hoc Reportdocs.elixirtech.com/Ambience/4.0.0/AdhocRpt/fo-xep... · Introduction Elixir...