Embedded Files
Context
Context
Reports represent a point in time snapshot of data in The Anywhere Platform. When viewing a previously run report, the data presented in that report is always the same.
Reports are based on a template which defines the data to be displayed in the report, the presentation of that data and the filters that an end user can apply to limit what data is displayed.
Creating a report template
Creating a report template
Report templates are essentially a type of dashboard. The steps for creating a report template are therefore very similar to that of a dashboard.
To create the report template click on the dashboard (speedometer) icon in the title bar of the page, next to the search icon.
Click on the '+' icon in the 'My Dashboards' section.
In the 'Explore Dashboards' pop-up window select 'Browse Templates'
From the list of templates select 'Blank Template'
Confirm that you wish to create a dashboard of this template
The pop-up settings window will be displayed
The editor will be displayed and will be blank at this point ready for content to be added.
Click on the properties tab ensure and ensure the following properties are set accordingly:
Click on 'Save' to save the report template.
The next step is to add a header for the report
Basic configuration requirements
Basic configuration requirements
Header Content Area
Header Content Area
All report templates require a specific content area which includes the functions to enable publishing and saving the report data to the database.
Data can saved to the database as meta data in the rpt_meta_data table. If the report is run on a periodic basis, the meta data can be used to report on trends over time.
The header content area should be added to the report using the template: 'Blank Html'
On the Data Filters tab, set the datasource to 'Report Definition Meta Data'. This will collect basic details about the user running the report that can be used in the header.
In the Contents tab set up the layout for the header and include the publish and save functions. An example is shown below:
<div class=RPT_Title_Wrapper>
<div class='RPT_Report_Title_F_Edit lead_txt large_title' id=rprt_title_[D.CA_ID] contenteditable="true"></div>
<div style="margin-top: 7px" class='RPT_Report_Description_F_Edit' id=rprt_desc_[D.CA_ID] contenteditable="true"></div>
<div class='RPT_Report_RunBy' id=rprt_run_by_[D.CA_ID]></div>
</div>
<script>
document.getElementById("rprt_title_[D.CA_ID]").innerHTML=global_translate.getWord("Risk Register Report");
document.getElementById("rprt_desc_[D.CA_ID]").innerHTML="Example Report Description";
document.getElementById("rprt_run_by_[D.CA_ID]").innerHTML=global_translate.getWord("Created by")
+ " [P.RPT_META_DATA.FIRST_NAME] [P.RPT_META_DATA.LAST_NAME] "
+global_translate.getWord("on")+" [P.RPT_META_DATA.NOW]" ;
global_nav.interviewPublishFunction = function(){
var title = document.getElementById("rprt_title_[D.CA_ID]").innerHTML;
var desc= document.getElementById("rprt_desc_[D.CA_ID]").innerHTML;
dashboard_manager.saveReport('[D.DASH_ID]', title, desc, {
/* Begin saving META_DATA */
/* Format: "META_NAME": "META_VALUE" */
"META_DATA_1":"[P.FILTER_VALUE]"
,"META_DATA_2":"[P.DATASOURCE_SCOPE_NAME.DATASOURCE_TOKEN1]"
,"META_DATA_3":"[P.DATASOURCE_SCOPE_NAME.DATASOURCE_TOKEN2]"
,"META_DATA_4":"[P.DATASOURCE_SCOPE_NAME.DATASOURCE_TOKEN3]"
,"META_DATA_5":"[P.DATASOURCE_SCOPE_NAME.DATASOURCE_TOKEN4]"
});
};
global_nav.setStep("View");
</script>
The following table provides an explanation of relevant sections of the code above:
Once the header content area has been added to the report, other content areas can be added. If the some of the values from other content areas need to be saved as meta data, then the header content area will need to be updated accordingly.
Adding content to the report
Adding content to the report
Content areas added to a report in the same way as they are for a dashboard.
Content areas can either be selected from the content area library or new content areas can be added.
Refer to Adding content areas to dashboards for details on how to add and organise content areas.
New content area definitions can be created if required. Refer to Content Area Definitions for details.
Click on 'Save' to save any changes
Defining the overall report layout
Defining the overall report layout
Report templates have a number of available sizes specifically intended for reports.
In the dashboard/report template editor click on 'Open Settings' at the top of the editor.
On the info tab is a 'Size' attribute. From the list select a paper layout, for example 'A4 Paper portrait' or 'A4 Paper landscape' depending on the desired orientation.
Report filters
Report filters
When running a report, end-users will typically need to supply one or more filters to ensure the report displays the information required.
In order to define filters, the report template must be in edit mode. Refer to Editing an existing template for details.
Once in edit mode, click on 'Open Settings' at the top of the editor.
Select the Filters tab.
Click on the '+' icon labelled Add Filter to add a new filter.
Once defined, the report filters can be referenced in datasources and content areas used in the report template.
Editing an existing template
Editing an existing template
From the menu, select 'Config Workbench' under the 'Administration' section.
From the configuration workbench, select 'Report Templates' from the 'Data and Reporting' section. This will open the Report Templates dashboard.
Select a template to edit by clicking on the Id (to the left of the record) or the drill-down arrow to the right of the record. This will open the Report Template Detail page.
In the Report Template Detail page click on 'Edit Template'.
If the template has filters, the filters will be displayed in a pop-up. Values should be entered for these (any value can be selected) and then click on 'OK'. Then click on the Pencil icon in the title bar as if editing a dashboard.
Once the report template is in edit mode, it can be edited in the same way as a dashboard.
Defining who has access to the report template
Defining who has access to the report template
In order to define who is able to create reports with this template, the template must be in edit mode. Refer to Editing an existing template for details.
Click on Open Settings and then select the ‘Access’ tab.
This tab shows the users and groups who have either View or Edit access. Both types of access allow running of the report by users named specifically or who are part of a group listed here. Groups or users having edit access can also change the template.
Click on the '+' icon beneath the Users or Groups section to add access to a user or group. Click on the 'x' icon next to a user or group to remove access.
To change the access, remove the user or group first and then add them again with the correct access.
Click on Save when done.
Report approvals
Report approvals
Reports can optionally be configured to follow an approval process following submission.
An approval form and workflow must first be defined or alternatively the 'Standard Report Approval' process template can be used.
Once the approval form and workflow is defined, open the report template in edit mode. Refer to Editing an existing template for details.
Click on Open Settings and then select the Properties tab.
Set the following values:
Click on Save when done.
Google Sites
Report abuse