Loading Default Reports and Views

Overview

The default process dashboard template, process model dashboard template, and default system reports, and the email header/footer templates are created the first time Appian is started after installation. Any customizations or additions to these will be preserved on subsequent startups. If any of these are inadvertently deleted, restarting the application server will recover them.

System reports and pages

After starting Appian the first time, an XML file entitled analytics-config.xml is generated in the <APPIAN_HOME>/deployment/web.war/WEB-INF/conf/analytics/ directory.

To customize this file see Configuring Custom Properties.
- Customized analytics-config.xml settings for process and process model dashboard templates are ignored.
- If a local ID for a report is referenced in your analytics-config.xml file (or a customized analytics-config.xml file) which was an accepted configuration in prior releases, it is ignored.

The following is a code snippet from the file.

analytics-config.xml

 <?xml version="1.0" encoding="UTF-8"?>
 <analyticsConfig>
   <aliases>
     <alias>
       <name>process_details_per_process_model</name>
       <reportUuid>SYSTEM_REPORT_PROCESS_DETAILS_PER_PROCESS_MODEL</reportUuid>
     </alias>
     <alias>
       <name>active_tasks_group</name>
       <reportUuid>SYSTEM_REPORT_ACTIVE_TASKS_GROUP</reportUuid>
     </alias>
     <alias>
       <name>tasks_for_user</name>
       <reportUuid>SYSTEM_REPORT_TASKS_FOR_USER</reportUuid>
     </alias>
       .......
   </aliases>
   <displayTypes>
     <displayType>
       <typedVariable>13</typedVariable>
       <columnAlignment>center</columnAlignment>
       <name>collabimage</name>
     </displayType>
     <displayType>
       <typedVariable>16</typedVariable>
       <columnAlignment>left</columnAlignment>
       <name>forums</name>
     </displayType>
     .......
   </displayTypes>
     <systemProcessViews>
       <systemProcessView>favorite_processes</systemProcessView>
       <systemProcessView>all_processes</systemProcessView>
       <systemProcessView>active_processes</systemProcessView>
       <systemProcessView>completed_processes</systemProcessView>
       <systemProcessView>paused_processes</systemProcessView>
       <systemProcessView>cancelled_processes</systemProcessView>
       <systemProcessView>processes_with_problems</systemProcessView>
       <systemProcessView>processes_started_by_me</systemProcessView>
       <systemProcessView>subprocesses_per_process</systemProcessView>
     </systemProcessViews>
     <systemTaskViews>
       <systemTaskView>all_tasks</systemTaskView>
       <systemTaskView>favorite_tasks</systemTaskView>
       <systemTaskView>active_tasks</systemTaskView>
       <systemTaskView>completed_tasks</systemTaskView>
       <systemTaskView>high_priority_tasks</systemTaskView>
       <systemTaskView>active_tasks_group</systemTaskView>
       <systemTaskView>active_tasks_group_members</systemTaskView>
       <systemTaskView>tasks_per_pm</systemTaskView>
       <systemTaskView>tasks_due_today</systemTaskView>
       <systemTaskView>overdue_tasks</systemTaskView>
     </systemTaskViews>
 </analyticsConfig>

The different XML tags that are used within this configuration file and their descriptions are included in the table below:

Name	Description
analyticsConfig	Configuration settings for all new reports.
systemTaskViews	This element contains the list of report aliases for the reports used to generate the Task views avaiable on the left navigation of the `Tasks` tab in the Application Designer. The order that these aliases are entered in the XML file is the order in which the reports are displayed.
systemTaskView	Element containing the aliases
displayTypes	Element containing the list of display tokens used in analytics.
displayType	Element containing each display token. These tokens appear in the dropdown format on the Edit Data dialog. To add your own format you must register it here and include it in the dropdown on /analytics/report_config/addEditData.jsp.
typedVariable	This defines the typed variable type that the token is meant to handle. The keys can be looked up in TypedVariableTypes.java
columnAlignment	This defines how the data will be aligned in the grid for a given format.
name	The display token name referenced in token-display-config.xml.
systemProcessViews	Element containing the list of report aliases used to display the process views available on the left navigation of the `Processes` tab in the Application Designer. The order that these aliases are entered in the XML file is the same order the reports are displayed on the process views navigation pane.
systemProcessView	Element containing each alias
aliases	Element containing alias tags.
alias	Aliases allow you to define keys for reports that are used to generate internal links (and references using the taglib). The alias is tied to the underlying report UUID in this file.
name	The name of the alias.
reportUuid	A system identifier for a report, which is the same on every system where the report is used. If a report does not have a UUID, it can be added to the report by exporting and importing it with an application. If the report UUID is changed, update the alias (if necessary) and restart the application server.

Feedback

Was this page helpful?