Admin ServiceManager Further Details Summary Page Configuration

Summary Page configuration

The ‘Summary’ pages displayed by ServiceManager can be configured to include, or exclude certain columns according to the required installation. Additionally, it is possible to define the default ordering criteria applied to each Summary page in the installation. This configuration is in addition to the permissions settings that apply to individual users.

In order to configure the sort order and content of the Summary pages, the Report Structure configuration files must be specified. Default copies of these files can be located in the WEB-INF/classes/resources folder:

master_report_structure.xml

user_report_structure.xml

These files are accompanied by, and make reference to their Document Type Definition file (master_report_structure.dtd and user_report_structure.dtd). The location of the XML files must be specified in the service_manager.properties file:

# location of the XML files defining the configuration of the reports visible to the user
report.config.location.masterFile=<path>/master_report_structure.xml
report.config.location.userFile=<path>/user_report_structure.xml

Summary pages default settings

The master_report_structure.xml document is read only and should only be updated by ServiceManager developers in conjunction with modifications to the ServiceManager application code. However, it provides a valuable source of information to the ServiceManager administrator, recording the default settings for each of the configurable Summary pages and consequently serving as a template for specifying overrides to the defaults which are made in the user_report_structure.xml file.

Summary page customisation

n order to override the default settings for Summary pages, the required values for the Summaries to be overridden should be specified in the user_report_structure.xml file. The content added to this file must comply with the rules defined by the document definition contained in user_report_structure.dtd.

The following example shows an extract from the Shift Override Summary configuration in master_report_structure.xml with the Lunch details section expanded:

</SERVICEManager:SummaryReport>
- <SERVICEManager:SummaryReport name="Shift Override Summary">
+ <SERVICEManager:ParentColumn name="Shift Overrides">
+ <SERVICEManager:ParentColumn name="Shift Start">
+ <SERVICEManager:ParentColumn name="Shift End">
- <SERVICEManager:ParentColumn name="Lunch">
  <SERVICEManager:IsVisible visible="true" /> 
- <SERVICEManager:ColumnDetail name="L.Earliest">
  <SERVICEManager:SortOrder weighting="9" /> 
  <SERVICEManager:SortDirection ascending="true" /> 
  <SERVICEManager:IsSortable sortable="false" /> 
  <SERVICEManager:IsVisible visible="true" /> 
  <SERVICEManager:Field>earliestLunch</SERVICEManager:Field> 
  </SERVICEManager:ColumnDetail>
- <SERVICEManager:ColumnDetail name="L.Latest">
  <SERVICEManager:SortOrder weighting="10" /> 
  <SERVICEManager:SortDirection ascending="true" /> 
  <SERVICEManager:IsSortable sortable="false" /> 
  <SERVICEManager:IsVisible visible="true" /> 
  <SERVICEManager:Field>latestLunch</SERVICEManager:Field> 
  </SERVICEManager:ColumnDetail>
- <SERVICEManager:ColumnDetail name="L.Duration">
  <SERVICEManager:SortOrder weighting="11" /> 
  <SERVICEManager:SortDirection ascending="true" /> 
  <SERVICEManager:IsSortable sortable="false" /> 
  <SERVICEManager:IsVisible visible="true" /> 
  <SERVICEManager:Field>lunchDuration</SERVICEManager:Field> 
  </SERVICEManager:ColumnDetail>
  </SERVICEManager:ParentColumn>
+ <SERVICEManager:ParentColumn name="Local Knowledge">
</SERVICEManager:SummaryReport>

By adding a modified instance of this report to user_report_structure.xml file it is possible to override the initial sort characteristics by changing the SortOrder, SortDirection, or IsSortable attributes It is also possible to change the labels displayed when the Sort control dialogue is invoked by the user by changing the name attribute and whether the column or section of report is displayed at all by changing the IsVisible attribute.