Indexing
The index types are the list of different items which are indexed whenever a file is saved. When calling services the index type must be specified since object names are not guaranteed to be unique across index types.
Index Type | Available | Description |
credential |
| Credential alias uses in Transactions |
connection |
| Connection alias uses in Transactions |
dataserver |
| Data server uses in Query Templates |
file |
| Transaction, Template and Manufacturing Data Object uses |
The indexing service includes method for examine what is indexed as well as providing an interface to kick off and monitor an indexer. The indexer rebuilds the index information. It will run through all files in the database and re-index them. This should only be used if somehow the indexes get out of sync.
Missing
You use this mode to retrieve a list of index objects for which the object itself does not exist. For example for a data server it will retrieve a list of the data servers which are used in a query template, but that do not exist.
Request parameters
Parameter | Optional | Description |
Type | No | The index type |
Response
Name | Description |
Name | A missing object name |
Example
Request
Response
<?xml version="1.0" encoding="UTF-8" ?>
<Rowsets DateCreated="2011-11-14T11:59:01" EndDate="2011-11-14T11:59:01" StartDate="2011-11-14T10:59:01" Version="12.1.10 Build(13)">
<Rowset>
<Columns>
<ColumnDescription="Name" MaxRange="1" MinRange="0" Name="Name" SQLDataType="12" SourceColumn="Name" />
</Columns>
<Row>
<Name>ActivePortal</Name>
</Row>
<Row>
<Name>AlarmSuite</Name>
</Row>
<Row>
<Name>ISS_Tag</Name>
</Row>
<Row>
<Name>InTrack</Name>
</Row>
<Row>
<Name>MIT_PIUDS</Name>
</Row>
<Row>
<Name>MIT_ProcessHistorian</Name>
</Row>
<Row>
<Name>MIT_xMIIDemo</Name>
</Row>
<Row>
<Name>MSOLAP</Name>
</Row>
<Row>
<Name>OLAP</Name>
</Row>
<Row>
<Name>QualityPortal</Name>
</Row>
</Rowset>
</Rowsets>
ModeList
You use this mode to retrieve a list with the modes that indexing service supports.
Request parameters
It does not require any additional request parameters.
Response
Name | Description |
ModeName | The mode name |
Example
Request
http://localhost:50000/XMII/Illuminator?service=Indexing&Mode=modelist&content-type=text/xml
Response
<?xml version="1.0" encoding="UTF-8" ?>
<Rowsets DateCreated="2011-11-14T11:44:37" EndDate="2011-11-14T11:44:37" StartDate="2011-11-14T10:44:37" Version="12.1.10 Build(13)">
<Rowset>
<Columns>
<ColumnDescription="ModeName" MaxRange="1" MinRange="0" Name="ModeName" SQLDataType="1" SourceColumn="ModeName" />
</Columns>
<Row>
<ModeName>Missing</ModeName>
</Row>
……
<Row>
<ModeName>Usage</ModeName>
</Row>
</Rowset>
</Rowsets>
Reindex
You use this mode to delete all existing indexing information and re-index the system. In order to be able to run this service the user has to have a permission to run the indexing service. The action name is XMII_Indexer and the roles that have this action assigned by default are SAP_XMII_Super_Administrator and SAP_XMII_Administrator.
Request parameters
Thismode does not require any additional request parameters.
Response
The response is Successful or Error message.
Example
Request
http://localhost:50000/XMII/Illuminator?service=Indexing&Mode=reindex&content-type=text/xml
Response
<?xml version="1.0" encoding="UTF-8" ?>
<Rowsets DateCreated="2011-11-14T12:59:54" EndDate="2011-11-14T12:59:54" StartDate="2011-11-14T11:59:54" Version="12.1.10 Build(13)">
<Messages>
<Message>Successful</Message>
</Messages>
</Rowsets>
Start
You use this mode to start the indexing service if not already started. In order to be able to run this service the user has to have a permission to run the indexing service. The action name is XMII_Indexer and the roles that have this action assigned by default are SAP_XMII_Super_Administrator and SAP_XMII_Administrator.
Request parameters
Thismode does not require any additional request parameters.
Response
The response is Successful or Error message.
Example
Request
http://localhost:50000/XMII/Illuminator?service=Indexing&Mode=start&content-type=text/xml
Response
<?xml version="1.0" encoding="UTF-8" ?>
<Rowsets DateCreated="2011-11-14T13:03:19" EndDate="2011-11-14T13:03:19" StartDate="2011-11-14T12:03:19" Version="12.1.10 Build(13)">
<Messages>
<Message>Successful</Message>
</Messages>
</Rowsets>
Status
You use this mode to view the status of the indexer and a list of the files that were indexed. This mode like Reindex and Start requires addition permissions to be run. . The action name is XMII_Indexer and the roles that have this action assigned by default are SAP_XMII_Super_Administrator and SAP_XMII_Administrator.
Request parameters
Thismode does not require any additional request parameters.
Response
Name | Description |
Name | The indexed file name |
Example
Request
http://localhost:50000/XMII/Illuminator?service=Indexing&Mode=status&content-type=text/xml
Response
<?xml version="1.0" encoding="UTF-8" ?>
<Rowsets DateCreated="2011-11-14T13:03:00" EndDate="2011-11-14T13:03:00" StartDate="2011-11-14T12:03:00" Version="12.1.10 Build(13)">
<Rowset>
<Columns>
<ColumnDescription="Name" MaxRange="1" MinRange="0" Name="Name" SQLDataType="12" SourceColumn="Name" />
</Columns>
<Row>
<Name>Indexed file Predefined/AuditServiceVerify.tqte</Name>
</Row>
<Row>
<Name>Indexed file Predefined/AuditServiceWriter.tqte</Name>
</Row>
<Row>
<Name>Indexed file Predefined/DefaultAlarmStatisticsFrequencyChart.tdch</Name>
</Row>
………
</Rowset>
<Messages>
<Message>Indexer is running</Message>
<Message>Processed 1641 of 3674 files</Message>
</Messages>
</Rowsets>
Usage
You use this mode to display the files which use a specific data server, connection or credential alias. It can be used to find where a missing indexed object is used.
Request parameters
Parameter | Optional | Description |
Type | No | The index type |
Name | No | The name of the data server, credential or connection |
Response
Name | Description |
Name | The absolute path name |
Example
Request
Response
<?xml version="1.0" encoding="UTF-8" ?>
<Rowsets DateCreated="2011-11-14T13:17:20" EndDate="2011-11-14T13:17:20" StartDate="2011-11-14T12:17:20" Version="12.1.10 Build(13)">
<Rowset>
<Columns>
<ColumnDescription="Name" MaxRange="1" MinRange="0" Name="Name" SQLDataType="12" SourceColumn="Name" />
</Columns>
<Row>
<Name>MII 12.0 Unit Tests/ChartRegression/SpecificTests/Batch SPC/BatchSPCQuery.tqsq</Name>
</Row>
</Rowset>
</Rowsets>
Monitoring
You use this service for retrieving statistics information for logins, file usage, server usage, etc. It can be used to determine what type of load is on a system, what is being run and how often.
Monitoring data is automatically cleaned up every 30 days. You configure the retention period it through the System Administration Screen by setting a different value to MonitoringRetentionDuration.
DataServers
You use this mode to view the usage summary of a specific Data Server or all available Data Server. The usage statistic is provided per day. If you request the statistic information for all servers you can use all date parameters (such as StartData, EndDate and Duration) to specify the exact time frame for the usage report. If you request usage summary for a specific Data Server you will get the summary of its usage for the configured monitoring retention period.
Request parameters
Parameter | Optional | Description |
Server | yes | The Data Server which usage statistic you want to retrieve. If no server is provided then the statistic of all available Data Servers will be retrieved. |
StartDate | yes | The start date for the Data Servers usage. DataServer usage before that date will not be included in the result set. The format is MM/dd/yyyy HH:mm:ss. The default value, which is used when this parameter is not provided, is EndDate – Duration It is used only when no server parameter is provided. |
EndDate | yes | The end date for the Data Servers usage. DataServer usage after that date will not be included in the result set. The format is MM/dd/yyyy HH:mm:ss. The default value is:
It is used only when no server parameter is provided. |
Duration | yes | The duration of the time frame in minutes. The default duration is 60 minutes. It is used only when no server parameter is provided. |
Response
Name | Description |
RecordedDate | The date when the statistic record was created |
ServerName | The data server name |
NumberHits | The number of times when the data server was used on that date |
RowsReturned | The number of returned rows |
TimeToRun | The time used to retrieve these rows |
ErrorCount | The number of errors that occurred when the data server was used |
CommErrorCount | The number of communication errors. |
Example: Retrieve the all available usage statistic from the latest 30000 minutes.
Request
Response
<?xml version="1.0" encoding="UTF-8" ?>
<Rowsets DateCreated="2011-12-06T14:55:59" EndDate="2011-12-06T14:55:59" StartDate="2011-11-15T18:55:59" Version="12.1.10 Build(15)">
<Rowset>
<Columns>
<ColumnDescription="RecordedDate" MaxRange="1" MinRange="0" Name="RecordedDate" SQLDataType="93" SourceColumn="RecordedDate" />
<ColumnDescription="ServerName" MaxRange="1" MinRange="0" Name="ServerName" SQLDataType="1" SourceColumn="ServerName" />
<ColumnDescription="NumberHits" MaxRange="1" MinRange="0" Name="NumberHits" SQLDataType="-5" SourceColumn="NumberHits" />
<ColumnDescription="RowsReturned" MaxRange="1" MinRange="0" Name="RowsReturned" SQLDataType="-5" SourceColumn="RowsReturned" />
<ColumnDescription="TimeToRun" MaxRange="1" MinRange="0" Name="TimeToRun" SQLDataType="-5" SourceColumn="TimeToRun" />
<ColumnDescription="ErrorCount" MaxRange="1" MinRange="0" Name="ErrorCount" SQLDataType="-5" SourceColumn="ErrorCount" />
<ColumnDescription="CommErrorCount" MaxRange="1" MinRange="0" Name="CommErrorCount" SQLDataType="-5" SourceColumn="CommErrorCount" />
</Columns>
<Row>
<RecordedDate>2011-12-06T00:00:00</RecordedDate>
<ServerName>Simulator</ServerName>
<NumberHits>4</NumberHits>
<RowsReturned>136</RowsReturned>
<TimeToRun>1296</TimeToRun>
<ErrorCount>0</ErrorCount>
<CommErrorCount>0</CommErrorCount>
</Row>
<Row>
<RecordedDate>2011-12-06T00:00:00</RecordedDate>
<ServerName>xMIIDemo</ServerName>
<NumberHits>7</NumberHits>
<RowsReturned>21</RowsReturned>
<TimeToRun>76</TimeToRun>
<ErrorCount>4</ErrorCount>
<CommErrorCount>0</CommErrorCount>
</Row>
<Row>
<RecordedDate>2011-12-01T00:00:00</RecordedDate>
<ServerName>XacuteConnector</ServerName>
<NumberHits>3</NumberHits>
<RowsReturned>19</RowsReturned>
<TimeToRun>275</TimeToRun>
<ErrorCount>0</ErrorCount>
<CommErrorCount>0</CommErrorCount>
</Row>
<Row>
<RecordedDate>2011-11-29T00:00:00</RecordedDate>
<ServerName>XacuteConnector</ServerName>
<NumberHits>16</NumberHits>
<RowsReturned>62</RowsReturned>
<TimeToRun>466</TimeToRun>
<ErrorCount>0</ErrorCount>
<CommErrorCount>0</CommErrorCount>
</Row>
<Row>
<RecordedDate>2011-11-28T00:00:00</RecordedDate>
<ServerName>XacuteConnector</ServerName>
<NumberHits>9</NumberHits>
<RowsReturned>32</RowsReturned>
<TimeToRun>586</TimeToRun>
<ErrorCount>0</ErrorCount>
<CommErrorCount>0</CommErrorCount>
</Row>
</Rowset>
</Rowsets>
Example: Retrieve the usage statistic for a specific Data Server.
Request
Response
<?xml version="1.0" encoding="UTF-8" ?>
<Rowsets DateCreated="2011-12-06T14:57:59" EndDate="2011-12-06T14:57:59" StartDate="2011-12-06T13:57:59" Version="12.1.10 Build(15)">
<Rowset>
<Columns>
<ColumnDescription="RecordedDate" MaxRange="1" MinRange="0" Name="RecordedDate" SQLDataType="93" SourceColumn="RecordedDate" />
<ColumnDescription="ServerName" MaxRange="1" MinRange="0" Name="ServerName" SQLDataType="1" SourceColumn="ServerName" />
<ColumnDescription="NumberHits" MaxRange="1" MinRange="0" Name="NumberHits" SQLDataType="-5" SourceColumn="NumberHits" />
<ColumnDescription="RowsReturned" MaxRange="1" MinRange="0" Name="RowsReturned" SQLDataType="-5" SourceColumn="RowsReturned" />
<ColumnDescription="TimeToRun" MaxRange="1" MinRange="0" Name="TimeToRun" SQLDataType="-5" SourceColumn="TimeToRun" />
<ColumnDescription="ErrorCount" MaxRange="1" MinRange="0" Name="ErrorCount" SQLDataType="-5" SourceColumn="ErrorCount" />
<ColumnDescription="CommErrorCount" MaxRange="1" MinRange="0" Name="CommErrorCount" SQLDataType="-5" SourceColumn="CommErrorCount" />
</Columns>
<Row>
<RecordedDate>2011-12-01T00:00:00</RecordedDate>
<ServerName>XacuteConnector</ServerName>
<NumberHits>3</NumberHits>
<RowsReturned>19</RowsReturned>
<TimeToRun>275</TimeToRun>
<ErrorCount>0</ErrorCount>
<CommErrorCount>0</CommErrorCount>
</Row>
<Row>
<RecordedDate>2011-11-29T00:00:00</RecordedDate>
<ServerName>XacuteConnector</ServerName>
<NumberHits>16</NumberHits>
<RowsReturned>62</RowsReturned>
<TimeToRun>466</TimeToRun>
<ErrorCount>0</ErrorCount>
<CommErrorCount>0</CommErrorCount>
</Row>
<Row>
<RecordedDate>2011-11-28T00:00:00</RecordedDate>
<ServerName>XacuteConnector</ServerName>
<NumberHits>9</NumberHits>
<RowsReturned>32</RowsReturned>
<TimeToRun>586</TimeToRun>
<ErrorCount>0</ErrorCount>
<CommErrorCount>0</CommErrorCount>
</Row>
</Rowset>
</Rowsets>
FileUsage
You use this mode to get the statistical information about the usage of a file (such as Transaction or Query). As Data Servers mode you can get all available statistics for a specific time frame and/or path, or you can get the usage statistic for a specific file. The usage statistic is provided per day. What it means is that the shortest period of time that you can get statistic for is a day. For example if you request the startistic for the last 30 hours you will receive the statistics for the last 2 or even 3 days (it depends on the time when you run the request, if it is before 6a.p. the returned result will be for the last 3 days because these 30 hours are a part of these 3 days).
Request parameters
Parameter | Optional | Description |
ID | Yes | The file id. If this parameter is specified then only the statistic information for the requested file will be retrieved. |
Path | Yes | The path. If this parameter is specified then only the statistic information for the files from the specified folder will be retrieved. This parameter takes effect only when no ID parameter is provided. |
StartDate | yes | The start date for the file usage. Any usage before that date will not be included in the result set. The format is MM/dd/yyyy HH:mm:ss. The default value, which is used when this parameter is not provided, is EndDate – Duration This parameter takes effect only when no ID parameter is provided. |
EndDate | yes | The end date for the file usage. Any usage after that date will not be included in the result set. The format is “MM/dd/yyyy HH:mm:ss”. The default value is:
This parameter takes effect only when no ID parameter is provided. |
Duration | yes | The duration of the time frame in minutes. The default duration is 60 minutes. This parameter takes effect only when no ID parameter is provided. |
Response
Name | Description |
Name | The file name |
NumberRuns | The number times it was run |
Minimum | The minimum execution time |
Maximum | The maximum execution time |
Average | The average execution time. |
Example: Get the available usage statistic from the latest’s 6000 hours.
Request
Response
<?xml version="1.0" encoding="UTF-8" ?>
<Rowsets DateCreated="2011-12-06T15:12:01" EndDate="2011-12-06T15:12:01" StartDate="2011-12-02T11:12:01" Version="12.1.10 Build(15)">
<Rowset>
<Columns>
<ColumnDescription="Name" MaxRange="1" MinRange="0" Name="Name" SQLDataType="12" SourceColumn="Name" />
<ColumnDescription="NumberRuns" MaxRange="1" MinRange="0" Name="NumberRuns" SQLDataType="-5" SourceColumn="NumberRuns" />
<ColumnDescription="Minimum" MaxRange="1" MinRange="0" Name="Minimum" SQLDataType="-5" SourceColumn="Minimum" />
<ColumnDescription="Maximum" MaxRange="1" MinRange="0" Name="Maximum" SQLDataType="-5" SourceColumn="Maximum" />
<ColumnDescription="Average" MaxRange="1" MinRange="0" Name="Average" SQLDataType="-5" SourceColumn="Average" />
</Columns>
<Row>
<Name>MII 12.0 Unit Tests/Actions/Data Queries/Aggregate/SimulatorAssetUtilQuery.tqta</Name>
<NumberRuns>2</NumberRuns>
<Minimum>65</Minimum>
<Maximum>720</Maximum>
<Average>392</Average>
</Row>
<Row>
<Name>Demo/Transaction/Demo.trx</Name>
<NumberRuns>18</NumberRuns>
<Minimum>115</Minimum>
<Maximum>2139</Maximum>
<Average>548</Average>
</Row>
<Row>
<Name>Demo/Transaction/DemoNS_short.trx</Name>
<NumberRuns>58</NumberRuns>
<Minimum>20</Minimum>
<Maximum>118946</Maximum>
<Average>4969</Average>
</Row>
<Row>
<Name>Demo/Transaction/DemoNS.trx</Name>
<NumberRuns>2</NumberRuns>
<Minimum>85</Minimum>
<Maximum>253</Maximum>
<Average>169</Average>
</Row>
<Row>
<Name>Demo/Transaction/Demo.trx</Name>
<NumberRuns>13</NumberRuns>
<Minimum>167</Minimum>
<Maximum>1448</Maximum>
<Average>451</Average>
</Row>
<Row>
<Name>Demo/Transaction/DemoNS_short.trx</Name>
<NumberRuns>11</NumberRuns>
<Minimum>77</Minimum>
<Maximum>196869</Maximum>
<Average>34860</Average>
</Row>
</Rowset>
</Rowsets>
Example: Get the available usage statistic for a specific folder for the latest’s 6000 hours.
Request
Response
<?xml version="1.0" encoding="UTF-8" ?>
<Rowsets DateCreated="2011-12-06T15:31:17" EndDate="2011-12-06T15:31:17" StartDate="2011-12-02T11:31:17" Version="12.1.10 Build(15)">
<Rowset>
<Columns>
<ColumnDescription="Name" MaxRange="1" MinRange="0" Name="Name" SQLDataType="12" SourceColumn="Name" />
<ColumnDescription="NumberRuns" MaxRange="1" MinRange="0" Name="NumberRuns" SQLDataType="-5" SourceColumn="NumberRuns" />
<ColumnDescription="Minimum" MaxRange="1" MinRange="0" Name="Minimum" SQLDataType="-5" SourceColumn="Minimum" />
<ColumnDescription="Maximum" MaxRange="1" MinRange="0" Name="Maximum" SQLDataType="-5" SourceColumn="Maximum" />
<ColumnDescription="Average" MaxRange="1" MinRange="0" Name="Average" SQLDataType="-5" SourceColumn="Average" />
</Columns>
<Row>
<Name>Demo/Transaction/Demo.trx</Name>
<NumberRuns>18</NumberRuns>
<Minimum>115</Minimum>
<Maximum>2139</Maximum>
<Average>548</Average>
</Row>
<Row>
<Name>Demo/Transaction/DemoNS_short.trx</Name>
<NumberRuns>58</NumberRuns>
<Minimum>20</Minimum>
<Maximum>118946</Maximum>
<Average>4969</Average>
</Row>
<Row>
<Name>Demo/Transaction/DemoNS.trx</Name>
<NumberRuns>2</NumberRuns>
<Minimum>85</Minimum>
<Maximum>253</Maximum>
<Average>169</Average>
</Row>
<Row>
<Name>Demo/Transaction/Demo.trx</Name>
<NumberRuns>13</NumberRuns>
<Minimum>167</Minimum>
<Maximum>1448</Maximum>
<Average>451</Average>
</Row>
<Row>
<Name>Demo/Transaction/DemoNS_short.trx</Name>
<NumberRuns>11</NumberRuns>
<Minimum>77</Minimum>
<Maximum>196869</Maximum>
<Average>34860</Average>
</Row>
</Rowset>
</Rowsets>
Example: Get the usage statistic for a specific file.
Request
Response
<?xml version="1.0" encoding="UTF-8" ?>
<Rowsets DateCreated="2011-12-06T15:26:27" EndDate="2011-12-06T15:26:27" StartDate="2011-12-06T14:26:27" Version="12.1.10 Build(15)">
<Rowset>
<Columns>
<ColumnDescription="Name" MaxRange="1" MinRange="0" Name="Name" SQLDataType="12" SourceColumn="Name" />
<ColumnDescription="NumberRuns" MaxRange="1" MinRange="0" Name="NumberRuns" SQLDataType="-5" SourceColumn="NumberRuns" />
<ColumnDescription="Minimum" MaxRange="1" MinRange="0" Name="Minimum" SQLDataType="-5" SourceColumn="Minimum" />
<ColumnDescription="Maximum" MaxRange="1" MinRange="0" Name="Maximum" SQLDataType="-5" SourceColumn="Maximum" />
<ColumnDescription="Average" MaxRange="1" MinRange="0" Name="Average" SQLDataType="-5" SourceColumn="Average" />
</Columns>
<Row>
<Name>Demo/Transaction/DemoNS_short.trx</Name>
<NumberRuns>58</NumberRuns>
<Minimum>20</Minimum>
<Maximum>118946</Maximum>
<Average>4969</Average>
</Row>
<Row>
<Name>Demo/Transaction/DemoNS_short.trx</Name>
<NumberRuns>11</NumberRuns>
<Minimum>77</Minimum>
<Maximum>196869</Maximum>
<Average>34860</Average>
</Row>
<Row>
<Name>Demo/Transaction/DemoNS_short.trx</Name>
<NumberRuns>31</NumberRuns>
<Minimum>11</Minimum>
<Maximum>480291</Maximum>
<Average>75909</Average>
</Row>
</Rowset>
</Rowsets>
FileUsageSummary
You use this mode to get a summary of the file usage summary for a specific time frame and/or path. Similar to File Usage the statistic is provided per day. What it means is that the shortest period of time that you can get statistic for is a day. For example if you request the startistic for the last 30 hours you will receive the statistics for the last 2 or even 3 days (it depends on the time when you run the request, if it is before 6a.p. the returned result will be for the last 3 days because these 30 hours are a part of these 3 days).
Request parameters
Parameter | Optional | Description |
Path | Yes | The path. If this parameter is specified then only the statistic information for the files from the specified folder will be retrieved. If this parameter is not specified then the result set contains the summary of all file usage for the specified time frame. |
StartDate | yes | The start date for the file usage. Any usage before that date will not be included in the result set. The format is “MM/dd/yyyy HH:mm:ss”. The default value, which is used when this parameter is not provided, is EndDate – Duration |
EndDate | yes | The end date for the file usage. Any usage after that date will not be included in the result set. The format is “MM/dd/yyyy HH:mm:ss”. The default value is:
|
Duration | yes | The duration of the time frame in minutes. The default duration is 60 minutes. |
Response
Name | Description |
Name | The file name |
NumberRuns | The number times it was run |
Minimum | The minimum execution time |
Maximum | The maximum execution time |
Average | The average execution time. |
Example: Get the file usage summary for a folder for the latest 6000 hours
Request
http://localhost:50000/XMII/Illuminator?service=Monitoring&Mode=FileUsageSummary&Duration=6000&Path=Demo/Transaction&content-type=text/xml
Response
<?xml version="1.0" encoding="UTF-8" ?>
<Rowsets DateCreated="2011-12-06T15:43:56" EndDate="2011-12-06T15:43:56" StartDate="2011-12-02T11:43:56" Version="12.1.10 Build(15)">
<Rowset>
<Columns>
<ColumnDescription="Name" MaxRange="1" MinRange="0" Name="Name" SQLDataType="12" SourceColumn="Name" />
<ColumnDescription="NumberRuns" MaxRange="1" MinRange="0" Name="NumberRuns" SQLDataType="-5" SourceColumn="NumberRuns" />
<ColumnDescription="Minimum" MaxRange="1" MinRange="0" Name="Minimum" SQLDataType="-5" SourceColumn="Minimum" />
<ColumnDescription="Maximum" MaxRange="1" MinRange="0" Name="Maximum" SQLDataType="-5" SourceColumn="Maximum" />
<ColumnDescription="Average" MaxRange="1" MinRange="0" Name="Average" SQLDataType="-5" SourceColumn="Average" />
</Columns>
<Row>
<Name>Demo/Transaction/Demo.trx</Name>
<NumberRuns>31</NumberRuns>
<Minimum>115</Minimum>
<Maximum>2139</Maximum>
<Average>507</Average>
</Row>
<Row>
<Name>Demo/Transaction/DemoNS.trx</Name>
<NumberRuns>2</NumberRuns>
<Minimum>85</Minimum>
<Maximum>253</Maximum>
<Average>169</Average>
</Row>
<Row>
<Name>Demo/Transaction/DemoNS_short.trx</Name>
<NumberRuns>69</NumberRuns>
<Minimum>20</Minimum>
<Maximum>196869</Maximum>
<Average>9734</Average>
</Row>
</Rowset>
</Rowsets>
Logins
You use this mode to view login information.
Request parameters
Parameter | Optional | Description |
StartDate | yes | The start date for the login information. Any logins before that date will not be included in the result set. The format is “MM/dd/yyyy HH:mm:ss”. The default value, which is used when this parameter is not provided, is EndDate – Duration |
EndDate | yes | The end date for the login information. Any logins after that date will not be included in the result set. The format is “MM/dd/yyyy HH:mm:ss”. The default value is:
|
Duration | yes | The duration of the time frame in minutes. The default duration is 60 minutes. |
Response
Name | Description |
RecordedDate | Self-explanatory |
UserName | Self-explanatory |
TotalLogins | Self-explanatory |
Example: Get the login information for the latest 24hours.
Request
Response
<?xml version="1.0" encoding="UTF-8" ?>
<Rowsets DateCreated="2011-12-06T16:17:39" EndDate="2011-12-06T16:17:39" StartDate="2011-12-05T16:17:39" Version="12.1.10 Build(15)">
<Rowset>
<Columns>
<ColumnDescription="RecordedDate" MaxRange="1" MinRange="0" Name="RecordedDate" SQLDataType="93" SourceColumn="RecordedDate" />
<ColumnDescription="Username" MaxRange="1" MinRange="0" Name="Username" SQLDataType="1" SourceColumn="Username" />
<ColumnDescription="TotalLogins" MaxRange="1" MinRange="0" Name="TotalLogins" SQLDataType="-5" SourceColumn="TotalLogins" />
</Columns>
<Row>
<RecordedDate>2011-12-06T00:00:00</RecordedDate>
<Username>Administrator</Username>
<TotalLogins>1</TotalLogins>
</Row>
<Row>
<RecordedDate>2011-12-05T00:00:00</RecordedDate>
<Username>Administrator</Username>
<TotalLogins>72</TotalLogins>
</Row>
</Rowset>
</Rowsets>
LoginsSummary
You use this mode to view login summary per day for a specific user or all logins per day for a requested time frame.
Request parameters
Parameter | Optional | Description |
UserName | Yes | The name of the user you want to get login summary. If you provide this parameter you will receive all available information for his/her logins summarized per day. When this parameter is not provided then the result query provides login summary for all users for a determined time frame. |
StartDate | yes | The start date for the file usage. Any usage before that date will not be included in the result set. The format is “MM/dd/yyyy HH:mm:ss”. The default value, which is used when this parameter is not provided, is EndDate – Duration It is used only when no UserName parameter is provided. |
EndDate | yes | The end date for the file usage. Any usage after that date will not be included in the result set. The format is “MM/dd/yyyy HH:mm:ss”. The default value is:
It is used only when no UserName parameter is provided. |
Duration | yes | The duration of the time frame in minutes. The default duration is 60 minutes. It is used only when no UserName parameter is provided. |
Response
The following information is returned for every day from the specified time period:
Name | Description |
RecordedDate | Self-explanatory |
TotalLogins | Self-explanatory |
Example: Get login summary for the Administrator.
Request
Response
<?xml version="1.0" encoding="UTF-8" ?>
<Rowsets DateCreated="2011-12-07T16:10:24" EndDate="2011-12-07T16:10:24" StartDate="2011-12-07T15:10:24" Version="12.1.10 Build(15)">
<Rowset>
<Columns>
<ColumnDescription="RecordedDate" MaxRange="1" MinRange="0" Name="RecordedDate" SQLDataType="93" SourceColumn="RecordedDate" />
<ColumnDescription="TotalLogins" MaxRange="1" MinRange="0" Name="TotalLogins" SQLDataType="-5" SourceColumn="TotalLogins" />
</Columns>
<Row>
<RecordedDate>2011-12-07T00:00:00</RecordedDate>
<TotalLogins>12</TotalLogins>
</Row>
<Row>
<RecordedDate>2011-12-06T00:00:00</RecordedDate>
<TotalLogins>2</TotalLogins>
</Row>
<Row>
<RecordedDate>2011-12-05T00:00:00</RecordedDate>
<TotalLogins>72</TotalLogins>
</Row>
…
</Rowset>
</Rowsets>
Example: Get the login summary for all users’ logins for the last 24 hours.
Request
Response
<?xml version="1.0" encoding="UTF-8" ?>
<Rowsets DateCreated="2011-12-07T16:10:59" EndDate="2011-12-07T16:10:59" StartDate="2011-12-06T16:10:59" Version="12.1.10 Build(15)">
<Rowset>
<Columns>
<ColumnDescription="RecordedDate" MaxRange="1" MinRange="0" Name="RecordedDate" SQLDataType="93" SourceColumn="RecordedDate" />
<ColumnDescription="TotalLogins" MaxRange="1" MinRange="0" Name="TotalLogins" SQLDataType="-5" SourceColumn="TotalLogins" />
</Columns>
<Row>
<RecordedDate>2011-12-07T00:00:00</RecordedDate>
<TotalLogins>12</TotalLogins>
</Row>
<Row>
<RecordedDate>2011-12-06T00:00:00</RecordedDate>
<TotalLogins>2</TotalLogins>
</Row>
</Rowset>
</Rowsets>
Messages
You use this mode to retrieve Message Listener receive and process information.
Request parameters
Parameter | Optional | Description |
StartDate | yes | The start date for the file usage. Any usage before that date will not be included in the result set. The format is “MM/dd/yyyy HH:mm:ss”. The default value, which is used when this parameter is not provided, is EndDate – Duration |
EndDate | yes | The end date for the file usage. Any usage after that date will not be included in the result set. The format is “MM/dd/yyyy HH:mm:ss”. The default value is:
|
Duration | yes | The duration of the time frame in minutes. The default duration is 60 minutes. |
Response
Name | Description |
RecordedDate | Self-explanatory |
ServerName | The message listener name |
TotalReceived | The number of received message |
ProcessingErrors | The number of errors that occurred during the processing |
ProcessingException | The number of exception that occurred during the processing |
NoRuleDefined | The number of received messages that |
MappedCategory | The message category |
Example: Get the Message Listener activity summary for the last 24 hours.
Request
Response
<?xml version="1.0" encoding="UTF-8" ?>
<Rowsets DateCreated="2011-12-07T16:36:28" EndDate="2011-12-07T16:36:28" StartDate="2011-12-06T16:36:28" Version="12.1.10 Build(15)">
<Rowset>
<Columns>
<ColumnDescription="RecordedDate" MaxRange="1" MinRange="0" Name="RecordedDate" SQLDataType="93" SourceColumn="RecordedDate" />
<ColumnDescription="ServerName" MaxRange="1" MinRange="0" Name="ServerName" SQLDataType="1" SourceColumn="ServerName" />
<ColumnDescription="TotalReceived" MaxRange="1" MinRange="0" Name="TotalReceived" SQLDataType="-5" SourceColumn="TotalReceived" />
<ColumnDescription="ProcessingErrors" MaxRange="1" MinRange="0" Name="ProcessingErrors" SQLDataType="-5" SourceColumn="ProcessingErrors" />
<ColumnDescription="ProcessingException" MaxRange="1" MinRange="0" Name="ProcessingException" SQLDataType="-5" SourceColumn="ProcessingException" />
<ColumnDescription="NoRuleDefined" MaxRange="1" MinRange="0" Name="NoRuleDefined" SQLDataType="-5" SourceColumn="NoRuleDefined" />
<ColumnDescription="MappedCategory" MaxRange="1" MinRange="0" Name="MappedCategory" SQLDataType="-5" SourceColumn="MappedCategory" />
</Columns>
<Row>
<RecordedDate>2011-12-07T00:00:00</RecordedDate>
<ServerName>XMIIIDOC01</ServerName>
<TotalReceived>16</TotalReceived>
<ProcessingErrors>0</ProcessingErrors>
<ProcessingException>0</ProcessingException>
<NoRuleDefined>0</NoRuleDefined>
<MappedCategory>0</MappedCategory>
</Row>
</Rowset>
</Rowsets>
ModeList
You can use this mode to view a list of modes supported by the Monitoring service.
Request parameters
It does not require any additional parameters.
Response
Name | Description |
ModeName | The mode name |
Example
Request
http://localhost:50000/XMII/Illuminator?service=Monitoring&Mode=modelist&content-type=text/xml
Response
<?xml version="1.0" encoding="UTF-8" ?>
<Rowsets DateCreated="2011-12-06T13:27:46" EndDate="2011-12-06T13:27:46" StartDate="2011-12-06T12:27:46" Version="12.1.10 Build(15)">
<Rowset>
<Columns>
<ColumnDescription="ModeName" MaxRange="1" MinRange="0" Name="ModeName" SQLDataType="1" SourceColumn="ModeName" />
</Columns>
<Row>
<ModeName>DataServers</ModeName>
</Row>
……
<Row>
<ModeName>UserQuery</ModeName>
</Row>
</Rowset>
</Rowsets>
UserQuery
You use this mode to get the monitoring summary for the number of query runs and the number of returned rows. You can retrieve this information for a specified user or for a specified period.
Request parameters
Parameter | Optional | Description |
UserName | Yes | The user name. If not user name is provided then this mode will return the monitoring data for a specific time frame. |
StartDate | yes | The start date for the query runs summary. Any query runs before that date will not be included in the result set. The format is “MM/dd/yyyy HH:mm:ss”. The default value, which is used when this parameter is not provided, is EndDate – Duration It is used only when no UserName parameter is provided. |
EndDate | yes | The end date for the query runs summary. Any query runs after that date will not be included in the result set. The format is “MM/dd/yyyy HH:mm:ss”. The default value is:
It is used only when no UserName parameter is provided. |
Duration | yes | The duration of the time frame in minutes. The default duration is 60 minutes. It is used only when no UserName parameter is provided. |
Response
Name | Description |
RecordedDate | Self-explanatory |
Username | Self-explanatory |
NumberRequests | The number of run queries |
RowsReturned | The number of rows returned by these queries |
Example: Get the query monitor information for the last 24h
Request
Response
<?xml version="1.0" encoding="UTF-8" ?>
<Rowsets DateCreated="2011-12-07T16:47:48" EndDate="2011-12-07T16:47:48" StartDate="2011-12-06T16:47:48" Version="12.1.10 Build(15)">
<Rowset>
<Columns>
<ColumnDescription="RecordedDate" MaxRange="1" MinRange="0" Name="RecordedDate" SQLDataType="93" SourceColumn="RecordedDate" />
<ColumnDescription="Username" MaxRange="1" MinRange="0" Name="Username" SQLDataType="1" SourceColumn="Username" />
<ColumnDescription="NumberRequests" MaxRange="1" MinRange="0" Name="NumberRequests" SQLDataType="-5" SourceColumn="NumberRequests" />
<ColumnDescription="RowsReturned" MaxRange="1" MinRange="0" Name="RowsReturned" SQLDataType="-5" SourceColumn="RowsReturned" />
</Columns>
<Row>
<RecordedDate>2011-12-07T00:00:00</RecordedDate>
<Username>Administrator</Username>
<NumberRequests>3</NumberRequests>
<RowsReturned>25</RowsReturned>
</Row>
<Row>
<RecordedDate>2011-12-06T00:00:00</RecordedDate>
<Username>Administrator</Username>
<NumberRequests>7</NumberRequests>
<RowsReturned>157</RowsReturned>
</Row>
</Rowset>
</Rowsets>
Example: Gets the query monitoring information for the Administrator user
Request
Response
<?xml version="1.0" encoding="UTF-8" ?>
<Rowsets DateCreated="2011-12-07T16:48:17" EndDate="2011-12-07T16:48:17" StartDate="2011-12-07T15:48:17" Version="12.1.10 Build(15)">
<Rowset>
<Columns>
<ColumnDescription="RecordedDate" MaxRange="1" MinRange="0" Name="RecordedDate" SQLDataType="93" SourceColumn="RecordedDate" />
<ColumnDescription="Username" MaxRange="1" MinRange="0" Name="Username" SQLDataType="1" SourceColumn="Username" />
<ColumnDescription="NumberRequests" MaxRange="1" MinRange="0" Name="NumberRequests" SQLDataType="-5" SourceColumn="NumberRequests" />
<ColumnDescription="RowsReturned" MaxRange="1" MinRange="0" Name="RowsReturned" SQLDataType="-5" SourceColumn="RowsReturned" />
</Columns>
<Row>
<RecordedDate>2011-12-07T00:00:00</RecordedDate>
<Username>Administrator</Username>
<NumberRequests>3</NumberRequests>
<RowsReturned>25</RowsReturned>
</Row>
<Row>
<RecordedDate>2011-12-06T00:00:00</RecordedDate>
<Username>Administrator</Username>
<NumberRequests>7</NumberRequests>
<RowsReturned>157</RowsReturned>
</Row>
<Row>
<RecordedDate>2011-12-01T00:00:00</RecordedDate>
<Username>Administrator</Username>
<NumberRequests>3</NumberRequests>
<RowsReturned>19</RowsReturned>
</Row>
<Row>
<RecordedDate>2011-11-29T00:00:00</RecordedDate>
<Username>Administrator</Username>
<NumberRequests>16</NumberRequests>
<RowsReturned>62</RowsReturned>
</Row>
<Row>
<RecordedDate>2011-11-28T00:00:00</RecordedDate>
<Username>Administrator</Username>
<NumberRequests>9</NumberRequests>
<RowsReturned>32</RowsReturned>
</Row>
</Rowset>
</Rowsets>
BLSManager
BSLManager service provides access to the Transaction Manager data as well as providing some general interfaces.
The action required to access BLSManager is XMII_BLSManagerService. The roles that have this action assigned by default are SAP_XMII_Super_Administrator and SAP_XMII_Administrator.
ClearCache
You use this mode to clear the transaction cache. It does not require any additional parameters. The response provides information if the operation was successful or not.
ClearCache mode requires additional permission, in order to clear the case the user has to have XMII_Transaction_Delete in his profile.
Request parameters
This mode does not require any additional parameters.
Response
The response contains successful or error message, no data is returned in the response.
Example
Request
http://localhost:50000/XMII/Illuminator?service=BLSManager&mode=ClearCache&content-type=text/xml
Response
<?xml version="1.0" encoding="UTF-8" ?>
<Rowsets DateCreated="2011-08-05T11:09:57" EndDate="2011-08-05T11:09:57" StartDate="2011-08-05T10:09:57" Version="12.1.9 Build(108)">
<Messages>
<Message>Successful</Message>
</Messages>
</Rowsets>
Delete
You use this mode to delete a transaction entry from the Transaction Manager database. The response provides information if the operation was successful or not.
This mode requires additional permission, in order to be able to delete an entry the user must have XMII_Transaction_Delete or XMII_Transaction_all actions assigned to his profile.
Request parameters
Parameter | Optional | Description |
ID | No | The id of the transaction that should be deleted from the Transaction Manager. |
Force | Yes | You can use this parameter to indicate that the entry can be deleted even if the transaction is in a running state. The parameter value in this case should be “True”. The default value is “False”, which means that the transaction can be deleted only if its status is Succeeded, Failed, Terminated or Pending. |
Response
The response contains successful or error message, no data is returned in the response.
Example
Request
http://localhost:50000/XMII/Illuminator?service=BLSManager&mode=Delete&id=139&content-type=text/xml
Response
<?xml version="1.0" encoding="UTF-8" ?>
<Rowsets DateCreated="2011-09-21T14:28:45" EndDate="2011-09-21T14:28:42" StartDate="2011-09-21T13:28:42" Version="12.1.9 Build(112)">
<Messages>
<Message>Successful</Message>
</Messages>
</Rowsets>
Details
You use this mode to view the details of a transaction entry stored in the Transaction Manager database.
Request parameters
Parameter | Optional | Description |
ID | No | The transaction id |
Response
The following information is returned in a rowset:
Name | Description |
NAME | The transaction name |
SERVER | The server where the transaction was ran |
STATUS | The transaction status |
RUNTIME | The transaction mode – synchronous or asynchronous |
RUNNING_USER | The user who ran the transaction |
START_TIME | The time when the transaction began its execution |
END_TIME | The time when the transaction ended its execution |
DURATION | The duration of transaction execution |
LOG | The transaction traces |
Example
Request
http://localhost:50000/XMII/Illuminator?service=BLSManager&mode=Details&id=138&content-type=text/xml
Response
<?xml version="1.0" encoding="UTF-8" ?>
<Rowsets DateCreated="2011-09-21T14:39:59" EndDate="2011-09-21T14:37:50" StartDate="2011-09-21T13:37:50" Version="12.1.9 Build(112)">
<Rowset>
<Columns>
<ColumnDescription="NAME" MaxRange="1" MinRange="0" Name="NAME" SQLDataType="12" SourceColumn="NAME" />
<ColumnDescription="SERVER" MaxRange="1" MinRange="0" Name="SERVER" SQLDataType="12" SourceColumn="SERVER" />
<ColumnDescription="STATUS" MaxRange="1" MinRange="0" Name="STATUS" SQLDataType="12" SourceColumn="STATUS" />
<ColumnDescription="RUNTIME" MaxRange="1" MinRange="0" Name="RUNTIME" SQLDataType="12" SourceColumn="RUNTIME" />
<ColumnDescription="RUNNING_USER" MaxRange="1" MinRange="0" Name="RUNNING_USER" SQLDataType="12" SourceColumn="RUNNING_USER" />
<ColumnDescription="STARTTIME" MaxRange="1" MinRange="0" Name="STARTTIME" SQLDataType="93" SourceColumn="STARTTIME" />
<ColumnDescription="ENDTIME" MaxRange="1" MinRange="0" Name="ENDTIME" SQLDataType="93" SourceColumn="ENDTIME" />
<ColumnDescription="DURATION" MaxRange="1" MinRange="0" Name="DURATION" SQLDataType="-5" SourceColumn="DURATION" />
<ColumnDescription="EXPIRATION" MaxRange="1" MinRange="0" Name="EXPIRATION" SQLDataType="93" SourceColumn="EXPIRATION" />
<ColumnDescription="LOG" MaxRange="1" MinRange="0" Name="LOG" SQLDataType="12" SourceColumn="LOG" />
</Columns>
<Row>
<NAME>ERPIntegration/JRA/MaterialAvailabilityJRASession.trx</NAME>
<SERVER>PHLD00473530A_NKG_02</SERVER>
<STATUS>Succeeded</STATUS>
<RUNTIME>Sync</RUNTIME>
<RUNNING_USER>SYSTEM</RUNNING_USER>
<STARTTIME>2011-09-21T13:15:55</STARTTIME>
<ENDTIME>2011-09-21T13:15:56</ENDTIME>
<DURATION>1260</DURATION>
<EXPIRATION>2011-09-21T21:15:56</EXPIRATION>
<LOG><?xml version="1.0" encoding="UTF-8" ?><Rowsets DateCreated="2011-09-21T13:15:56" EndDate="2011-09-21T13:15:56" StartDate="2011-09-21T13:15:56" Version="12.1.9 Build(112)" TransactionID="138"><Messages></Messages></Rowsets></LOG>
</Row>
</Rowset>
</Rowsets>
FixHighExpiringTransactions
You use this mode to check for high expiring transactions. Transactions that are found with high expiring values will be corrected as well the expiration value for any transaction that calls that transaction. It does not have any additional parameters and response provides information if the operation was successful or not.
This mode requires additional permission; the user must have XMII_Transaction_Delete or XMII_Transaction_all actions assigned to his profile.
It is available in SP08 and newer. See note 1517887 for additional details.
Request parameters
This mode does not require any additional paramters.
Response
The response contains successful or error message, no data is returned in the response.
Example
Request
Response
<?xml version="1.0" encoding="UTF-8" ?>
<Rowsets DateCreated="2011-09-21T14:53:15" EndDate="2011-09-21T14:53:06" StartDate="2011-09-21T13:53:06" Version="12.1.9 Build(112)">
<Messages>
<Message>Successful</Message>
</Messages>
</Rowsets>
List
You use this mode to see a list of pending and processed transactions stored in the Transaction Manager database. This mode accepts a number of parameters that you can provide in order to restrict the returned set. The response will contain only these entries that match the provided parameters.
Request paramaters
Parameter | Optional | Description |
Name | Yes | The transaction name. If you provide a transaction name the result set will contain only the records for the requested transaction. |
UserName | Yes | The name of the user who ran the transaction |
Status | Yes | The status of the transaction. The values that are accepted are numbers and they are:
|
StartDate | Yes | The start date. Transactions ran before that date will not be included in the result set. The format is MM/dd/yyyy HH:mm:ss. The default value, which is used when this parameter is not provided, is EndDate - Duration |
EndDate | Yes | The end date. Transactions ran after that date will not be included in the result set. The format is MM/dd/yyyy HH:mm:ss. The default value is:
|
Duration | Yes | The duration of the time frame in minutes. The default duration is 60 minutes. |
Response
Тhe following information is returned for every transaction that matches the provided criteria:
Name | Description |
ID | The identifier assigned by the system for the transaction |
NAME | The transaction name |
SERVER | The server where the transaction was ran |
STATUS | The transaction status |
RUNTIME | The transaction mode – synchronous or asynchronous |
RUNNING_USED | The user who ran the transaction |
STARTTIME | The time when the transaction began its execution |
ENDTIME | The time when the transaction ended its execution |
DURATION | The duration of transaction execution |
EXPIRATION | The time when the transaction entry will expire and will be removed from the transaction manager |
Example
Request
http://localhost:50000/XMII/Illuminator?service=BLSManager&mode=List&content-type=text/xml
Response
<?xml version="1.0" encoding="UTF-8" ?>
<Rowsets DateCreated="2011-08-05T11:23:14" EndDate="2011-08-05T11:23:14" StartDate="2011-08-05T10:23:14" Version="12.1.9 Build(108)">
<Rowset>
<Columns>
<ColumnDescription="ID" MaxRange="1" MinRange="0" Name="ID" SQLDataType="4" SourceColumn="ID" />
<ColumnDescription="NAME" MaxRange="1" MinRange="0" Name="NAME" SQLDataType="12" SourceColumn="NAME" />
<ColumnDescription="SERVER" MaxRange="1" MinRange="0" Name="SERVER" SQLDataType="12" SourceColumn="SERVER" />
<ColumnDescription="STATUS" MaxRange="1" MinRange="0" Name="STATUS" SQLDataType="12" SourceColumn="STATUS" />
<ColumnDescription="RUNTIME" MaxRange="1" MinRange="0" Name="RUNTIME" SQLDataType="12" SourceColumn="RUNTIME" />
<ColumnDescription="RUNNING_USER" MaxRange="1" MinRange="0" Name="RUNNING_USER" SQLDataType="12" SourceColumn="RUNNING_USER" />
<ColumnDescription="STARTTIME" MaxRange="1" MinRange="0" Name="STARTTIME" SQLDataType="93" SourceColumn="STARTTIME" />
<ColumnDescription="ENDTIME" MaxRange="1" MinRange="0" Name="ENDTIME" SQLDataType="93" SourceColumn="ENDTIME" />
<ColumnDescription="DURATION" MaxRange="1" MinRange="0" Name="DURATION" SQLDataType="-5" SourceColumn="DURATION" />
<ColumnDescription="EXPIRATION" MaxRange="1" MinRange="0" Name="EXPIRATION" SQLDataType="93" SourceColumn="EXPIRATION" />
</Columns>
<Row>
<ID>86805</ID>
<NAME>MyProject/TracerOutputTesting/TracerOutputTest.trx</NAME>
<SERVER>PHLN00485290B_LKG_00</SERVER>
<STATUS>Succeeded</STATUS>
<RUNTIME>Sync</RUNTIME>
<RUNNING_USER>SYSTEM</RUNNING_USER>
<STARTTIME>2011-08-05T11:23:01</STARTTIME>
<ENDTIME>2011-08-05T11:23:01</ENDTIME>
<DURATION>0</DURATION>
<EXPIRATION>2011-08-05T19:23:01</EXPIRATION>
</Row>
<Row>
<ID>86804</ID>
<NAME>MyProject/TracerOutputTesting/TracerOutputTest.trx</NAME>
<SERVER>PHLN00485290B_LKG_00</SERVER>
<STATUS>Succeeded</STATUS>
<RUNTIME>Sync</RUNTIME>
<RUNNING_USER>SYSTEM</RUNNING_USER>
<STARTTIME>2011-08-05T11:22:00</STARTTIME>
<ENDTIME>2011-08-05T11:22:00</ENDTIME>
<DURATION>1</DURATION>
<EXPIRATION>2011-08-05T19:22:00</EXPIRATION>
</Row>
</Rowset>
</Rowsets>
ModeList
You use that mode to view a list of all service modes that BLSManager service provides. It does not have any additional parameters.
Reuquest parameters
This mode does not require any additional parameters.
Response
Returns a rowset with the supported modes:
Name | Description |
ModeName | The mode name |
Example
Request
http://localhost:50000/XMII/Illuminator?service=BLSManager&mode=ModeList&content-type=text/xml
Response
<?xml version="1.0" encoding="UTF-8" ?>
<Rowsets DateCreated="2011-08-05T10:39:39" EndDate="2011-08-05T10:39:39" StartDate="2011-08-05T09:39:39" Version="12.1.9 Build(108)">
<Rowset>
<Columns>
<ColumnDescription="ModeName" MaxRange="1" MinRange="0" Name="ModeName" SQLDataType="1" SourceColumn="ModeName" />
</Columns>
<Row>
<ModeName>ClearCache</ModeName>
</Row>
……
<Row>
<ModeName>ViewOutput</ModeName>
</Row>
</Rowset>
</Rowsets>
Stats
You use this mode to view performance statistic for a transaction. Performance statistics are introduced with SP06. Transaction statistics can be generated by running transactions from the runner servlet. Passing the parameter LogStatisticsToDB=true will force the log level to DEBUG and the persistence of the transaction and all sub transactions to ALWAYS. This allows MII BLS to track the runtime of links and actions and persist them to the database. This information is tied to the data in the transaction manager table. When the entry is deleted from the transaction manager the performance information is also deleted.
To run a transaction with statistics enabled:
http://<server>:<port>/XMII/Runner?Transaction=<myproject/transname>&LogStatisticsToDB=true
Request parameters
Parameter | Optional | Description |
ID | No | The transaction id |
Response
The following information will be returned for all the actions and links which were run in the root transaction and in all sub-transactions.
Name | Description |
ID | The transaction ID |
TransactionName | The transaction name |
RootID | The root transaction ID |
ParentID | The parent transaction ID |
ActionName | The action name |
Destination | Link destination (for links only) |
Average | Average execution time in milliseconds |
Minimum | Minimum execution time in milliseconds |
Maximum | Maximum execution time in milliseconds |
Total | Total execution time in milliseconds |
Count | Number of times it was run |
Please note that the data is per transaction. So if a transaction was called multiple times the values will be calculated for each run and not accumulated. Also there are no values recorded for control actions since they are considered negligible. Another item of interest would be that for actions like the transaction call action, their execution time is the total time to run the sub transaction.
Example
Request
http://localhost:50000/XMII/Illuminator?service=BLSManager&mode=stats&id=143&content-type=text/xml
Response
<?xml version="1.0" encoding="UTF-8" ?>
<Rowsets DateCreated="2011-09-21T15:39:19" EndDate="2011-09-21T15:39:19" StartDate="2011-09-21T14:39:19" Version="12.1.9 Build(112)">
<Rowset>
<Columns>
<ColumnDescription="ID" MaxRange="1" MinRange="0" Name="ID" SQLDataType="-5" SourceColumn="ID" />
<ColumnDescription="TransactionName" MaxRange="1" MinRange="0" Name="TransactionName" SQLDataType="12" SourceColumn="TransactionName" />
<ColumnDescription="RootID" MaxRange="1" MinRange="0" Name="RootID" SQLDataType="-5" SourceColumn="RootID" />
<ColumnDescription="ParentID" MaxRange="1" MinRange="0" Name="ParentID" SQLDataType="-5" SourceColumn="ParentID" />
<ColumnDescription="ActionName" MaxRange="1" MinRange="0" Name="ActionName" SQLDataType="12" SourceColumn="ActionName" />
<ColumnDescription="Destination" MaxRange="1" MinRange="0" Name="Destination" SQLDataType="12" SourceColumn="Destination" />
<ColumnDescription="Average" MaxRange="1" MinRange="0" Name="Average" SQLDataType="8" SourceColumn="Average" />
<ColumnDescription="Minimum" MaxRange="1" MinRange="0" Name="Minimum" SQLDataType="8" SourceColumn="Minimum" />
<ColumnDescription="Maximum" MaxRange="1" MinRange="0" Name="Maximum" SQLDataType="8" SourceColumn="Maximum" />
<ColumnDescription="Total" MaxRange="1" MinRange="0" Name="Total" SQLDataType="8" SourceColumn="Total" />
<ColumnDescription="Count" MaxRange="1" MinRange="0" Name="Count" SQLDataType="-5" SourceColumn="Count" />
</Columns>
<Row>
<ID>143</ID>
<TransactionName>ERPIntegration/JRA/MaterialAvailabilityJRASession.trx</TransactionName>
<RootID>143</RootID>
<ParentID>143</ParentID>
<ActionName>SAP_JRA_Function_Availability</ActionName>
<Destination>---</Destination>
<Average>605</Average>
<Minimum>605</Minimum>
<Maximum>605</Maximum>
<Total>605</Total>
<Count>1</Count>
</Row>
<Row>
<ID>143</ID>
<TransactionName>ERPIntegration/JRA/MaterialAvailabilityJRASession.trx</TransactionName>
<RootID>143</RootID>
<ParentID>143</ParentID>
<ActionName>SAP_JRA_Function_CheckExists</ActionName>
<Destination>---</Destination>
<Average>515</Average>
<Minimum>515</Minimum>
<Maximum>515</Maximum>
<Total>515</Total>
<Count>1</Count>
</Row>
<Row>
<ID>143</ID>
<TransactionName>ERPIntegration/JRA/MaterialAvailabilityJRASession.trx</TransactionName>
<RootID>143</RootID>
<ParentID>143</ParentID>
<ActionName>SAP_JRA_End_Session_0</ActionName>
<Destination>---</Destination>
<Average>106</Average>
<Minimum>106</Minimum>
<Maximum>106</Maximum>
<Total>106</Total>
<Count>1</Count>
</Row>
<Row>
<ID>143</ID>
<TransactionName>ERPIntegration/JRA/MaterialAvailabilityJRASession.trx</TransactionName>
<RootID>143</RootID>
<ParentID>143</ParentID>
<ActionName>SAP_JRA_Function_Availability</ActionName>
<Destination>SAP_JRA_Function_Availability.Request{/BAPI_MATERIAL_AVAILABILITY/INPUT/MATERIAL}</Destination>
<Average>2</Average>
<Minimum>2</Minimum>
<Maximum>2</Maximum>
<Total>8</Total>
<Count>4</Count>
</Row>
<Row>
<ID>143</ID>
<TransactionName>ERPIntegration/JRA/MaterialAvailabilityJRASession.trx</TransactionName>
<RootID>143</RootID>
<ParentID>143</ParentID>
<ActionName>Conditional_1</ActionName>
<Destination>Conditional_1.Input1</Destination>
<Average>2</Average>
<Minimum>2</Minimum>
<Maximum>2</Maximum>
<Total>2</Total>
<Count>1</Count>
</Row>
<Row>
<ID>143</ID>
<TransactionName>ERPIntegration/JRA/MaterialAvailabilityJRASession.trx</TransactionName>
<RootID>143</RootID>
<ParentID>143</ParentID>
<ActionName>Conditional_0</ActionName>
<Destination>Conditional_0.Input1</Destination>
<Average>2</Average>
<Minimum>2</Minimum>
<Maximum>2</Maximum>
<Total>2</Total>
<Count>1</Count>
</Row>
<Row>
<ID>143</ID>
<TransactionName>ERPIntegration/JRA/MaterialAvailabilityJRASession.trx</TransactionName>
<RootID>143</RootID>
<ParentID>143</ParentID>
<ActionName>SAP_JRA_Function_CheckExists</ActionName>
<Destination>SAP_JRA_Function_CheckExists.Request{/BAPI_MATERIAL_EXISTENCECHECK/INPUT/MATERIAL}</Destination>
<Average>2</Average>
<Minimum>2</Minimum>
<Maximum>2</Maximum>
<Total>2</Total>
<Count>1</Count>
</Row>
<Row>
<ID>143</ID>
<TransactionName>ERPIntegration/JRA/MaterialAvailabilityJRASession.trx</TransactionName>
<RootID>143</RootID>
<ParentID>143</ParentID>
<ActionName>Tracer_MATERIAL_AVAILABILITY</ActionName>
<Destination>---</Destination>
<Average>0</Average>
<Minimum>0</Minimum>
<Maximum>0</Maximum>
<Total>0</Total>
<Count>1</Count>
</Row>
<Row>
<ID>143</ID>
<TransactionName>ERPIntegration/JRA/MaterialAvailabilityJRASession.trx</TransactionName>
<RootID>143</RootID>
<ParentID>143</ParentID>
<ActionName>SAP_JRA_Start_Session_0</ActionName>
<Destination>---</Destination>
<Average>0</Average>
<Minimum>0</Minimum>
<Maximum>0</Maximum>
<Total>0</Total>
<Count>1</Count>
</Row>
</Rowset>
</Rowsets>
Terminate
You use this mode to terminate a transaction. The response provides information if the operation was successful or not.
This mode requires additional permission; the user must have XMII_Transaction_Delete or XMII_Transaction_all actions assigned to his profile
Request parameters
Parameter | Optional | Description |
ID | No | The transaction id |
Reason | Yes | The reason for the transaction termination |
Response
The response contains successful or error message, no data is returned in the response.
Example
Request
Response
<?xml version="1.0" encoding="UTF-8" ?>
<Rowsets DateCreated="2011-09-21T15:57:36" EndDate="2011-09-21T15:57:36" StartDate="2011-09-21T14:57:36" Version="12.1.9 Build(112)">
<Messages>
<Message>Successful</Message>
</Messages>
</Rowsets>
ViewCache
You use this mode to view the content of the transaction cache.
Response
This service returns a list of all the transaction that is in the transaction cache. The information provided for every one of these entries is:
Name | Description |
Name | The name of the transaction |
LastRunTime | The last time when it was run |
Expiration | The time until the entry will remains in the transaction cache |
Runs | How many times the transaction was run |
Example
Request
http://localhost:50000/XMII/Illuminator?service=BLSManager&mode=ViewCache&content-type=text/xml
Response
<?xml version="1.0" encoding="UTF-8" ?>
<Rowsets DateCreated="2011-08-05T11:09:17" EndDate="2011-08-05T11:09:17" StartDate="2011-08-05T10:09:17" Version="12.1.9 Build(108)">
<Rowset>
<Columns>
<ColumnDescription="Name" MaxRange="1" MinRange="0" Name="Name" SQLDataType="12" SourceColumn="Name" />
<ColumnDescription="LastRunTime" MaxRange="1" MinRange="0" Name="LastRunTime" SQLDataType="93" SourceColumn="LastRunTime" />
<ColumnDescription="Expiration" MaxRange="1" MinRange="0" Name="Expiration" SQLDataType="93" SourceColumn="Expiration" />
<ColumnDescription="Runs" MaxRange="1" MinRange="0" Name="Runs" SQLDataType="4" SourceColumn="Runs" />
</Columns>
<Row>
<Name>MyProject/TracerOutputTesting/TracerOutputTest.trx</Name>
<LastRunTime>2011-08-05T11:09:01</LastRunTime>
<Expiration>2011-08-05T13:09:01</Expiration>
<Runs>14</Runs>
</Row>
</Rowset>
</Rowsets>
ViewLog
You use this mode to view the log of a transaction stored in the Transaction Manager.
Request parameters
Parameter | Optional | Description |
ID | No | The transaction ID |
Response
The result contains all log entries that were created during the execution of the transaction.
Name | Description |
Message | A log entry |
Example
Request
http://localhost:50000/XMII/Illuminator?service=BLSManager&mode=viewlog&id=164&content-type=text/xml
Response
<?xml version="1.0" encoding="UTF-8" ?>
<Rowsets DateCreated="2011-09-21T16:35:28" EndDate="2011-09-21T16:35:28" StartDate="2011-09-21T15:35:28" Version="12.1.9 Build(112)">
<Rowset>
<Columns>
<ColumnDescription="Message" MaxRange="1" MinRange="0" Name="Message" SQLDataType="12" SourceColumn="Message" />
</Columns>
<Row>
<Message>[INFO] [Tracer_MATERIAL_AVAILABILITY]448.000</Message>
</Row>
<Row>
<Message>[INFO] Statistics [Load = 0 ms msec, Parse = 1 ms, Execution = 1212 ms, Total = 1228 ms]</Message>
</Row>
</Rowset>
</Rowsets>
ViewOutput
You use this mode to view the output of a transaction stored in the Transaction Manager. If you want the output of the transaction to be stored you have to run it with request parameter StoreTransactionOutput set to true. If you have executed the transaction with request parameter OutputParameter set to the list of output parameter, the output parameter will be shown in the output too.
Request parameters
Parameter | Optional | Description |
ID | No | The transaction ID |
Response
The response contains the transaction output. A rowset with the following information is returned:
Name | Description |
Message | A single line of the transaction output |
Example
Request
Response
<?xml version="1.0" encoding="UTF-8" ?>
<Rowsets DateCreated="2011-09-21T16:33:25" EndDate="2011-09-21T16:33:25" StartDate="2011-09-21T16:33:25" Version="12.1.9 Build(112)" TransactionID="164">
<Messages>
<Message level="INFO">[INFO] [Tracer_MATERIAL_AVAILABILITY]448.000</Message>
<Message level="INFO">[INFO] Statistics [Load = 0 ms msec, Parse = 1 ms, Execution = 1212 ms, Total = 1228 ms]</Message>
</Messages>
</Rowsets>