Responder Developer Guide
Responder Reports

Version: 10.8.1a

Resource Center Home
Responder Overview > Responder Customizations > Responder Reports

Custom reports may be viewed in Archive Explorer on the Reports tab or in Responder Explorer using the Generate Reports tool. All reports in Archive Explorer are defined in the ArchiveQueriesConfig.xml. Reports viewed in Responder Explorer are defined in DataQueriesConfig.xml.

To modify an existing report or create your own, you need to edit ArchiveQueriesConfig.xml or DataQueriesConfig.xml. These files are installed with Responder Server. By default they are installed here: \Program Files\Miner and Miner\Responder\Server. Open them with any application that allows you to edit XML (e.g., Notepad, XML Spy).

The XML is grouped into several QueryPackages. In ArchiveQueriesConfig.xml, edit the ArchiveReports query package. In DataQueriesConfig.xml, look for the DataReports QueryPackage.

  1. Open the appropriate XML file (ArchiveQueriesConfig.xml or DataQueriesConfig.xml).
  2. Look for the QueryPackage key value that corresponds to the file you're editing. ArchiveQueriesConfig.xml: <QueryPackage Key="ArchiveReports">; DataQueriesConfig.xml: <QueryPackage Key="DataReports">. These sections contain a QueryClass section for each report available. When you add a QueryClass to this section, it is included in the list of reports in either Archive Explorer or Responder Explorer.
  3. You can copy an existing QueryClass and manipulate it (easiest choice) or create your own (most room for error). Below is an example of a QueryClass in ArchiveQueriesConfig.xml.
XML Snippet
Copy Code 
 1 <QueryClass Key="IncidentDateRange" Caption="Incidents by Date Range" Category="Browser">
 2   <Properties>
 3    <!--NOTE: DateTime format for xml file must be in SortableDateTimeFormat yyyy'-'MM'-'dd'T'HH':'mm':'ss-->    
 4     <b:Property Key="Description" Value="A tabular report of incidents with outage time within a date range."/>
 5     <b:Property Key="BeginTime" Value="2007-01-01T00:00:00"/>
 6     <b:Property Key="EndTime" Value="2007-12-31T23:59:00"/>
 7     <b:Property Key="XSLPath" Value="%ALLUSERSPROFILE%\Application Data\Miner and Miner\Responder\IncidentsByDate.xslt"/>
 8   </Properties>
 9   <Inputs>
10     <Input Type="Miner.Responder.ArchiveExplorer.Filters.IncidentDateRangeInput,Miner.Responder.ArchiveExplorer"/>
11   </Inputs>
12   <Filters>
13     <Filter Type="Miner.Responder.ArchiveExplorer.Filters.IncidentDateRangeFilter,Miner.Responder.ArchiveExplorer"/>
14     <Filter Type="Miner.Responder.ArchiveExplorer.Filters.ClosedIncidentsFilter,Miner.Responder.ArchiveExplorer"/>
15   </Filters>
16   <Request Type="Miner.Responder.Shared.Requests.FindIncidentArchiveRequest,Miner.Responder.Shared"/>
17   <Transformations Key="">
18     <b:RuleClass Key="" Type="Miner.Responder.Processors.SubmitRules.Archive.IncidentArchiveDurationTransformation,Miner.Responder.Processors"/>
19   </Transformations>
20   <XMLExporter Type="Miner.Data.Configuration.XMLHierarchicalExporter,Miner.Data.Configuration"/>
21   <XMLTransformation Type="Miner.Data.Configuration.XMLTransformation,Miner.Data.Configuration"/>
22 </QueryClass>

  1. The line numbers below correspond with the XML snippet above.

  2. Line 1: Create a unique key for your report and type a value for the Caption attribute. The Caption value is displayed on the Reports tab in Archive Explorer or in the Generate Reports tool in Responder Explorer. The Category value determines the output of the report, either Browser or Excel.
    Making changes to any Archive Explorer report that has a QueryClass Category="Browser" modifies that same report in Responder Web.

  3. Lines 4-7: Type the properties required by the input control. In the example above, the Incidents by Date Range report prompts the user for a Minimum Outage Time and a Maximum Outage Time. The Description property provides the descriptive string that appears above the input controls. The XSLPath points to the style sheet that formats your report. You may have any number of properties, depending on the report.

    Note: The XSLT files for the existing reports are installed here by default: C:\Documents and Settings\All Users\Application Data\Miner and Miner\Responder. You may create your own custom XSLT style sheet.

    Figure 2, User input control for Incidents by Date Range query

  4. Line 10: The Input section points to the control in which the user provides the input data. If more than one input control is specified, the controls are stacked vertically in the dialog (see Figure 2). Available input controls reside in Miner.Data.Decoration. You may elect to create your own input control by implementing Miner.Data.Decoration.IUserInput.
  5. Lines 13-14: The Filter section uses the Properties to build a WHERE clause. When multiple properties are specified, they are connected using only AND statements (not OR). Data must meet all criteria to be included in the query. Available filters reside in the Miner.Responder.ArchiveExplorer.Filters namespace. You may also elect to create your own custom filter by deriving from Miner.Data.Decoration.FilterBase. 
  6. Line 16: The Request section determines which request object is used. Request objects reside in the Miner.Responder.Shared.Requests namespace. You may also elect to create your own custom request object by deriving from RequestDataSetMixin and implementing IFilterDataRequest.
  7. Line 18: The Transformations section allows you to assign a transformation object that takes the retrieved dataset and modifies it. For example, the IncidentArchiveDurationTransformation class adds the duration value for each incident. If multiple transformations are specified, they are applied to the dataset one after another. Available transformation objects reside in the Miner.Responder.Processors.SubmitRules.Archive namespace. You may also elect to create your own custom transformation object. Custom transformation objects must derive from Miner.Data.Access.DataSetRule. 
  8. Line 20: The XMLExporter object takes a transformed dataset and forms XML. In the example, the XMLHierarchicalExporter class formats the XML in a hierarchical fashion. This means that children of the incident (e.g., devices, location features, etc.) are displayed as children of the incident. If you wish to create a custom XMLExporter object, it must derive from Miner.Data.Configuration.XMLExporter.
  9. Line 21: The XMLTransformation object takes the exported XML and applies the XSLT style sheet designated in the Properties XSL Path and returns an HTML document. The XMLTransformation object resides in the Miner.Data.Configuration namespace. If you wish to create a custom XMLTransformation object, it must derive from Miner.Data.Configuration.XMLTransformation.

Customize Custom Reports

New functionality is available, included with the release of Responder version 10.8.1a, to create, save, and run custom created reports within the Archive Explorer User Interface. This can be done without manipulating code. The Responder Using Guide contains information about how users generate reports in Archive Explorer. This section is intended to show how the code can be additionally manipulated to further customize these reports outside of the Archive Explorer User Interface.

Below are four examples that are intended to help you customize your reports: The first two examples pertain to Custom Incident Reports and the last two pertain to Custom Reliability Reports.

Upon a new Responder installation, the XML snippets below are already included. If you run Xupdate, the snippets are automatically added. These snippets need added only if they have for some reason been removed.

Example 1: Custom Incident Report - Browser

  1. Open the ArchiveQueriesConfig.xml file.
  2. In the QueryClass Key="CustomIncidentReport" section, add a ColumnSet and a QuerySet similar to the ones in lines 38-67:
    XML Snippet
    Copy Code 
      1 <QueryClass Key="CustomIncidentReport" Caption="Custom Incident Report" Category="Browser" >
  2   <Properties>
  3     <b:Property Key="Description" Value="Custom Incident Report."/>
  4     <b:Property Key="TimePeriod" Value="MTD" />
  5     <b:Property Key="XSLPath" Value="%ALLUSERSPROFILE%\Application Data\Miner and Miner\Responder\IncidentsCustom.xslt" />
  6     <b:Property Key="CanEdit" Value="true"/>
  7     <b:Property Key="CanSave" Value="true"/>
  8     <b:Property Key="ReportType" Value="Incident"/>
  9     <b:Property Key="IncidentCauseCodesToExclude" Value="6,10" />
 10   <//Properties>
 11   <Inputs>
 12     <Input Key="DateRangeFilter" Type="Miner.Responder.Shared.IIncidentDateRangeInput,Miner.Responder.Shared" />
 13     <Input Key="FeederID" Type="Miner.Responder.Shared.IIncidentFeederInput,Miner.Responder.Shared" />
 14     <Input Key="FacilityID" Type="Miner.Responder.Shared.IDeviceFacIdInput,Miner.Responder.Shared" />
 15     <Input Key="CustomerFilter" Type="Miner.Responder.Shared.ICustomerInput,Miner.Responder.Shared"/>
 16     <Input Key="DurationFilter" Type="Miner.Responder.Shared.IIncidentDurationInput,Miner.Responder.Shared" />
 17     <Input Key="DeviceType" Type="Miner.Responder.Shared.IDeviceTypeInput,Miner.Responder.Shared" />
 18     <Input Key="DeviceOID" Type="Miner.Responder.Shared.IDeviceOidInput,Miner.Responder.Shared" />
 19     <Input Key="CauseCodeFilter" Type="Miner.Responder.Shared.ICauseCodeInput,Miner.Responder.Shared"/>
 20     <Input Key="TimeRangeFilter" Type="Miner.Responder.Shared.IIncidentTimeRangeInput,Miner.Responder.Shared" />
 21   </Inputs>
 22   <Filters>
 23     <Filter Key="DateRangeFilter" Type="Miner.Responder.Shared.Filters.IncidentDateRangeFilter,Miner.Responder.Shared" />
 24     <Filter Key="FeederID" Type="Miner.Responder.Shared.Filters.IncidentFeederFilter,Miner.Responder.Shared" />
 25     <Filter Key="DurationFilter" Type="Miner.Responder.Shared.Filters.IncidentDurationFilter,Miner.Responder.Shared" />
 26     <Filter Key="DeviceType" Type="Miner.Responder.Shared.Filters.DeviceTypeFilter,Miner.Responder.Shared" />
 27     <Filter Key="CustomerFilter" Type="Miner.Responder.Shared.Filters.CustomerFilter,Miner.Responder.Shared" />
 28     <Filter Type="Miner.Responder.Shared.Filters.ClosedIncidentsFilter,Miner.Responder.Shared" />
 29     <Filter Key="TimeRangeFilter" Type="Miner.Responder.Shared.Filters.IncidentTimeRangeFilter,Miner.Responder.Shared" />
 30   </Filters>
 31   <Request Type="Miner.Responder.Shared.Requests.FindCustomIncidentAndDeviceArchiveRequest,Miner.Responder.Shared" />
 32   <Transformations Key="">
 33     <b:RuleClass Key="" Type="Miner.Responder.Processors.SubmitRules.Archive.CustomIncidentArchiveDurationTransformation,Miner.Responder.Processors" />
 34   </Transformations>
 35   <XMLExporter Type="Miner.Data.Configuration.XMLHierarchicalExporter,Miner.Data.Configuration" />
 36   <XMLTransformation Type="Miner.Data.Configuration.CustomXMLTransformation,Miner.Data.Configuration" />
 37   <Presentation Type="Miner.HTMLPresentation,Miner.SystemUI, Version=10.8.0.0, Culture=neutral, PublicKeyToken=196beceb052ed5dc" />
 38   <ColumnSets>
 39     <rp:ColumnSet Key="IncidentID" Description="Incident ID" ColumnName="INCIDENT_ID"/>
 40     <rp:ColumnSet Key="TimeOutage" Description="Time Outage" ColumnName="TIME_OUTAGE"/>
 41     <rp:ColumnSet Key="TimeRestored" Description="Time Restored" ColumnName="TIME_RESTORED"/>
 42     <rp:ColumnSet Key="Duration" Description="Duration" ColumnName="DURATION_TIME"/>
 43     <rp:ColumnSet Key="FacilityID" Description="Facility ID(s)" ColumnName="FACILITY_ID_SORTABLE"/>
 44     <rp:ColumnSet Key="FeederID" Description="Feeder ID" ColumnName="FEEDER_ID_SORTABLE"/>
 45     <rp:ColumnSet Key="DispatchRemarks" Description="Dispatch Remarks" ColumnName="REMARKS_DISPATCH"/>
 46     <rp:ColumnSet Key="FieldRemarks" Description="Field Remarks" ColumnName="REMARKS_FIELD"/>
 47     <rp:ColumnSet Key="DeviceName" Description="Device Name(s)" ColumnName="DEVICE_NAME" />
 48     <rp:ColumnSet Key="Customers" Description="Customers" ColumnName="CUSTOMER_COUNT"/>
 49     <rp:ColumnSet Key="Cause" Description="Cause" ColumnName="CAUSE_NAME"/>
 50     <rp:ColumnSet Key="DeviceOID" Description="Device OID(s)" ColumnName="DEVICE_OID"/>
 51     <rp:ColumnSet Key="Address" Description="Address" ColumnName="ADDRESS_SORTABLE"/>
 52     <rp:ColumnSet Key="CrewName" Description="Crew Name" ColumnName="CREW_NAME"/>
 53     <rp:ColumnSet Key="CrewAssignmentTime" Description="Crew Assignment Time" ColumnName="CREW_ASSIGNMENT_TIME"/>
 54     <rp:ColumnSet Key="CrewWorkingTime" Description="Crew Working Time" ColumnName="CREW_WORKING_TIME"/>
 55     <rp:ColumnSet Key="CrewResponseTime" Description="Crew Response Time" ColumnName="CREW_RESPONSE_TIME_SORTABLE"/>
 56   </ColumnSets>
 57   <QuerySets>
 58     <rp:QuerySet Key="DateRangeFilter" Description="Date Range"/>
 59     <rp:QuerySet Key="FeederID" Description="Feeder ID"/>
 60     <rp:QuerySet Key="FacilityID" Description="Facility ID"/>
 61     <rp:QuerySet Key="CustomerFilter" Description="Customer"/>
 62     <rp:QuerySet Key="DurationFilter" Description="Duration"/>
 63     <rp:QuerySet Key="DeviceType" Description="Device Type"/>
 64     <rp:QuerySet Key="DeviceOID" Description="Device OID"/>
 65     <rp:QuerySet Key="CauseCodeFilter" Description="Exclude Cause Codes"/>
 66     <rp:QuerySet Key="TimeRangeFilter" Description="Time Range"/>
 67   <QuerySets>
 68 <QueryClass>
  3. Edit IncidentsCustom.xslt (found in C:\ProgramData\Miner and Miner\Responder) and add the corresponding ColumnSet and QuerySet.

Example: Custom Incident Report - Excel

  1. Open the ArchiveQueriesConfig.xml file.
  2. In the QueryClass Key="CustomIncidentReport" section, add a ColumnSet and a QuerySet similar to the ones in lines 106-135:
    XML Snippet
    Copy Code 
     69 <QueryClass Key="CustomIncidentReport" Caption="Custom Incident Report" Category="Excel">
 70   <Properties>
 71     <b:Property Key="Description" Value="Custom Incident Report" />
 72     <b:Property Key="TimePeriod" Value="MTD" />
 73     <b:Property Key="XSLPath" Value="%ALLUSERSPROFILE%\Application Data\Miner and Miner\Responder\IncidentsCustomExcel.xslt" />
 74     <b:Property Key="CanEdit" Value="true"/>
 75     <b:Property Key="CanSave" Value="true"/>
 76     <b:Property Key="ReportType" Value="Incident"/>
 77     <b:Property Key="IncidentCauseCodesToExclude" Value="6,10" />
 78   </Properties>
 79   <Inputs>
 80     <Input Key="DateRangeFilter" Type="Miner.Responder.Shared.IIncidentDateRangeInput,Miner.Responder.Shared" />
 81     <Input Key="FeederID" Type="Miner.Responder.Shared.IIncidentFeederInput,Miner.Responder.Shared" />
 82     <Input Key="FacilityID" Type="Miner.Responder.Shared.IDeviceFacIdInput,Miner.Responder.Shared" />
 83     <Input Key="CustomerFilter" Type="Miner.Responder.Shared.ICustomerInput,Miner.Responder.Shared"/>
 84     <Input Key="DurationFilter" Type="Miner.Responder.Shared.IIncidentDurationInput,Miner.Responder.Shared" />
 85     <Input Key="DeviceType" Type="Miner.Responder.Shared.IDeviceTypeInput,Miner.Responder.Shared" />
 86     <Input Key="DeviceOID" Type="Miner.Responder.Shared.IDeviceOidInput,Miner.Responder.Shared" />
 87     <Input Key="CauseCodeFilter" Type="Miner.Responder.Shared.ICauseCodeInput,Miner.Responder.Shared"/>
 88     <Input Key="TimeRangeFilter" Type="Miner.Responder.Shared.IIncidentTimeRangeInput,Miner.Responder.Shared" />
 89   </Inputs>
 90   <Filters>
 91     <Filter Key="DateRangeFilter" Type="Miner.Responder.Shared.Filters.IncidentDateRangeFilter,Miner.Responder.Shared" />
 92     <Filter Key="FeederID" Type="Miner.Responder.Shared.Filters.IncidentFeederFilter,Miner.Responder.Shared" />
 93     <Filter Key="DurationFilter" Type="Miner.Responder.Shared.Filters.IncidentDurationFilter,Miner.Responder.Shared" />
 94     <Filter Key="DeviceType" Type="Miner.Responder.Shared.Filters.DeviceTypeFilter,Miner.Responder.Shared" />
 95     <Filter Key="CustomerFilter" Type="Miner.Responder.Shared.Filters.CustomerFilter,Miner.Responder.Shared" />
 96     <Filter Type="Miner.Responder.Shared.Filters.ClosedIncidentsFilter,Miner.Responder.Shared" />
 97     <Filter Key="TimeRangeFilter" Type="Miner.Responder.Shared.Filters.IncidentTimeRangeFilter,Miner.Responder.Shared" />
 98   </Filters>
 99   <Request Type="Miner.Responder.Shared.Requests.FindCustomIncidentAndDeviceArchiveRequest,Miner.Responder.Shared" />
100   <Transformations Key="">
101     <b:RuleClass Key="" Type="Miner.Responder.Processors.SubmitRules.Archive.CustomIncidentArchiveDurationTransformation,Miner.Responder.Processors" />
102   </Transformations>
103   <XMLExporter Type="Miner.Data.Configuration.XMLHierarchicalExporter,Miner.Data.Configuration" />
104   <XMLTransformation Type="Miner.Data.Configuration.CustomXMLTransformation,Miner.Data.Configuration" />
105   <Presentation Type="Miner.ExcelPresentation,Miner.SystemUI, Version=10.8.0.0, Culture=neutral, PublicKeyToken=196beceb052ed5dc" />
106   <ColumnSets>
107     <rp:ColumnSet Key="IncidentID" Description="Incident ID" ColumnName="INCIDENT_ID"/>
108     <rp:ColumnSet Key="TimeOutage" Description="Time Outage" ColumnName="TIME_OUTAGE"/>
109     <rp:ColumnSet Key="TimeRestored" Description="Time Restored" ColumnName="TIME_RESTORED"/>
110     <rp:ColumnSet Key="Duration" Description="Duration" ColumnName="DURATION_TIME"/>
111     <rp:ColumnSet Key="FacilityID" Description="Facility ID(s)" ColumnName="FACILITY_ID_SORTABLE"/>
112     <rp:ColumnSet Key="FeederID" Description="Feeder ID" ColumnName="FEEDER_ID_SORTABLE"/>
113     <rp:ColumnSet Key="DispatchRemarks" Description="Dispatch Remarks" ColumnName="REMARKS_DISPATCH"/>
114     <rp:ColumnSet Key="FieldRemarks" Description="Field Remarks" ColumnName="REMARKS_FIELD"/>
115     <rp:ColumnSet Key="DeviceName" Description="Device Name(s)" ColumnName="DEVICE_NAME" />
116     <rp:ColumnSet Key="Customers" Description="Customers" ColumnName="CUSTOMER_COUNT"/>
117     <rp:ColumnSet Key="Cause" Description="Cause" ColumnName="CAUSE_NAME"/>
118     <rp:ColumnSet Key="DeviceOID" Description="Device OID(s)" ColumnName="DEVICE_OID"/>
119     <rp:ColumnSet Key="Address" Description="Address" ColumnName="ADDRESS_SORTABLE"/>
120     <rp:ColumnSet Key="CrewName" Description="Crew Name" ColumnName="CREW_NAME"/>
121     <rp:ColumnSet Key="CrewAssignmentTime" Description="Crew Assignment Time" ColumnName="CREW_ASSIGNMENT_TIME"/>
122     <rp:ColumnSet Key="CrewWorkingTime" Description="Crew Working Time" ColumnName="CREW_WORKING_TIME"/>
123     <rp:ColumnSet Key="CrewResponseTime" Description="Crew Response Time" ColumnName="CREW_RESPONSE_TIME_SORTABLE"/>
124   </ColumnSets>
125   <QuerySets>
126     <rp:QuerySet Key="DateRangeFilter" Description="Date Range"/>
127     <rp:QuerySet Key="FeederID" Description="Feeder ID"/>
128     <rp:QuerySet Key="FacilityID" Description="Facility ID"/>
129     <rp:QuerySet Key="CustomerFilter" Description="Customer"/>
130     <rp:QuerySet Key="DurationFilter" Description="Duration"/>
131     <rp:QuerySet Key="DeviceType" Description="Device Type"/>
132     <rp:QuerySet Key="DeviceOID" Description="Device OID"/>
133     <rp:QuerySet Key="CauseCodeFilter" Description="Exclude Cause Codes"/>
134     <rp:QuerySet Key="TimeRangeFilter" Description="Time Range"/>
135   </QuerySets>
136 </QueryClass
  3. Edit IncidentsCustom.xslt (found in C:\ProgramData\Miner and Miner\Responder) and add the corresponding ColumnSet and QuerySet.

Example: Custom Reliability Index Report - Browser

  1. Open the ArchiveQueriesConfig.xml file.
  2. In the QueryClass Key="CustomReliability" section, add a ColumnSet and a QuerySet similar to the ones in lines 167-189:
    XML Snippet
    Copy Code 
    137 <QueryClass Key="CustomReliability" Caption="Custom Reliability Index Report" Category="Browser">
138   <Properties>
139     <b:Property Key="Description" Value="Custom Reliability Index Report" />
140     <b:Property Key="TimePeriod" Value="MTD" />
141     <b:Property Key="Interval" Value="ByDay" />
142     <b:Property Key="Tmi" Value="5" />
143     <b:Property Key="IncidentCauseCodesToExclude" Value="6,10" />
144     <b:Property Key="IncludeMajorEventDays" Value="false" />
145     <b:Property Key="FeederID" Value="" />
146     <b:Property Key="CauseCode" Value=""/>
147     <b:Property Key="CanEdit" Value="true"/>
148     <b:Property Key="CanSave" Value="true"/>
149     <b:Property Key="ReportType" Value="Reliability"/>
150     <b:Property Key="XSLPath" Value="%ALLUSERSPROFILE%\Application Data\Miner and Miner\Responder\ReliabilityCustom.xslt" />
151   </Properties>
152   <Inputs>
153     <Input Key="DateRangeFilter" Type="Miner.Responder.Shared.IIncidentDateRangeInput,Miner.Responder.Shared" />
154     <Input Key="ResultTypeFilter" Type="Miner.Responder.Shared.IResultTypeFilterInput,Miner.Responder.Shared" />
155     <Input Key="IncludeMedInput" Type="Miner.Responder.Shared.IIncludeMedInput,Miner.Responder.Shared" />
156     <Input Key="CauseCodeFilter" Type="Miner.Responder.Shared.ICauseCodeInput,Miner.Responder.Shared"/>
157   </Inputs>
158   <Filters>
159     <Filter Key="DateRangeFilter" Type="Miner.Responder.Shared.Filters.IncidentDateRangeFilter,Miner.Responder.Shared" />
160   </Filters>
161   <Transformations Key="">
162     <b:RuleClass Key="" Type="Miner.Responder.Processors.SubmitRules.Archive.ReliabilityTransformation,Miner.Responder.Processors" />
163   </Transformations>
164   <XMLExporter Type="Miner.Data.Configuration.XMLExporterWithLtGtDecoding,Miner.Data.Configuration" />
165   <XMLTransformation Type="Miner.Data.Configuration.CustomXMLTransformation,Miner.Data.Configuration" />
166   <Presentation Type="Miner.HTMLPresentation,Miner.SystemUI, Version=10.8.0.0, Culture=neutral, PublicKeyToken=196beceb052ed5dc" />
167   <ColumnSets>
168     <rp:ColumnSet Key="Date" Description="Date"/>
169     <rp:ColumnSet Key="ClosestDate" Description="Customer Count Date"/>
170     <rp:ColumnSet Key="CustomerCount" Description="Customer Count"/>
171     <rp:ColumnSet Key="Feeder" Description="Feeder"/>
172     <rp:ColumnSet Key="CauseCode" Description="Cause Code"/>
173     <rp:ColumnSet Key="CustomerInterruptions" Description="Customer Interruptions"/>
174     <rp:ColumnSet Key="CustomersInterrupted" Description="Customers Interrupted"/>
175     <rp:ColumnSet Key="TotalInterruptionMinutes" Description="Total Interruption Minutes"/>
176     <rp:ColumnSet Key="Saifi" Description="SAIFI"/>
177     <rp:ColumnSet Key="Saidi" Description="SAIDI"/>
178     <rp:ColumnSet Key="Caifi" Description="CAIFI"/>
179     <rp:ColumnSet Key="Caidi" Description="CAIDI"/>
180     <rp:ColumnSet Key="Maifi" Description="MAIFI"/>
181     <rp:ColumnSet Key="Asai" Description="ASAI"/>
182     <rp:ColumnSet Key="Lbar" Description="L-BAR"/>
183   </ColumnSets>
184   <QuerySets>
185     <rp:QuerySet Key="DateRangeFilter" Description="Date Range"/>
186     <rp:QuerySet Key="ResultTypeFilter" Description="Result Type"/>
187     <rp:QuerySet Key="IncludeMedInput" Description="Include MED"/>
188     <rp:QuerySet Key="CauseCodeFilter" Description="Exclude Cause Codes"/>
189   </QuerySets>
190 </QueryClass>
  3. Edit ReliabilityCustom.xslt (found in C:\ProgramData\Miner and Miner\Responder) and add the corresponding ColumnSet and QuerySet.

Example: Custom Reliability Index Report - Excel

  1. Open the ArchiveQueriesConfig.xml file.
  2. In the QueryClass Key="CustomReliability" section, add a ColumnSet and a QuerySet similar to the ones in lines 221-243:
    XML Snippet
    Copy Code 
    191 <QueryClass Key="CustomReliability" Caption="Custom Reliability Index Report" Category="Excel">
192   <Properties>
193     <b:Property Key="Description" Value="Custom Reliability Index Report" />
194     <b:Property Key="TimePeriod" Value="MTD" />
195     <b:Property Key="Interval" Value="ByDay" />
196     <b:Property Key="Tmi" Value="5" />
197     <b:Property Key="IncidentCauseCodesToExclude" Value="6,10" />
198     <b:Property Key="IncludeMajorEventDays" Value="false" />
199     <b:Property Key="FeederID" Value="" />
200     <b:Property Key="CauseCode" Value=""/>
201     <b:Property Key="CanEdit" Value="true"/>
202     <b:Property Key="CanSave" Value="true"/>
203     <b:Property Key="ReportType" Value="Reliability"/>
204     <b:Property Key="XSLPath" Value="%ALLUSERSPROFILE%\Application Data\Miner and Miner\Responder\ReliabilityCustomExcel.xslt" />
205   </Properties>
206   <Inputs>
207     <Input Key="DateRangeFilter" Type="Miner.Responder.Shared.IIncidentDateRangeInput,Miner.Responder.Shared" />
208     <Input Key="ResultTypeFilter" Type="Miner.Responder.Shared.IResultTypeFilterInput,Miner.Responder.Shared" />
209     <Input Key="IncludeMedInput" Type="Miner.Responder.Shared.IIncludeMedInput,Miner.Responder.Shared" />
210     <Input Key="CauseCodeFilter" Type="Miner.Responder.Shared.ICauseCodeInput,Miner.Responder.Shared"/>
211   </Inputs>
212   <Filters>
213     <Filter Key="DateRangeFilter" Type="Miner.Responder.Shared.Filters.IncidentDateRangeFilter,Miner.Responder.Shared" />
214   </Filters>
215   <Transformations Key="">
216     <b:RuleClass Key="" Type="Miner.Responder.Processors.SubmitRules.Archive.ReliabilityTransformation,Miner.Responder.Processors" />
217   </Transformations>
218   <XMLExporter Type="Miner.Data.Configuration.XMLExporterWithLtGtDecoding,Miner.Data.Configuration" />
219   <XMLTransformation Type="Miner.Data.Configuration.CustomXMLTransformation,Miner.Data.Configuration" />
220   <Presentation Type="Miner.ExcelPresentation,Miner.SystemUI, Version=10.8.0.0, Culture=neutral, PublicKeyToken=196beceb052ed5dc" />
221   <ColumnSets>
222     <rp:ColumnSet Key="Date" Description="Date"/>
223     <rp:ColumnSet Key="ClosestDate" Description="Customer Count Date"/>
224     <rp:ColumnSet Key="CustomerCount" Description="Customer Count"/>
225     <rp:ColumnSet Key="Feeder" Description="Feeder"/>
226     <rp:ColumnSet Key="CauseCode" Description="Cause Code"/>
227     <rp:ColumnSet Key="CustomerInterruptions" Description="Customer Interruptions"/>
228     <rp:ColumnSet Key="CustomersInterrupted" Description="Customers Interrupted"/>
229     <rp:ColumnSet Key="TotalInterruptionMinutes" Description="Total Interruption Minutes"/>
230     <rp:ColumnSet Key="Saifi" Description="SAIFI"/>
231     <rp:ColumnSet Key="Saidi" Description="SAIDI"/>
232     <rp:ColumnSet Key="Caifi" Description="CAIFI"/>
233     <rp:ColumnSet Key="Caidi" Description="CAIDI"/>
234     <rp:ColumnSet Key="Maifi" Description="MAIFI"/>
235     <rp:ColumnSet Key="Asai" Description="ASAI"/>
236     <rp:ColumnSet Key="Lbar" Description="L-BAR"/>
237   </ColumnSets>
238   <QuerySets>
239     <rp:QuerySet Key="DateRangeFilter" Description="Date Range"/>
240     <rp:QuerySet Key="ResultTypeFilter" Description="Result Type"/>
241     <rp:QuerySet Key="IncludeMedInput" Description="Include MED"/>
242     <rp:QuerySet Key="CauseCodeFilter" Description="Exclude Cause Codes"/>
243    </QuerySets>
244  </QueryClass>
  3. Edit ReliabilityCustom.xslt (found in C:\ProgramData\Miner and Miner\Responder) and add the corresponding ColumnSet and QuerySet.

 

 

Send Comment to ArcFMdocumentation@schneider-electric.com