SQL Scripting Commands

--#Exit

Stops the execution of the script and gives a message to the user. This command takes one SELECT query as its parameter.

Query

Configures the command using a SELECT statement returning two columns: the first column is for a key and the second one is for a value of that key. The values in both the key column and in the value column are of type NVARCHAR. The supported keys for this command are:

'Exit'

Defines whether to stop the script execution:

1 = stop execution of the current script and call the script defined by the RunScriptId parameter if it is given.

0 = if a value for the RunScriptId parameter is given, pause the execution of the current script and call the given script, then resume running the current script after the given script ends. If a value for RunScriptId is not given, do not pause or stop execution of the current script.

'MessageText'

Text to be shown to the user after the script execution is finished if the script finished because of the Exit command, i.e. when Exit=1. The default value is "Script execution finished.", which is shown also when the script finished normally, i.e. when Exit=0. The text is also written to the script log.

'RunScriptId'

Optional. The Id of the script to be run. Can be empty. Note that the script can call itself, so be careful not to create a looping script.

'CatchOperationExceptions'

Optional. Defines whether to stop the script execution or to continue to run the script from the next statement if an exception occurs when running the script:

1 = don't stop execution of the script, continue running the script from the next statement.

0 = stop execution of the current script and show the exception.

The following script variables will be set and are shown in the script log:

@_ExceptionOccurred If there was an exception, then this value is 1, otherwise 0. INT

@_ExceptionType If there was an exception, shows the C# class name for the exception, NVARCHAR(MAX), otherwise NULL.

@_ExceptionMessage If there was an exception, contains a message that would have been displayed, NVARCHAR(MAX), otherwise NULL.

@_ExceptionDetails If there was an exception, contains the details that would have been displayed, including the system stack trace, NVARCHAR(MAX), otherwise NULL.

Examples

The Exit command can in effect be used to "call" a script, i.e. run a different script and then return to continue the current script.

(SELECT 'Exit', '0') UNION ALL 
(SELECT 'RunScriptId', '12')   
--#Exit 

The Exit command can also be used to "goto" a script, i.e. stop the execution of the current script and run a different script.

(SELECT 'Exit', '1') UNION ALL  
(SELECT 'RunScriptId', '12')  
--#Exit 

The following example stops the script execution, gives a message, and runs a script with Id 12.

(SELECT 'Exit', '1') UNION ALL
(SELECT 'MessageText', 'Data from SAP not valid. Script execution will be terminated. Check source data. Running script Id 12.') UNION ALL
(SELECT 'RunScriptId', '12')
--#Exit

The following example script fragment checks if the previous ProcessAnalyzer command had any exceptions, and if it did, will goto script with Id 2. If the previous command didn't have any exceptions, the script execution is stopped.

DECLARE @ScriptToRun VARCHAR(10)

IF @_ExceptionOccurred = 1 
 SET @ScriptToRun = '2' 
 ELSE SET @ScriptToRun  = ''

(SELECT 'Exit', '1') UNION ALL  
(SELECT 'RunScriptId', @ScriptToRun)  
 --#Exit

--#GetAnalysis

Creates an analysis from the data which the preceding SQL statements given as parameters provide. This command can take several queries, one for every analysis to be performed. These queries and analysis results are independent from one another.

Query

Configures the command using a SELECT statement returning two columns: the first column is for a key and the second one is for a value of that key. The values in both the key column and in the value column are of type NVARCHAR. The supported keys for this command are:

'<Analysis Parameter>'

See Analysis Parameters for a list of supported analysis parameters in QPR ProcessAnalyzer.

The --#GetAnalysis command supports the following analysis types:

Flowchart Analysis (0)

Variation Analysis in the Chart Mode (1)

Path Analysis (3)

Event Type Analysis in the Chart Mode (4)

Case Analysis (5)

Event Analysis (6)

Event Type Analysis in the Table Mode (7)

Variation Analysis in the Table Mode (8)

Duration Analysis (9)

Profiling Analysis (10)

User Report (11)

Operation Log Analysis (12)

Flow Analysis (13)

Influence Analysis (14)

Data Table Analysis (18)

Model Report (21)

Project Report (22)

Data Table Report (23)

Script Report (24)

Note that for the analysis types Model Report, Project Report, Data Table Report and Script Report, the information related to deleted models/projects/data tables/scripts is not shown by default but can be configured with parameters to be shown. For more information, see the parameters 'GetAll', 'IncludeDeletedProjects' and 'DeletedModelsOnly' in the list of analysis parameters.

'TargetTable'

The temporary table to which the analysis is to be stored. Note that only table format analyses can be stored to a temporary table.

You can define the 'TargetTable' when using the following analysis types:

- Case Analysis

- Event Analysis

- Event Type Analysis

- Variation Analysis

- User Permissions

- Operation Log

- Flow Analysis

- Influence Analysis

- Integration Table

- Model Report

- Project Report

- Data Table Report

- Script Report

'Show'

Optional. If TRUE or 1, the analysis is opened after the script is run.

'Title'

Optional. The title for the Excel sheet created when Show is TRUE or 1. Default value is the name of the analysis type.

'SheetName', '<Value>'

Optional. The name of the Excel sheet created when Show is TRUE or 1. Default value is the name of the analysis type.

'CatchOperationExceptions', '<Value>'

Optional. Defines whether to stop the script execution or to continue to run the script from the next statement if an exception occurs when running the script:

1 = don't stop execution of the script, continue running the script from the next statement.

0 = stop execution of the current script and show the exception.

The following script variables will be set and are shown in the script log:

@_ExceptionOccurred If there was an exception, then this value is 1, otherwise 0. INT

@_ExceptionType If there was an exception, shows the C# class name for the exception, NVARCHAR(MAX), otherwise NULL.

@_ExceptionMessage If there was an exception, contains a message that would have been displayed, NVARCHAR(MAX), otherwise NULL.

@_ExceptionDetails If there was an exception, contains the details that would have been displayed, including the system stack trace, NVARCHAR(MAX), otherwise NULL.

Examples

The following example will get an Event analysis, open that analysis with "Analysis Title" as the title on a sheet named "Example Sheet Name", and store the Event analysis results to the "#ExampleTable" data table.

(SELECT 'AnalysisType', '6') UNION ALL
(SELECT 'MaximumCount', '0') UNION ALL
(SELECT 'FilterId', '3') UNION ALL
(SELECT 'SelectedEventAttributes', '*') UNION ALL
(SELECT 'Show', '1') UNION ALL
(SELECT 'Title', 'Analysis Title') UNION ALL
(SELECT 'SheetName', 'Excel Sheet Name') UNION ALL
(SELECT 'TargetTable', '#ExampleTable')
--#GetAnalysis

The following example will get a Model Report analysis, store the analysis results to a temporary table called "#ModelResult" and show the results on an Excel sheet. This table contains the same information as is visible in the Project Workspace. For explanations of the columns, see Models.

(SELECT 'AnalysisType', '21') UNION ALL
(SELECT 'Show', '1') UNION ALL
(SELECT 'TargetTable', '#ModelResult')
--#GetAnalysis

The following example will get a Project Report analysis, store the analysis results to a temporary table called "#ProjectResult" and show the results on an Excel sheet. This table contains the same information as is visible in the Project Workspace. For explanations of the columns, see Models.

(SELECT 'AnalysisType', '22') UNION ALL
(SELECT 'Show', '1') UNION ALL
(SELECT 'TargetTable', '#ProjectResult')
--#GetAnalysis

The following example will get a Data Table Report analysis, store the analysis results to a temporary table called "#DataTableResult" and show the results on an Excel sheet. This table contains the same information as is visible in the Project Workspace. For explanations of the columns, see Data Tables.

(SELECT 'AnalysisType', '23') UNION ALL
(SELECT 'Show', '1') UNION ALL
(SELECT 'TargetTable', '#DataTableResult')
--#GetAnalysis

The following example will get a Script Report analysis, store the analysis results to a temporary table called "#ScriptResult" and show the results on an Excel sheet. This table contains the same information as is visible in the Script Manager. For explanations of the columns, see Script Manager.

(SELECT 'AnalysisType', '24') UNION ALL
(SELECT 'Show', '1') UNION ALL
(SELECT 'TargetTable', '#ScriptResult')
--#GetAnalysis

--#ImportCaseAttributes

Loads Case Attributes from the data which the preceding SQL statements given as parameters provide into the specified model. This command takes two SELECT queries as parameters.

First Query

Configures the command using a SELECT statement returning two columns: the first column is for a key and the second one is for a value of that key. The values in both the key column and in the value column are of type NVARCHAR. The supported keys for this command are:

'ProjectId' or 'ProjectName'

The id or the name of the project in which the target model exists. Defaults to the current project. If the given ProjectName doesn't exist, a new project is created.

'ModelId' or 'ModelName'

The id or the name of the existing/new target model. Defaults to the current model. If ModelId is given, neither ProjectId nor ProjectName are used. If the given ModelName doesn't exist, a new model is created.

'Append'

Defines what to do with an existing target model case attributes. TRUE or any other Integer than "0" = the existing case attributes in the target model are not deleted before import, FALSE or "0" = the existing case attributes of the target model are deleted before the import. If the target model is set to use another model as the Case Attribute Model, those case attributes are not deleted. Not used when creating a new model. Default value is TRUE.

'CatchOperationExceptions'

Optional. Defines whether to stop the script execution or to continue to run the script from the next statement if an exception occurs when running the script:

1 = don't stop execution of the script, continue running the script from the next statement.

0 = stop execution of the current script and show the exception.

The following script variables will be set and are shown in the script log:

@_ExceptionOccurred If there was an exception, then this value is 1, otherwise 0. INT

@_ExceptionType If there was an exception, shows the C# class name for the exception, NVARCHAR(MAX), otherwise NULL.

@_ExceptionMessage If there was an exception, contains a message that would have been displayed, NVARCHAR(MAX), otherwise NULL.

@_ExceptionDetails if there was an exception, contains the details that would have been displayed, including the system stack trace, NVARCHAR(MAX), otherwise NULL.

Second Query

'<data>'

The database query whose results are to be imported. Note that the geometry, geography, hierarchyid, and image SQL data types are not supported by the ImportCaseAttributes command.

--#ImportDataTable

Imports data to a Data Table. This command takes two SELECT queries as parameters.

First Query

Configures the command using a SELECT statement returning two columns: the first column is for a key and the second one is for a value of that key. The values in both the key column and in the value column are of type NVARCHAR. The supported keys for this command are:

'ProjectId' or 'ProjectName'

The id or the name of the project in which the target data table exists.

'DataTableId' or 'DataTableName'

The id or the name of the existing/new target data table.

'Append'

Defines what to do with an existing target data table contents. TRUE or any other Integer than "0" = the existing contents in the target data table are not deleted before import, FALSE or "0" = the existing contents of the target data table are deleted before the import. Not used when creating a new data table.

'CatchOperationExceptions'

Optional. Defines whether to stop the script execution or to continue to run the script from the next statement if an exception occurs when running the script:

1 = don't stop execution of the script, continue running the script from the next statement.

0 = stop execution of the current script and show the exception.

The following script variables will be set and are shown in the script log:

@_ExceptionOccurred If there was an exception, then this value is 1, otherwise 0. INT

@_ExceptionType If there was an exception, shows the C# class name for the exception, NVARCHAR(MAX), otherwise NULL.

@_ExceptionMessage If there was an exception, contains a message that would have been displayed, NVARCHAR(MAX), otherwise NULL.

@_ExceptionDetails If there was an exception, contains the details that would have been displayed, including the system stack trace, NVARCHAR(MAX), otherwise NULL.

Second Query

'<data>'

The database query whose results are to be imported. Note that if the query doesn't return any data, the data table is not created.

Examples

The following example will load data from a model and put it into the "AnalysisResult" table and then add that data to the "ExampleTable" data table, and catch exceptions.

SELECT 'START'
--#WriteLog

(SELECT 'AnalysisType', '6') UNION ALL
(SELECT 'MaximumCount', '0') UNION ALL
(SELECT 'FilterId', '3') UNION ALL
(SELECT 'SelectedEventAttributes', '*') UNION ALL
(SELECT 'TargetTable', '#AnalysisResult') UNION ALL
(SELECT 'CatchOperationExceptions', '1')
--#GetAnalysis

SELECT 'DataLoaded'
--#WriteLog

SELECT count(*) from [#AnalysisResult]
--#WriteLog

(SELECT 'ProjectId', '1') UNION ALL
(SELECT 'DataTableName', 'ExampleTable') UNION ALL
(SELECT 'Append', '1')
(SELECT * FROM [#AnalysisResult])
--#ImportDataTable

The following example will load data from the "ExampleTable" data table in the "ExampleProject" project, put that data into the "CSV1" table and then show the contents of the "CSV" table. In effect, it shows the contents of the "ExampleTable" data table.

(SELECT 'AnalysisType', '18') UNION ALL 
(SELECT 'ProjectName', 'ExampleProject') UNION ALL
(SELECT 'MaximumCount', '0') UNION ALL
(SELECT 'DataTableName', 'ExampleTable') UNION ALL 
(SELECT 'TargetTable', '#CSV1') 
--#GetAnalysis

(SELECT * FROM #CSV1) 
(SELECT 'Title', 'CSV Table') UNION ALL 
(SELECT 'MaximumCount', '0')
--#ShowReport

--#ImportEvents

Loads Events from the data which the preceding SQL statements given as parameters provide into the specified model. This command takes two SELECT queries as parameters.

First Query

Configures the command using a SELECT statement returning two columns: the first column is for a key and the second one is for a value of that key. The values in both the key column and in the value column are of type NVARCHAR. The supported keys for this command are:

'ProjectId' or 'ProjectName'

The id or the name of the project in which the target model exists. Defaults to the current project. If the given ProjectName doesn't exist, a new project is created.

'ModelId' or 'ModelName'

The id or the name of the existing/new target model. Defaults to the current model. If ModelId is given, neither ProjectId nor ProjectName are used. If the given ModelName doesn't exist, a new model is created.

'Append'

Defines what to do with the existing target model events. TRUE or any other Integer than "0" = the existing events in the target model are not deleted before import, FALSE or "0" = the existing events of the target model are deleted before the import. Not used when creating a new model. Default value is TRUE.

'CatchOperationExceptions'

Optional. Defines whether to stop the script execution or to continue to run the script from the next statement if an exception occurs when running the script:

1 = don't stop execution of the script, continue running the script from the next statement.

0 = stop execution of the current script and show the exception.

The following script variables will be set and are shown in the script log:

@_ExceptionOccurred If there was an exception, then this value is 1, otherwise 0. INT

@_ExceptionType If there was an exception, shows the C# class name for the exception, NVARCHAR(MAX), otherwise NULL.

@_ExceptionMessage If there was an exception, contains a message that would have been displayed, NVARCHAR(MAX), otherwise NULL.

@_ExceptionDetails If there was an exception, contains the details that would have been displayed, including the system stack trace, NVARCHAR(MAX), otherwise NULL.

Second Query

'<data>'

The database query whose results are to be imported. Note that the geometry, geography, hierarchyid, and image SQL data types are not supported by the ImportEvents command.

--#ImportOdbcQuery

Extracts data directly from the ODBC data source and imports it to QPR ProcessAnalyzer Data Table or QPR ProcessAnalyzer temporary table. Column names are parsed from the query result. If a column name contains illegal characters for table names, the illegal characters are converted to be underscore characters. Columns are extracted as text data.

Parameters

The parameters defined in the SQL SELECT statements in the order they are listed below:

Data Destination

'TargetTable', '<#TableName>'

The temporary table to which the data is to be imported. If not used, define the target using the ProjectId/ProjectName, DataTableId/DataTableName, and Append parameters described below.

'ProjectId' or 'ProjectName', '<Value>'

The id or the name of the project in which the target data table exists.

'DataTableId' or 'DataTableName', '<Value>'

The id or the name of the existing/new target data table.

'Append', '<Value>'

Defines what to do with an existing target data table contents. TRUE or any other Integer than "0" = the existing contents in the target data table are not deleted before import, FALSE or "0" = the existing contents of the target data table are deleted before the import. Not used when creating a new data table.

'CatchOperationExceptions', '<Value>'

Optional. Defines whether to stop the script execution or to continue to run the script from the next statement if an exception occurs when running the script:

1 = don't stop execution of the script, continue running the script from the next statement.

0 = stop execution of the current script and show the exception.

The following script variables will be set and are shown in the script log:

@_ExceptionOccurred: if there was an exception, then this value is 1, otherwise 0. INT

@_ExceptionType: if there was an exception, shows the C# class name for the exception, NVARCHAR(MAX), otherwise NULL.

@_ExceptionMessage: if there was an exception, contains a message that would have been displayed, NVARCHAR(MAX), otherwise NULL.

@_ExceptionDetails: if there was an exception, contains the details that would have been displayed, including the system stack trace, NVARCHAR(MAX), otherwise NULL.

ODBC specific parameters

'OdbcConnectionString', '<Value>'

The ODBC driver connection string that includes the settings needed to establish the initial connection. Mandatory. See OdbcConnection.ConnectionString Property in Microsoft Development Network for more information on the possible connection strings. You can also configure a data source name for connecting to QPR ProcessAnalyzer, for instructions see How to Configure an ODBC Data Source Name for Connecting to QPR ProcessAnalyzer.

'OdbcQueryString', '<Value>'

The SQL query string. Mandatory. Note that if the query doesn't return any data, the target data table or temporary table is not created.

'ExecuteInClientSide', '<Value>'

Defines whether the command is executed in the client side or in the server side when using QPR ProcessAnalyzer Pro. This parameter is used when there is no server connection available, for example. TRUE or any other Integer than "0" = the import query is executed in the client side. FALSE or "0" = the import query is executed in the server side. Not used with QPR ProcessAnalyzer Xpress or QPR ProcessAnalyzer Database as they always execute the command in the client side. Supports only data table as the import destination. If 'TargetTable' has been defined as the import destination and the value of this parameter is given as TRUE or any other Integer than "0", you will receive an error message. Optional. Default value is FALSE.

Example

The following script extracts data from an ODBC using a data source name configured as described in the link above and selects all columns from the table PA_MODEL, and catches exceptions.

(SELECT 'OdbcConnectionString', 'DSN=PA_EXPRESS_40') UNION ALL
(SELECT 'OdbcQueryString', 'SELECT * FROM PA_MODEL') UNION ALL
(SELECT 'TargetTable', '#ImportOdbcTable') UNION ALL
(SELECT 'Append', '1') UNION ALL
(SELECT 'CatchOperationExceptions', '1')
--#ImportOdbcQuery

---

--#ImportOleDbQuery

Extracts data from an OLE DB source and imports it to QPR ProcessAnalyzer Data Table or QPR ProcessAnalyzer temporary table. Column names are parsed from the query result. It is possible to both create new Data Tables as well as modify existing Data Tables with this command.

Parameters

The parameters defined in the SQL SELECT statements in the order they are listed below:

Data Destination

'TargetTable', '<#TableName>'

The temporary table to which the data is to be imported. If not used, define the target using the ProjectId/ProjectName, DataTableId/DataTableName, and Append parameters described below.

'ProjectId' or 'ProjectName', '<Value>'

The id or the name of the project in which the target data table exists.

'DataTableId' or 'DataTableName', '<Value>'

The id or the name of the existing/new target data table.

'Append', '<Value>'

Defines what to do with an existing target data table contents. TRUE or any other Integer than "0" = the existing contents in the target data table are not deleted before import, FALSE or "0" = the existing contents of the target data table are deleted before the import. Not used when creating a new data table.

'CatchOperationExceptions', '<Value>'

Optional. Defines whether to stop the script execution or to continue to run the script from the next statement if an exception occurs when running the script:

1 = don't stop execution of the script, continue running the script from the next statement.

0 = stop execution of the current script and show the exception.

The following script variables will be set and are shown in the script log:

@_ExceptionOccurred: if there was an exception, then this value is 1, otherwise 0. INT

@_ExceptionType: if there was an exception, shows the C# class name for the exception, NVARCHAR(MAX), otherwise NULL.

@_ExceptionMessage: if there was an exception, contains a message that would have been displayed, NVARCHAR(MAX), otherwise NULL.

@_ExceptionDetails: if there was an exception, contains the details that would have been displayed, including the system stack trace, NVARCHAR(MAX), otherwise NULL.

OLE DB Query Parameters

'OleDbConnectionString', '<Value>'

The OLE DB connection string that includes the settings needed to establish the initial connection. Mandatory. See OleDbConnection.ConnectionString Property in Microsoft Development Network for more information on the possible connection strings.

'OleDbQueryString', '<Value>'

The SQL query string. Mandatory. Note that if the query doesn't return any data, the target data table or temporary table is not created.

'ExecuteInClientSide', '<Value>'

Defines whether the command is executed in the client side or in the server side when using QPR ProcessAnalyzer Pro. This parameter is used when there is no server connection available, for example. TRUE or any other Integer than "0" = the import query is executed in the client side. FALSE or "0" = the import query is executed in the server side. Not used with QPR ProcessAnalyzer Xpress or QPR ProcessAnalyzer Database as they always execute the command in the client side. Supports only data table as the import destination. If 'TargetTable' has been defined as the import destination and the value of this parameter is given as TRUE or any other Integer than "0", you will receive an error message. Optional. Default value is FALSE.

Example

The following example will load data from an OLE DB source (a sample database called DB1) and selects all columns from the table EXAMPLE. It will then put that data into the "#TABLE" temporary table and then show the contents of that table, and catch exceptions.

(SELECT 'OleDbConnectionString', 'Provider=SQLOLEDB;Data Source=(local);Initial Catalog=DB1;Integrated Security=SSPI;') UNION ALL
(SELECT 'OleDbQueryString', 'SELECT * FROM EXAMPLE') UNION ALL
(SELECT 'TargetTable', '#TABLE') UNION ALL
(SELECT 'Append', '1') UNION ALL
(SELECT 'CatchOperationExceptions', '1')
--#ImportOleDbQuery

(SELECT * FROM #TABLE) UNION ALL
(SELECT 'MaximumCount', '0') UNION ALL
(SELECT 'CatchOperationExceptions', '1')
--#ShowReport

Example

The following example will load all the columns from "EXAMPLE" table from an OLE DB source and will put that data into the "ExampleDataTable" in the "ExampleProject" project. It will then get the Data Table analysis from the "ExampleDataTable", put that into the "#TABLE" temporary table and then show the contents of that table.

(SELECT 'ProjectName', 'ExampleProject') UNION ALL 
(SELECT 'DataTableName', 'ExampleDataTable') UNION ALL 
(SELECT 'Append', '0') UNION ALL 
(SELECT 'OleDbConnectionString', 'Provider=SQLOLEDB;Data Source=(local);Initial Catalog=DB1;Integrated Security=SSPI;') UNION ALL 
(SELECT 'OleDbQueryString', 'SELECT * FROM EXAMPLE') 
--#ImportOleDbQuery

(SELECT 'AnalysisType', '18') UNION ALL
(SELECT 'ProjectName', 'ExampleProject') UNION ALL 
(SELECT 'MaximumCount', '0') UNION ALL 
(SELECT 'DataTableName', 'ExampleDataTable') UNION ALL 
(SELECT 'TargetTable', '#TABLE') 
--#GetAnalysis 

(SELECT * FROM #TABLE) 
(SELECT 'MaximumCount', '0') 
--#ShowReport 

---

--#ImportSalesforceQuery

Extracts data from Salesforce cloud and imports it into a data table as NVARCHAR(MAX) or SQL_VARIANT type data. Note that this command requires the Salesforce username and password to be visible in the script!

Parameters

The parameters defined in the SQL SELECT statements in the order they are listed below:

Data Destination

'TargetTable', '<#TableName>'

The temporary table to which the data is to be imported. If not used, define the target using the ProjectId/ProjectName, DataTableId/DataTableName, and Append parameters described below.

'ProjectId' or 'ProjectName', '<Value>'

The id or the name of the project in which the target data table exists.

'DataTableId' or 'DataTableName', '<Value>'

The id or the name of the existing/new target data table.

'Append', '<Value>'

Defines what to do with an existing target data table contents. TRUE or any other Integer than "0" = the existing contents in the target data table are not deleted before import, FALSE or "0" = the existing contents of the target data table are deleted before the import. Not used when creating a new data table.

'CatchOperationExceptions', '<Value>'

Optional. Defines whether to stop the script execution or to continue to run the script from the next statement if an exception occurs when running the script:

1 = don't stop execution of the script, continue running the script from the next statement.

0 = stop execution of the current script and show the exception.

The following script variables will be set and are shown in the script log:

@_ExceptionOccurred: if there was an exception, then this value is 1, otherwise 0. INT

@_ExceptionType: if there was an exception, shows the C# class name for the exception, NVARCHAR(MAX), otherwise NULL.

@_ExceptionMessage: if there was an exception, contains a message that would have been displayed, NVARCHAR(MAX), otherwise NULL.

@_ExceptionDetails: if there was an exception, contains the details that would have been displayed, including the system stack trace, NVARCHAR(MAX), otherwise NULL.

Salesforce Query Parameters

'SalesforceUser', '<Value>'

Username for the Salesforce cloud.

'SalesforcePW', '<Value>'

Password for the Salesforce cloud.

'SalesforceQueryMode', '<Value>'

Optional. The Salesforce query function to be used. 1 (default) = queryall(), 2 = query(), 3 = describeSObject().

'SalesforceQuery', '<Value>'

The query to be run in the Salesforce cloud. Note that "*" cannot be used in the query. See Salesforce API and SOQL Reference for more information. Note that if the query doesn't return any data, the target data table or temporary table is not created.

'SalesforceQueryRetries', '<Value>'

Optional. Number of retries to attempt if the Salesforce query doesn't succeed. Default value is 3.

'SalesforceQueryRetryWait', '<Value>'

Optional. Number of milliseconds to wait between query retries. Default is 3000 ms.

'SalesforceBatchSize', '<Value>'

Optional. The number of rows of data the query returns in one batch. Minimum = 200, Maximum = 2000, Default = 500. See Salesforce API for more information.

Example

The following example will load date data from the "Contact" table in the Salesforce cloud and put that data into the "ExampleDataTable" data table in the "ExampleProject" project, and catch exception when loading the data. It will then get the Data Table analysis from the "ExampleDataTable", put that into the "#TABLE" temporary table and then show the contents of that table.

(SELECT 'ProjectName', 'ExampleProject') UNION ALL
(SELECT 'DataTableName', 'ExampleDataTable') UNION ALL
(SELECT 'Append', '0') UNION ALL
(SELECT 'SalesforceUser', 'example.user@qpr.com')  UNION ALL
(SELECT 'SalesforcePW', 'examplepassword')  UNION ALL
(SELECT 'SalesforceQuery', 'SELECT CreatedDate FROM Contact') UNION ALL
(SELECT 'CatchOperationExceptions', '1')
--#ImportSalesforceQuery

(SELECT 'AnalysisType', '18') UNION ALL 
(SELECT 'ProjectName', 'ExampleProject') UNION ALL
(SELECT 'MaximumCount', '0') UNION ALL 
(SELECT 'DataTableName', 'ExampleDataTable') UNION ALL 
(SELECT 'TargetTable', '#TABLE') 
--#GetAnalysis 

(SELECT * FROM #TABLE) 
(SELECT 'MaximumCount', '0') 
--#ShowReport 

---

--#ImportSapQuery

Extracts data from SAP and imports it to QPR ProcessAnalyzer Data Table or QPR ProcessAnalyzer temporary table. Column names are parsed from the query result. If a column name contains illegal characters for table names, the illegal characters are converted to be underscore characters, e.g. "sap:Owner" -> "sap_Owner". Columns are extracted as text data. Note that using this command requires some dlls not provided by QPR Software.

Parameters

The parameters defined in the SQL SELECT statements in the order they are listed below.

Destination Parameters:

'TargetTable', '<#TableName>'

If this parameter is given, store the results into a temporary SQL table in ETL sandbox.

If the TargetTable parameter is not given, use the following destination parameters:

'ProjectId' or 'ProjectName', '<Value>'

The id or the name of the project in which the target data table exists.

'DataTableId' or 'DataTableName', '<Value>'

The id or the name of the existing/new target data table.

'Append', '<Value>'

Defines what to do with an existing target data table contents. TRUE or any other Integer than "0" = the existing contents in the target data table are not deleted before import, FALSE or "0" = the existing contents of the target data table are deleted before the import. Not used when creating a new data table.

'CatchOperationExceptions', '<Value>'

Optional. Defines whether to stop the script execution or to continue to run the script from the next statement if an exception occurs when running the script:

1 = don't stop execution of the script, continue running the script from the next statement.

0 = stop execution of the current script and show the exception.

The following script variables will be set and are shown in the script log:

@_ExceptionOccurred: if there was an exception, then this value is 1, otherwise 0. INT

@_ExceptionType: if there was an exception, shows the C# class name for the exception, NVARCHAR(MAX), otherwise NULL.

@_ExceptionMessage: if there was an exception, contains a message that would have been displayed, NVARCHAR(MAX), otherwise NULL.

@_ExceptionDetails: if there was an exception, contains the details that would have been displayed, including the system stack trace, NVARCHAR(MAX), otherwise NULL.

SAP Connection Parameters:

'SapUser', '<Username>'

SAP user used to connect to SAP. Mandatory. Corresponds to the "USER" constant on SAP side. See the SAP .NET Connector documentation for more info.

'SapPW', '<Password>'

Password of the SAP user used to connect to SAP. Mandatory. Corresponds to the "PASSWD" constant on SAP side. See the SAP .NET Connector documentation for more info.

'SapClient', '<Value>'

The SAP backend client. Mandatory. Corresponds to the "CLIENT" constant on SAP side. See the SAP .NET Connector documentation for more info.

'SapAppServerHost', '<Hostname or IP>'

The hostname or IP of the specific SAP application server, to which all connections shall be opened. Mandatory if SapMessageServerHost is not defined. Corresponds to the "ASHOST" constant on SAP side. See the SAP .NET Connector documentation for more info.

'SapMessageServerHost', '<Hostname or IP>'

The hostname or IP of the SAP system’s message server (central instance). Mandatory if SapAppServerHost is not defined. Corresponds to the "MSHOST" constant on SAP side. See the SAP .NET Connector documentation for more info.

'SapSystemNumber', '<Value>'

The SAP system’s system number. Mandatory if SapSystemID is not defined. Corresponds to the "SYSNR" constant on SAP side. See the SAP .NET Connector documentation for more info.

'SapSystemID', '<Value>'

The SAP system’s three-letter system ID. Mandatory if SapSystemNumber is not defined. Corresponds to the "SYSID" constant on SAP side. See the SAP .NET Connector documentation for more info.

'ExecuteInClientSide', '<Value>'

Defines whether the command is executed in the client side or in the server side when using QPR ProcessAnalyzer Pro. This parameter is used when there is no server connection available, for example. TRUE or any other Integer than "0" = the import query is executed in the client side. FALSE or "0" = the import query is executed in the server side. Not used with QPR ProcessAnalyzer Xpress or QPR ProcessAnalyzer Database as they always execute the command in the client side. Supports only data table as the import destination. If 'TargetTable' has been defined as the import destination and the value of this parameter is given as TRUE or any other Integer than "0", you will receive an error message. Optional. Default value is FALSE.

Other SAP Parameters:

'SapLanguage', '<Value>'

SAP language used. Default value is "EN". Optional. Corresponds to the "LANG" constant on SAP side. See the SAP .NET Connector documentation for more info.

'SapPoolSize', '<Number>'

The maximum number of RFC connections that this destination will keep in its pool. Default value is "5". Optional. Corresponds to the "POOL_SIZE" constant on SAP side. See the SAP .NET Connector documentation for more info.

'SapPeakConnectionsLimit', '<Value>'

In order to prevent an unlimited number of connections to be opened, you can use this parameter. Default value is "10". Optional. Corresponds to the "MAX_POOL_SIZE" constant on SAP side. See the SAP .NET Connector documentation for more info.

'SapConnectionIdleTimeout', '<Value>'

If a connection has been idle for more than SapIdleTimeout seconds, it will be closed and removed from the connection pool upon checking for idle connections or pools. Default value is "600". Optional. Corresponds to the "IDLE_TIMEOUT" constant on SAP side. See the SAP .NET Connector documentation for more info.

'SapRouter', '<List>'

A list of host names and service names / port numbers for the SAPRouter in the following format: /H/hostname/S/portnumber. Optional. Corresponds to the "SAPROUTER" constant on SAP side. See the SAP .NET Connector documentation for more info.

'SapLogonGroup', '<Value>'

The logon group from which the message server shall select an application server. Optional. Corresponds to the "GROUP" constant on SAP side. See the SAP .NET Connector documentation for more info.

'SapQueryMode', '<Number>'

If this is set to "1", then the query result will have the SAP Table field names as data table column names and actual data rows as rows. If this is set to "3", the query result will get the field descriptions from the SAP query using NO_DATA parameter, i.e. the returned columns are the following (in this order): Field, Type, Description, Length, Offset. Default value is "1". Optional. See the SAP .NET Connector documentation for more info.

'SapQueryTable', '<Name>'

Name of the SAP table to be extracted. Specifies the value for the parameter QUERY_TABLE in tab: 'Import' or function module 'rfc_read_table' in SAP. Mandatory. See the SAP .NET Connector documentation for more info. Note that if the query doesn't return any data, the target data table or temporary table is not created.

'SapRowcount', '<Value>'

The maximum amount of rows to fetch. Specifies the value for parameter ROWCOUNT in tab: 'Import' or function module 'rfc_read_table' in SAP. Optional. See the SAP .NET Connector documentation for more info.

'SapRowskips', '<Value>'

The amount of rows to skip. Specifies the value for parameter ROWSKIPS in tab: 'Import' or function module 'rfc_read_table'. in SAP. Optional. See the SAP .NET Connector documentation for more info.

'SapWhereClause', '<List>'

A comma separated list of WHERE clause elements passed for the SapQueryTable. Can be used with or without the SapWhereClauseSelect parameter. If used together with the SapWhereClauseSelect parameter, use the SapWhereClause parameter first. NOTE: The default maximum length for the Where Clause string is 72 characters in SAP, so the recommended maximum length of the SapWhereClause value is also 72 characters. In effect, specifies the value for parameter OPTIONS in tab: 'Import' or function module 'rfc_read_table' in SAP. Optional. See the SAP .NET Connector documentation for more info.

'SapWhereClauseSelect', '<SELECT query to be executed>'

The SELECT query to be executed in QPR ProcessAnalyzer sandbox. Used with or without the SapWhereClause parameter to pass WHERE clauses to SapQueryTable. If used together with the SapWhereClause parameter, use the SapWhereClause parameter first. The query is expected to return a table with at least one column, as the contents from the rows in the first column of the table are concatenated together to form the WHERE clause in SAP RFC_ReadTable. Therefore, it's recommended to first create the table with the WHERE clauses into a temporary table. In addition, it's recommended to have an order number column in the table and use that in the SELECT query to make sure the WHERE clause elements are concatenated in the correct order. The default maximum length for Where Clause string is 72 characters in SAP, so the recommended maximum length for the WHERE clause string in each row of the table is also 72. In effect, specifies the value for parameter OPTIONS in tab: 'Import' or function module 'rfc_read_table' in SAP. Optional. The contents up to the first 10 rows in the first column of the SELECT query are shown in the QPR ProcessAnalyzer Script Log. See the SAP .NET Connector documentation for more info.

'SapFieldNames', '<List>'

A comma separated list of field names for columns to be imported. Default value is empty, resulting in all columns being imported. Specifies the value for parameter FIELDNAME in tab: 'Tables' for table 'FIELDS' for function module 'rfc_read_table' in SAP. Optional. See the SAP .NET Connector documentation for more info.

'SapFunction', '<Value>'

If you define a value for this parameter, then the new value specifies the SAP function that is called inside the #ImportSapQuery command. Optional. The default value is RFC_READ_TABLE. Another possible value is BBP_RFC_READ_TABLE. See the SAP .NET Connector documentation for more info.

Example

The following script will get the "VBELN", "ERDAT", "ERZET", "ERNAM", "NETWR", and "WAERK" columns from the "VBAK" table in a SAP system and put them into a data table named "SapQueryTableExample", and catch exceptions when getting the data.

(SELECT 'ProjectName', 'ImportSapQueryExample') UNION ALL
(SELECT 'DataTableName', 'SapQueryTableExample') UNION ALL
(SELECT 'Append', 'TRUE') UNION ALL
(SELECT 'SapUser', 'exampleuser') UNION ALL
(SELECT 'SapPW', 'examplepassword') UNION ALL
(SELECT 'SapClient', '200') UNION ALL
(SELECT 'SapAppServerHost', '127.0.0.1') UNION ALL
(SELECT 'SapSystemNumber', '10') UNION ALL
(SELECT 'SapLanguage', 'EN') UNION ALL
(SELECT 'SapPoolSize', '5') UNION ALL
(SELECT 'SapPeakConnectionsLimit', '10') UNION ALL
(SELECT 'SapConnectionIdleTimeout', '600') UNION ALL
(SELECT 'SapRouter', '/H/127.0.0.1/A/1234/H/') UNION ALL
(SELECT 'SapLogonGroup', 'GROUPXNAME') UNION ALL
(SELECT 'SapQueryMode', '1') UNION ALL
(SELECT 'SapQueryTable', 'VBAK') UNION ALL
(SELECT 'SapDelimiter', '|') UNION ALL
(SELECT 'SapRowcount', '0') UNION ALL
(SELECT 'SapRowskips', '0') UNION ALL
(SELECT 'SapWhereClause', 'VBELN EQ `0060000039`, OR VBELN EQ `0060000040`') UNION ALL
(SELECT 'SapFieldNames', 'VBELN,ERDAT,ERZET,ERNAM,NETWR,WAERK') UNION ALL
(SELECT 'CatchOperationExceptions', '1')
--#ImportSapQuery

Example

The following script will extract values for the VBELN field from the VBAK table where the value of the VBELN field is between 0060000039` and `0060000041. It will also catch possible exceptions when getting the data and print out them on a separate sheet. The extracted data is also shown on its own sheet:

(SELECT 'CatchOperationExceptions', '1') UNION ALL
(SELECT 'SapAppServerHost', '127.0.0.1') UNION ALL
(SELECT 'SapSystemNumber', '10') UNION ALL
(SELECT 'SapUser', 'qpr') UNION ALL
(SELECT 'SapPW', 'demo') UNION ALL
(SELECT 'SapRouter', '') UNION ALL
(SELECT 'SapClient', '200') UNION ALL
(SELECT 'SapLanguage', 'EN') UNION ALL
(SELECT 'SapPoolSize', '5') UNION ALL
(SELECT 'SapPeakConnectionsLimit', '10') UNION ALL
(SELECT 'SapConnectionIdleTimeout', '600') UNION ALL
(SELECT 'ExecuteInClientSide', '1') UNION ALL
(SELECT 'TargetTable', '#SAPmode1') UNION ALL
(SELECT 'Append', '0') UNION ALL
(SELECT 'SapWhereClause', 'VBELN BETWEEN `0060000039` AND `0060000041`') UNION ALL
(SELECT 'SapQueryTable', 'VBAK')
--#ImportSapQuery

DECLARE @_SuccessOrNot as NVARCHAR(MAX);
SET @_SuccessOrNot = CASE @_ExceptionOccurred
WHEN 1 THEN
'Exception(s) occurred!'
ELSE
'SAP import OK.'
END

SELECT 
@_SuccessOrNot as Result,
@_ExceptionOccurred as ExceptionOccurred, 
@_ExceptionType as ExceptionType, 
@_ExceptionMessage as ExceptionMessage,
@_ExceptionDetails as ExceptionDetails
(SELECT 'SheetName' , 'ExceptionData')
--#ShowReport

(SELECT * FROM #SAPmode1)
(SELECT 'SheetName' , 'SAPmode1')
--#ShowReport

Example

The following script will return the values for the VBELN, ERDAT, ERZET, ERNAM, NETWR, and WAERK fields from the VBAK table where the value of the VBELN field is between 0060000039 and 0060000041:

/* First, create the temporary table that holds the WHERE clause. */
CREATE TABLE #SapWhereClauseTable (sap_select_string varchar(255), order_number int)
INSERT INTO #SapWhereClauseTable SELECT 'VBELN BETWEEN ''0060000039''', 1
INSERT INTO #SapWhereClauseTable SELECT 'AND ''0060000041''', 2

/* Specify the target for the data that the script extracts from SAP */
(SELECT 'TargetTable', '#SAPmode1') UNION ALL
(SELECT 'Append', '0') UNION ALL

/* Define the SAP connection parameters */
(SELECT 'SapAppServerHost', '127.0.0.1') UNION ALL
(SELECT 'SapSystemNumber', '10') UNION ALL
(SELECT 'SapUser', 'exampleuser') UNION ALL
(SELECT 'SapPW', 'examplepassword') UNION ALL
(SELECT 'SapClient', '200') UNION ALL
(SELECT 'SapLanguage', 'EN') UNION ALL
(SELECT 'SapPoolSize', '5') UNION ALL
(SELECT 'SapPeakConnectionsLimit', '10') UNION ALL
(SELECT 'SapConnectionIdleTimeout', '600') UNION ALL
(SELECT 'SapFieldNames', 'VBELN,ERDAT,ERZET,ERNAM,NETWR,WAERK') UNION ALL

/* Use the WHERE clause defined in the temporary table */
(SELECT 'SapWhereClauseSelect', 'SELECT * from #SapWhereClauseTable ORDER BY order_number') UNION ALL
(SELECT 'SapQueryTable', 'VBAK') 
--#ImportSapQuery

/* Show the results */
(SELECT * FROM #SAPmode1)
(SELECT 'SheetName' , 'SAPmode1')
--#ShowReport

Example

The following script will get the "VBELN", "ERDAT", "ERZET", "ERNAM", "NETWR", and "WAERK" columns from the "VBAK" table where the value of the VBELN field is between 0060000039 and 0060000041 and put them into a data table named "SapQueryTableExample". The query is made on the client side.

/* First, create the temporary table that holds the WHERE clause.*/ 
CREATE TABLE #SapWhereClauseTable (sap_select_string varchar(255), order_number int)
INSERT INTO #SapWhereClauseTable SELECT 'VBELN BETWEEN ''0060000039''', 1
INSERT INTO #SapWhereClauseTable SELECT 'AND ''0060000042''', 2

/* Define that the command is executed in the client side.*/
(SELECT 'ExecuteInClientSide', 'True') UNION ALL

/* Specify the data table where the data is imported into.*/
(SELECT 'DataTableName', 'SapQueryTableExample') UNION ALL
(SELECT 'Append', '0') UNION ALL

/* Define the SAP connection parameters.*/ 
(SELECT 'SapAppServerHost', '127.0.0.1') UNION ALL
(SELECT 'SapSystemNumber', '10') UNION ALL
(SELECT 'SapUser', 'exampleuser') UNION ALL
(SELECT 'SapPW', 'examplepassword') UNION ALL
(SELECT 'SapRouter', '') UNION ALL
(SELECT 'SapClient', '200') UNION ALL
(SELECT 'SapLanguage', 'EN') UNION ALL
(SELECT 'SapPoolSize', '5') UNION ALL
(SELECT 'SapPeakConnectionsLimit', '10') UNION ALL
(SELECT 'SapConnectionIdleTimeout', '600') UNION ALL
(SELECT 'SapFieldNames', 'VBELN,ERDAT,ERZET,ERNAM,NETWR,WAERK') UNION ALL

/* Use the WHERE clause defined in the temporary table.*/ 
(SELECT 'SapWhereClauseSelect', 'SELECT sap_select_string from #SapWhereClauseTable ORDER BY order_number') UNION ALL
(SELECT 'SapQueryTable', 'VBAK')
--#ImportSapQuery

/* Create an analysis.*/ 
(SELECT 'AnalysisType', '18') UNION ALL
(SELECT 'DataTableName', 'SapQueryTableExample') UNION ALL
(SELECT 'TargetTable', '#Result')
--#GetAnalysis

/* Show the results.*/ 
SELECT * FROM #Result
--#ShowReport

---

--#ImportSqlQuery

Extracts data from an ADO.NET source (which in this case is the SQL Server database) and imports it to QPR ProcessAnalyzer Data Table or QPR ProcessAnalyzer temporary table. Column names are parsed from the query result. It is possible to both create new Data Tables as well as modify existing Data Tables with this command.

Parameters

The parameters defined in the SQL SELECT statements in the order they are listed below:

Data Destination

'TargetTable', '<#TableName>'

The temporary table to which the data is to be imported. If not used, define the target using the ProjectId/ProjectName, DataTableId/DataTableName, and Append parameters described below.

'ProjectId' or 'ProjectName', '<Value>'

The id or the name of the project in which the target data table exists.

'DataTableId' or 'DataTableName', '<Value>'

The id or the name of the existing/new target data table.

'Append', '<Value>'

Defines what to do with an existing target data table contents. TRUE or any other Integer than "0" = the existing contents in the target data table are not deleted before import, FALSE or "0" = the existing contents of the target data table are deleted before the import. Not used when creating a new data table.

'CatchOperationExceptions', '<Value>'

Optional. Defines whether to stop the script execution or to continue to run the script from the next statement if an exception occurs when running the script:

1 = don't stop execution of the script, continue running the script from the next statement.

0 = stop execution of the current script and show the exception.

The following script variables will be set and are shown in the script log:

@_ExceptionOccurred: if there was an exception, then this value is 1, otherwise 0. INT

@_ExceptionType: if there was an exception, shows the C# class name for the exception, NVARCHAR(MAX), otherwise NULL.

@_ExceptionMessage: if there was an exception, contains a message that would have been displayed, NVARCHAR(MAX), otherwise NULL.

@_ExceptionDetails: if there was an exception, contains the details that would have been displayed, including the system stack trace, NVARCHAR(MAX), otherwise NULL.

SQL Query Parameters

'SqlConnectionString', '<Value>'

The SQL connection string that includes the settings needed to establish the initial connection. Mandatory. See SqlConnection.ConnectionString Property in Microsoft Development Network for more information on the connection parameters.

'SqlQueryString', '<Value>'

The SQL query string. Mandatory. Note that if the query doesn't return any data, the target data table or temporary table is not created.

'ExecuteInClientSide', '<Value>'

Defines whether the command is executed in the client side or in the server side when using QPR ProcessAnalyzer Pro. This parameter is used when there is no server connection available, for example. TRUE or any other Integer than "0" = the import query is executed in the client side. FALSE or "0" = the import query is executed in the server side. Not used with QPR ProcessAnalyzer Xpress or QPR ProcessAnalyzer Database as they always execute the command in the client side. Supports only data table as the import destination. If 'TargetTable' has been defined as the import destination and the value of this parameter is given as TRUE or any other Integer than "0", you will receive an error message. Optional. Default value is FALSE.

Example

The following example will load data from an ADO.NET source (a sample database called DB1 on Microsoft SQL Server) and select all columns from the table EXAMPLE. It will then put that data into the "#TABLE" temporary table, catch exceptions when doing this, and then show the contents of that table.

(SELECT 'SqlConnectionString', 'Data Source=(local);Initial Catalog=DB1;Integrated Security=true') UNION ALL
(SELECT 'SqlQueryString', 'SELECT * FROM EXAMPLE') UNION ALL
(SELECT 'TargetTable', '#TABLE') UNION ALL
(SELECT 'Append', '1') UNION ALL
(SELECT 'CatchOperationExceptions', '1')
--#ImportSqlQuery

(SELECT * FROM #TABLE) 
(SELECT 'MaximumCount', '0') 
--#ShowReport 

Example

The following example will load all the columns from "EXAMPLE" table in SQL Server database and will put that data into the "ExampleDataTable" in the "ExampleProject" project. It will then get the Data Table analysis from the "ExampleDataTable", put that into the "#TABLE" temporary table and then show the contents of that table.

(SELECT 'ProjectName', 'ExampleProject') UNION ALL 
(SELECT 'DataTableName', 'ExampleDataTable') UNION ALL 
(SELECT 'Append', '0') UNION ALL 
(SELECT 'SqlConnectionString', 'Data Source=(local);Initial Catalog=DB1;Integrated Security=true') UNION ALL 
(SELECT 'SqlQueryString', 'SELECT * FROM EXAMPLE')
--#ImportSqlQuery

(SELECT 'AnalysisType', '18') UNION ALL 
(SELECT 'ProjectName', 'ExampleProject') UNION ALL 
(SELECT 'MaximumCount', '0') UNION ALL 
(SELECT 'DataTableName', 'ExampleDataTable') UNION ALL 
(SELECT 'TargetTable', '#TABLE') 
--#GetAnalysis 

(SELECT * FROM #TABLE) 
(SELECT 'MaximumCount', '0') 
--#ShowReport 

--#RemoveEvents

Removes all or specified events in the target model, but retains Cases, Event Types, and Variations. This command takes two SELECT queries as parameters.

First Query

Configures the command using a SELECT statement returning two columns: the first column is for a key and the second one is for a value of that key. The values in both the key column and in the value column are of type NVARCHAR. The supported keys for this command are:

'ProjectId' or 'ProjectName'

The id or the name of the project in which the target model exists. Defaults to the current project.

'ModelId' or 'ModelName'

The id or the name of the target model. Defaults to the current model. If ModelId is given, neither ProjectId nor ProjectName are used.

'CatchOperationExceptions'

Optional. Defines whether to stop the script execution or to continue to run the script from the next statement if an exception occurs when running the script:

1 = don't stop execution of the script, continue running the script from the next statement.

0 = stop execution of the current script and show the exception.

The following script variables will be set and are shown in the script log:

@_ExceptionOccurred If there was an exception, then this value is 1, otherwise 0. INT

@_ExceptionType If there was an exception, shows the C# class name for the exception, NVARCHAR(MAX), otherwise NULL.

@_ExceptionMessage If there was an exception, contains a message that would have been displayed, NVARCHAR(MAX), otherwise NULL.

@_ExceptionDetails If there was an exception, contains the details that would have been displayed, including the system stack trace, NVARCHAR(MAX), otherwise NULL.

Second Query

The optional database query that returns the event Id's to be removed. Note that if there are several columns in the query, the event Id's have to be in the first column of the query.

Examples

The following example will remove all events in the model with Id "22931" in the project with Id "234".

(SELECT 'ProjectId', '234') UNION ALL
(SELECT 'ModelId', '22931')
--#RemoveEvents

The following example will remove 10 first events from the model by using Event Id's from --#GetAnalysis command.

(SELECT 'AnalysisType', '6') UNION ALL
(SELECT 'MaximumCount', '10') UNION ALL
(SELECT 'ModelId', '<ModelId>') UNION ALL
(SELECT 'IncludeEventIds', 'True') UNION ALL
(SELECT 'TargetTable', '#Events')
--#GetAnalysis

(SELECT 'ModelId', '<ModelId>')
(SELECT [Event Id] from [#Events])
--#RemoveEvents

Script Log Results

When the script is run, entries similar to the following will be shown in the script log, if event Id's to be removed had been specified in the query:

Remove events for model id=41 started
Number of events in model (before): 641
Number of events to be removed: 100
Number of events removed: 10
Number of events not found: 90
Number of events in model (after): 631

In the log "Number of events to be removed" refers to the number of values (in this case 100) fetched from the first column of the query so that these values can be converted into numeric format.

In case there are no event Id's specified in the query, the script log will show the following entries:

Remove events for model id=41 started
Number of events in model (before): 621
Remove all events
Number of events in model (after): 0

--#Run

Runs another script with specified parameters. This command can take multiple SELECT queries as parameters.

First Query

Configures the command using a SELECT statement returning two columns: the first column is for a key and the second one is for a value of that key. The values in both the key column and in the value column are of type NVARCHAR. The supported keys for this command are:

'ScriptId'

Mandatory. The Id of the called script.

'CatchOperationExceptions'

Optional. Defines whether to stop the script execution or to continue to run the script from the next statement if an exception occurs when running the script:

1 = don't stop execution of the script, continue running the script from the next statement.

0 = stop execution of the current script and show the exception.

The following script variables will be set and are shown in the script log:

@_ExceptionOccurred If there was an exception, then this value is 1, otherwise 0. INT

@_ExceptionType If there was an exception, shows the C# class name for the exception, NVARCHAR(MAX), otherwise NULL.

@_ExceptionMessage If there was an exception, contains a message that would have been displayed, NVARCHAR(MAX), otherwise NULL.

@_ExceptionDetails If there was an exception, contains the details that would have been displayed, including the system stack trace, NVARCHAR(MAX), otherwise NULL.

Next Queries

The next queries are optional and used for initializing the arguments which are passed to the script to be run. The maximum number of arguments is 10. Each argument is created as a temporary table with names #_Arg1, ... #_Arg10. In the created temporary tables, all columns are of the type SQL Variant. If the column names have not been specified, then "Value_0", "Value_1", etc. are used as column names. The possible arguments are as follows:

• @_Argv - type INT: the number of provided parameters (from 0 to 10)
• #_Arg1, ... #_Arg10: arguments passed to that script

Each argument exists in the called script until the next --#Run command is executed in that script. After the called script has finished, the main script continues its execution.

Examples

In the following example, the script gets data from two data tables and passes that data to the script with Id equal to <ScriptId>.

(SELECT 'AnalysisType', '18') UNION ALL
(SELECT 'MaximumCount', '0') UNION ALL
(SELECT 'DataTableId', '<DataTableId_1>') UNION ALL
(SELECT 'TargetTable', '#DataTable1')
--#GetAnalysis

(SELECT 'AnalysisType', '18') UNION ALL
(SELECT 'MaximumCount', '0') UNION ALL
(SELECT 'DataTableId', '<DataTableId_2>') UNION ALL
(SELECT 'TargetTable', '#DataTable2')
--#GetAnalysis

(SELECT 'ScriptId', '<ScriptId>')
SELECT * FROM #DataTable1;
SELECT * FROM #DataTable2;
--#Run

Then it runs that script with the following parameters: the number of arguments is 2 (that is, @_Argv=2). #_Arg1 takes data from the <DataTableId_1> data table and #_Arg2 from the <DataTableId_2> data table.

print 'Number of arguments: ' + cast(@_Argv as varchar(100));

SELECT * from #_Arg1;
(SELECT 'MaximumCount', '0')
--#ShowReport

SELECT * from #_Arg2;
(SELECT 'MaximumCount', '0')
--#ShowReport

--#SendEmail

Sends an e-mail and writes a message to script log whether sending the email was successful or not. Script execution continues even when the sending isn't successful.

Query

Configures the command using a SELECT statement returning two columns: the first column is for a key and the second one is for a value of that key. The values in both the key column and in the value column are of type NVARCHAR. The supported keys for this command are:

'CatchOperationExceptions', '<Value>'

Optional. Defines whether to stop the script execution or to continue to run the script from the next statement if an exception occurs when running the script:

1 = don't stop execution of the script, continue running the script from the next statement.

0 = stop execution of the current script and show the exception.

The following script variables will be set and are shown in the script log:

@_ExceptionOccurred: if there was an exception, then this value is 1, otherwise 0. INT

@_ExceptionType: if there was an exception, shows the C# class name for the exception, NVARCHAR(MAX), otherwise NULL.

@_ExceptionMessage: if there was an exception, contains a message that would have been displayed, NVARCHAR(MAX), otherwise NULL.

@_ExceptionDetails: if there was an exception, contains the details that would have been displayed, including the system stack trace, NVARCHAR(MAX), otherwise NULL.

E-mail Parameters

'EmailFrom'

Defines the from address for this e-mail message. Mandatory.

'EmailTo'

Defines the recipient(s) for this e-mail message given in a list separated by comma. Mandatory.

'EmailSubject'

Defines the subject of the email. Default value is empty. Optional.

'EmailBody'

Defines the message body. Default value is empty. Optional.

'EmailCc'

Defines the carbon copy recipient(s) for this e-mail message given in a list separated by comma. Optional.

'EmailBcc'

Defines the blind carbon copy recipient(s) for this e-mail message given in a list separated by comma. Optional.

'EmailIsBodyHtml'

Defines whether the e-mail message body is in HTML. TRUE or any other Integer than "0" = body is in HTML, FALSE or "0" = body is not in HTML. Default value is FALSE. Optional.

'EmailSender'

Defines the sender's address for this e-mail message. Default value is empty. Optional.

'EmailReplyTo'

Defines the ReplyTo address(es) for the mail message given in a list separated by comma. Optional.

'EmailPriority',

Defines the priority of this e-mail message. Possible values are "High", "Normal", and "Low". Default value is "Normal". Optional.

'EmailDeliveryNotification'

Defines the delivery notifications for this e-mail message. Possible values are "Delay", "Never", "None", "OnFailure", and "OnSuccess". Default value is "None". Optional.

'EmailBodyEncoding'

Defines the encoding used to encode the message body. Supported encodings are listed in the "Remarks" section at http://msdn.microsoft.com/en-us/library/System.Text.Encoding.aspx. Optional.

'EmailSubjectEncoding'

Defines the encoding used for the subject content for this e-mail message. Supported encodings are listed in the "Remarks" section at http://msdn.microsoft.com/en-us/library/System.Text.Encoding.aspx. Optional.

SMTP Server Parameters

'SmtpServer'

Defines the hostname or the IP address of the server. Mandatory for the first occurrence of the SendEmail command during script execution.

'SmtpPort'

Defines the port of the SMTP server. Default value is "25". Optional.

'SmtpAuthenticationUsername'

Defines the user name for the SMTP server. Note that the user name is in plain text and visible to all users who have access to the script. Optional.

'SmtpAuthenticationPassword'

Defines the password for the SMTP server. Note that the password is in plain text and visible to all users who have access to the script. Optional.

'SmtpEnableSSL'

Defines whether SSL should be enabled for the SMTP connection. TRUE or any other Integer than "0" = SSL is enabled, FALSE or "0" = SSL is not enabled. Default value is "FALSE". Optional.

Examples

The following example will send an e-mail message to multiple recipients.

(SELECT 'EmailFrom', 'example.from@address.com') UNION ALL
(SELECT 'EmailTo', 'recipient.one@address.com,recipient.two@address.com,recipient.three@address.com') UNION ALL
(SELECT 'EmailSubject', 'Example E-mail') UNION ALL
(SELECT 'EmailBody', 'QPR ProcessAnalyzer example script started running.') UNION ALL
(SELECT 'SmtpServer', 'localhost')
--#SendEmail

See also How to Define the SMTP Server Connection in an On-Site Deployment.

--#ShowReport

Creates a new excel sheet containing a table that contains the results of the user specified SQL query. The result column names are the field names of the SQL query and the rows are the actual data rows of the SQL query. The report can be used to see, for example, the events that would be loaded into QPR ProcessAnalyzer before actually loading them. If the events have problems that cause errors when loaded it is useful to be able to see the row data in a report.

Parameters

The parameters defined in the SQL SELECT statements:

'<data>'

Mandatory. The database query whose results are to be returned.

'<Analysis Parameter>', '<Value>'

Optional. The Analysis Parameters given for the operation. Some suggested parameters to be used:

'Title', '<Title of the report>'

The title of the created report. If not given, "Report" will be used as a default.

'SheetName', '<Name for the sheet>'

The name of the Excel sheet to be created.

'MaximumCount', '<Value>'

The maximum number of rows to show (0 = all, default = 1000).

'CatchOperationExceptions', '<Value>'

Optional. Defines whether to stop the script execution or to continue to run the script from the next statement if an exception occurs when running the script:

1 = don't stop execution of the script, continue running the script from the next statement.

0 = stop execution of the current script and show the exception.

The following script variables will be set and are shown in the script log:

@_ExceptionOccurred: if there was an exception, then this value is 1, otherwise 0. INT

@_ExceptionType: if there was an exception, shows the C# class name for the exception, NVARCHAR(MAX), otherwise NULL.

@_ExceptionMessage: if there was an exception, contains a message that would have been displayed, NVARCHAR(MAX), otherwise NULL.

@_ExceptionDetails: if there was an exception, contains the details that would have been displayed, including the system stack trace, NVARCHAR(MAX), otherwise NULL.

Example

The following example opens the data table identified by data table name "SqlTable" and project name "Test" as a report.

(SELECT 'AnalysisType', '18') UNION ALL
(SELECT 'ProjectName', 'Test') UNION ALL
(SELECT 'DataTableName', 'SqlTable') UNION ALL
(SELECT 'TargetTable', '#AnalysisResult')
--#GetAnalysis

SELECT * FROM #AnalysisResult; 
(SELECT 'Title', 'Report1') UNION ALL
(SELECT 'SheetName', 'Sheet1') UNION ALL
(SELECT 'MaximumCount', '0') 
--#ShowReport 

---

--#WriteLog

Adds the first column values from the preceding SQL statements to the log that is shown after the whole script execution is completed.

In addition to the WriteLog command, you can also use the Print SQL statement to generate log entries into the script execution log. The difference to the WriteLog command is that the Print statement can use also variables.

Examples

The following example will write "Script started", "Example", "Print Example" into the log.

SELECT 'Script started'
SELECT 'Example'
--#WriteLog
PRINT 'Print Example'