SQL Scripting Commands: Difference between revisions

From QPR ProcessAnalyzer Wiki
Jump to navigation Jump to search
(306906)
 
(209 intermediate revisions by 4 users not shown)
Line 1: Line 1:
This page lists all the QPR ProcessAnalyzer commands that are supported in scripts. Each command consists of queries, which are explained in the following subsections.<br/>
This page lists QPR ProcessAnalyzer commands that can be used in the SQL scripts. Each command precedes one or two SQL queries, which sets parameters for the command or defines the data used by the command.


=<br/> --#CallWebService =
<div style="display: flex;flex-wrap: wrap;">
<div style="flex: 1 0 230px;border:1px solid #dfdfdf;padding:0 1em 1em 1.5em;background-color:#F7FAFC;margin:10px 0px 0px 10px;">
=== Data Extraction ===
* [[#--.23CallWebService|CallWebService]]
* [[#--.23ImportOdbcQuery|ImportOdbcQuery]]
* [[#--.23ImportOleDbQuery|ImportOleDbQuery]]
* [[#--.23ImportSalesforceQuery|ImportSalesforceQuery]]
* [[#--.23ImportSapQuery|ImportSapQuery]]
* [[#--.23ImportSqlQuery|ImportSqlQuery]] (ADO.Net)
</div>
 
<div style="flex: 1 0 230px;border:1px solid #dfdfdf;padding:0 1em 1em 1.5em;background-color:#F7FAFC;margin:10px 0px 0px 10px;">
 
=== Data Output ===
* [[#--.23ImportDataTable|ImportDataTable]]
* [[#--.23SendEmail|SendEmail]]
* [[#--.23ShowReport|ShowReport]]
* [[#--.23WriteLog|WriteLog]]
</div>
 
<div style="flex: 1 0 230px;border:1px solid #dfdfdf;padding:0 1em 1em 1.5em;background-color:#F7FAFC;margin:10px 0px 0px 10px;">
 
=== Script Flow ===
* [[#--.23RunQuery|RunQuery]] ([[RunQuery Script Examples|examples]])
* [[#--.23Commit|Commit]]
* [[#--.23Exit|Exit]]
* [[#--.23GetAnalysis|GetAnalysis]]
* [[#--.23Run|Run]]
* [[#--.23StartBackground|StartBackground]]
</div>
 
</div>
 
= --#CallWebService =
Extracts data via Web Service. This command takes one SELECT query as parameter.
Extracts data via Web Service. This command takes one SELECT query as parameter.


== Query ==
== 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:
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:
; 'Address'
; Address
: Defines the URI of the service to call. Mandatory.
: Defines the URI of the service to call. Mandatory.
; 'Method'
; Method
: Defines the HTTP method to use for the call. Must be any of the following: GET (default), POST, PUT, DELETE. Optional.
: Defines the HTTP method to use for the call. Must be any of the following: GET (default), POST, PUT, DELETE. Optional.
; 'Body'
; Body
: Defines the message body text to send to the service. Default value is empty. Optional.
: Defines the message body text to send to the service. Default value is empty. Optional.
; 'Encoding'
; Encoding
: Defines the encoding method to use. The supported options are listed in [https://msdn.microsoft.com/en-us/library/system.text.encoding%28v=vs.110%29.aspx https://msdn.microsoft.com/en-us/library/system.text.encoding%28v=vs.110%29.aspx]. Default value is UTF8. Optional.
: Defines the encoding method to use. The supported options are listed in [https://msdn.microsoft.com/en-us/library/system.text.encoding%28v=vs.110%29.aspx https://msdn.microsoft.com/en-us/library/system.text.encoding%28v=vs.110%29.aspx]. Default value is UTF8. Optional.
; 'Timeout'
; Timeout
: Number of milliseconds to wait before the request times out. Default value is 60000. Optional.
: Number of milliseconds to wait before the request times out. Default value is 60000. Optional.
; 'ExecuteInClientSide'
; ExecuteInClientSide
: Defines whether the web service call 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 in the client side. Supports only data table as the import destination. Default value is FALSE. Optional.
: Defines whether the web service call is made from the QPR ScriptLauncher or from the server. TRUE or 1, the call is executed in the ScriptLauncher. FALSE or 0, the call is executed in the server. Default value is FALSE. Optional.
; 'DefaultNetworkCredentials'
; DefaultNetworkCredentials
: Optional. Defines the possibility to use default network credentials in web service calls:
: Optional. Defines the possibility to use default network credentials in web service calls:
: 1 = use the default network credentials.
: 1 = use the default network credentials.
: 0 = don't use the default network credentials.
: 0 = don't use the default network credentials.
: In Pro version, if --#CallWebService command is run in the server side (ExecuteInClientSide is False), then default network credentials can be used only if service configuration parameter AllowForwardingNetworkCredentials is set to true (it is false by default). Otherwise, if --#CallWebService command is run in the client side (ExecuteInClientSide is True), then default network credentials can always be used.
: If CallWebService command is run in the server side (ExecuteInClientSide=False), the default network credentials can be used only if in the server configuration AllowForwardingNetworkCredentials is true (it is false by default). Otherwise, if the CallWebService command is run in the client side (ExecuteInClientSide=True), the default network credentials can always be used.  
: In QPR ProcessAnalyzer Xpress or QPR ProcessAnalyzer Database, it is always possible to use network credentials.
; CatchOperationExceptions
; '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:
: 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.
: 1 = don't stop execution of the script, continue running the script from the next statement.
Line 34: Line 66:
: <code>@_ExceptionDetails</code> If there was an exception, contains the details that would have been displayed, including the system stack trace, NVARCHAR(MAX), otherwise NULL.
: <code>@_ExceptionDetails</code> If there was an exception, contains the details that would have been displayed, including the system stack trace, NVARCHAR(MAX), otherwise NULL.
;<nowiki><other parameters></nowiki>
;<nowiki><other parameters></nowiki>
: All the rest of the passed parameters not listed above are added as extra headers to the request. Optional.
: All the rest of the passed parameters not listed above are added as extra headers to the request. For example, ''Content-Type'' and ''Accept'' HTTP headers can be added. Optional.


== Result ==
== Result ==
The result of the request is passed to the script following the CallWebService operation in the following variables:
The result of the request is passed to the script following the CallWebService operation in the following variables:
: <code>@_ResponseText</code> The response text received from the remote server. If there was an error in processing the request, this will contain the received error message. NVARCHAR(MAX).  
: <code>@_ResponseText</code> The response text received from the remote server. If there was an error in processing the request, this will contain the received error message. NVARCHAR(MAX).  
Line 43: Line 74:
: <code>@_ResponseSuccess</code> True only if the request returned status code that represents a success. BIT.
: <code>@_ResponseSuccess</code> True only if the request returned status code that represents a success. BIT.


== Examples ==
See examples at the [[CallWebService Script Examples]] page.
See examples at the [[CallWebService Script Examples]] page.


=<br/> --#CreateFilter =
= --#Commit =
Creates a new filter with the specified parameters. Returns the id of the newly created filter in SQL dynamic variable @_CreatedFilterId.
[https://docs.microsoft.com/en-us/sql/t-sql/language-elements/commit-transaction-transact-sql?view=sql-server-ver15 Commits] the currently open SQL transaction in the sandbox database and starts a new transaction. The commit command can be executed at any point in the script. Note that the command does not have any parameters, i.e. there is no preceding SELECT statement before the --#Commit statement.


== Query ==
If the commit command is not used, the database transaction in the sandbox database is committed when the script is completed. On the other hand, if the script execution encounters an error, the SQL transaction is rolled back.  
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:
 
; 'ParentFilterId'
The commit command is useful in following circumstances:
: Id of the filter/view for which the new filter is applied. Mandatory.
* If the sandbox database is configured to allow storing permanent objects, commit can be used to preserve changes even if the script execution encounters an error.
; 'FilterType'
* When the scripting is handling large amount of data, it's better to make commits during the script run, so that the database transaction log doesn't grow too large.
: Type of the additional filter to apply. Supported values are:
* Committing changes makes them visible for other users in the database.
:: 0 = Exclude Selected
:: 1 = Include Only Selected
:: 2 = Exclude Selected Event Types
:: 3 = Include Only Selected Event Types
:: 4 = Exclude Selected Cases
:: 5 = Include Only Selected Cases
:: 6 = Recalculate
:: 7 = Include Only Selected Case Attributes
:: 8 = Exclude Selected Case Attributes
:: 9 = Include Only Selected Event Attributes
:: 10 = Exclude Selected Event Attributes
:: 11 = Remove Filter Rules
; '<Object selection related parameters>'
: The object selection related parameters are supported by all the other filter types except Recalculate. Possible parameters and their values and value types:
{{ObjectSelectionRelatedParameters}}
; 'FilterRuleIds'
: A comma-separated list of filter rule ids. Mandatory for RemoveFilterRules FilterType.
; 'IncludeSelection'
:  Boolean value. If this is TRUE, then the current selection from the parameters of the script run is copied to the parameters of the command (only if similar setting doesn't already exist in the command parameters). Default value is FALSE.
; 'FilterName'
: Name of the new filter. By default, the name is generated automatically by QPR ProcessAnalyzer.
; 'PublishMode'
: Publish mode for the created filter. Possible values are "Public" and "Private". Default value is "Private".
; 'CaseSampleSize'
: The case sample size for the created filter. Optional. If missing, the sample size is inherited from the parent filter, if CaseSampleSize=0, then all cases are included into the filter, if CaseSampleSize>0, then this value is used as case sample size in the created filter.


== Examples ==
Example:
See examples at the [[CreateFilter Script Examples]] page.
<pre>
--#Commit
</pre>


=<br/> --#Exit =
= --#Exit =
Stops the execution of the script and gives a message to the user. This command takes one SELECT query as its parameter.
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:<br/>
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:<br/>
; 'Exit'
; Exit
: Defines whether to stop the script execution:
: 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.
: 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.
: 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'
; 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.
: 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'
; 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.
: 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'
; 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:
: 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.
: 1 = don't stop execution of the script, continue running the script from the next statement.
Line 107: Line 113:
: <code>@_ExceptionDetails</code> If there was an exception, contains the details that would have been displayed, including the system stack trace, NVARCHAR(MAX), otherwise NULL.
: <code>@_ExceptionDetails</code> If there was an exception, contains the details that would have been displayed, including the system stack trace, NVARCHAR(MAX), otherwise NULL.


== Examples ==
See examples at the [[Exit Script Examples]] page.
See examples at the [[Exit Script Examples]] page.


=<br/> --#GetAnalysis =
= --#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.
 
<div style="border:1px solid #dfdfdf;padding:0.5em 1em 0.5em 1em;background-color:#E7EAEC;margin:10px 0px 0px 10px;">
--#GetAnalysis command is deprecated and it will be removed in a future release. Use the more flexible [[SQL_Scripting_Commands#--.23RunQuery|--#RunQuery]] command instead.
</div>
 
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. Contains information about the scripts that are running and have been run.​


== 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:<br/>
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:<br/>
; '<Analysis Parameter>'
; <Analysis Parameter>
: See [[Analysis Parameters]] for a list of supported analysis parameters in QPR ProcessAnalyzer.
: The --#GetAnalysis command supports the following analysis types:
: The --#GetAnalysis command supports the following analysis types:
: Flowchart Analysis (0)
* DataTableAnalysis=18: Reads a data table from SQL server and stores it in temporary table​
: Variation Analysis in the Chart Mode (1)
* Etl=19
: Path Analysis (3)
* EtlReport=20
: Event Type Analysis in the Chart Mode (4)
* RunScript=25
: Case Analysis (5)
* ExpressionAnalysis=33
: Event Analysis (6)
; TargetTable
: 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)
: RunScript (25)
: Event Type Analysis in the Trends Mode (26)
: Profiling Analysis in the Trends Mode (28)
: Duration Influence Analysis (29)
: Filter Report (30)
: Filter Rule Report (31)
: Script Log Report (32)
: 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 [[Analysis Parameters|the list of analysis parameters]].
; 'TargetTable'
: The temporary table to which the analysis is to be stored. When the TargetTable parameter is used, the "Table" result type of the ForceAnalysisResultType parameter is also automatically used. If the specified temporary table already exists in the database then its contents are deleted before storing analysis.
: The temporary table to which the analysis is to be stored. When the TargetTable parameter is used, the "Table" result type of the ForceAnalysisResultType parameter is also automatically used. If the specified temporary table already exists in the database then its contents are deleted before storing analysis.
; 'Show'
; Show
: Optional. If TRUE or 1, the analysis is opened after the script is run. If the Show parameter is set to TRUE or 1 and the TargetTable parameter is used in the same GetAnalysis command, the analysis result is stored in the target table in tabular format and QPR ProcessAnalyzer Excel Client shows the analysis result in the normal format.
: Optional. If TRUE or 1, the analysis is opened after the script is run. If the Show parameter is set to TRUE or 1 and the TargetTable parameter is used in the same GetAnalysis command, the analysis result is stored in the target table in tabular format.
; 'Title'
; Title
: Optional. The title for the Excel sheet created when Show is TRUE or 1. Default value is the name of the analysis type.
: Optional. Name of the CSV file created when Show is TRUE or 1. Default value is the name of the analysis type.
; 'SheetName'
; CatchOperationExceptions
: Optional. The name of the Excel sheet created when Show is TRUE or 1. Default value is the name of the analysis type.
{{Template:PivotSheet}}
; '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:
: 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.
: 1 = don't stop execution of the script, continue running the script from the next statement.
Line 163: Line 146:
:<code>@_ExceptionMessage</code> If there was an exception, contains a message that would have been displayed, NVARCHAR(MAX), otherwise NULL.
:<code>@_ExceptionMessage</code> If there was an exception, contains a message that would have been displayed, NVARCHAR(MAX), otherwise NULL.
:<code>@_ExceptionDetails</code> If there was an exception, contains the details that would have been displayed, including the system stack trace, NVARCHAR(MAX), otherwise NULL.
:<code>@_ExceptionDetails</code> If there was an exception, contains the details that would have been displayed, including the system stack trace, NVARCHAR(MAX), otherwise NULL.
; 'ScriptId'
; MaximumCount
: Mandatory with the RunScript analysis type. Defines the script that should be run.
: Used with Operation Log Analysis analysis type. Integer. The maximum amount of rows returned. Optional. Default value is 1000.
; 'SelectedAnalysisResult'
: Used with the RunScript analysis type. Optional. Identifies the sheet name of the child analysis that should be returned to the caller of the RunScript function. If set, and a child analysis with the given sheet name exists, only that child analysis is returned to the caller. If not set or a child analysis with given sheet name does not exist, then the actual analysis object returned by RunScript is returned as the analysis result. In this case, the child analyses of the returned analysis object contain all the analyses that were generated due to the script having the ShowReport or GetAnalysis command with Show parameter having true as value.
; 'TrendPeriodLevel'
: Used with the Event Type Analysis in the Trends mode. Optional. Defines the period level for which trends are shown. Possible values are "Day", "Week", "Month" (Default), "Quarter", and "Year".
; 'TrendMaximumCount'
: Used with the Event Type Analysis in the Trends mode. Optional. Defines the maximum number of trend columns to show.
; 'ShowAllCases'
: Used with Case Analysis. Optional. When this parameter is set to TRUE or 1, the current filter is applied (including sampling, filter rules etc.) but the result will contain all cases for the model. Then, if a case in the result has no events (originally or due to the applied filter, including sampling), the case start date is NULL and the case end data is NULL, and case duration is zero. The same case attributes are shown also for the cases that do not have events as those cases that have events. Default value is FALSE.
; 'ForceAnalysisResultType'
: Can be used with all analysis types. Optional. Defines if the analysis result is to be generated in tabular format. Possible values are:
: "Normal" = Uses the default result type that is best suited for holding all the information related to the analysis in the most efficient way possible. Default with analysis generation in QPR ProcessAnalyzer Excel client and Web Client.
: "Table" = Forces the result type to be a tabular AnalysisRowData object. Default for analysis generation in all other uses than with QPR ProcessAnalyzer Excel client and Web Client. Forcing tabular result for Flowchart and Path analyses causes the whole result object to be converted into XML, after which it is returned in a tabular format by returning a table containing only one row and one column having the converted XML in it. The maximum supported size of the converted XML is 10 MB.
; 'IncludeSelection'
: Can be used with all analysis types. Optional. If TRUE or 1, the current object selection related parameters are copied to the parameters of the command, if similar setting doesn't already exist in the command parameters. The object selection related parameters are:<div id="ObjectSelectionParameters"></div>
{{ObjectSelectionRelatedParameters}}
; 'ScriptIds'
: Used with Script Log Report analysis type. A comma-separated list of script ids for which the log entries are returned. Optional. If not given, logs for all scripts available to the user are included into the report.
; 'MinStartTime'
: Used with Script Log Report analysis type. A date time parameter which specifies the earliest start time in the script log entries. Format is ISO, e.g.: 2016-03-14 02:10:00. Mandatory if ScriptIds parameter is not defined.
; 'MaxStartTime'
: Used with Script Log Report analysis type. A date time parameter which specifies the latest start time in the script log entries. Format is ISO, e.g.: 2016-03-14 02:10:00. Optional.


== Examples ==
See examples at the [[GetAnalysis Script Examples]] page.
See examples at the [[GetAnalysis Script Examples]] page.


=<br/> --#ImportCaseAttributes =
= --#ImportDataTable =
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.
Imports data from an SQL query to a datatable. This command takes two SELECT queries as parameters.


== First Query ==
== 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:<br/>
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:<br/>
; 'ProjectId' or 'ProjectName'
; 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 [[Model Properties|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:
: <code>@_ExceptionOccurred</code> If there was an exception, then this value is 1, otherwise 0. INT
: <code>@_ExceptionType</code> If there was an exception, shows the C# class name for the exception, NVARCHAR(MAX), otherwise NULL.
: <code>@_ExceptionMessage</code> If there was an exception, contains a message that would have been displayed, NVARCHAR(MAX), otherwise NULL.
: <code>@_ExceptionDetails</code> if there was an exception, contains the details that would have been displayed, including the system stack trace, NVARCHAR(MAX), otherwise NULL.
 
== Second Query ==
; <nowiki>'<data>'</nowiki>
: 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.
 
== Examples ==
See examples at the [[ImportCaseAttributes Script Examples]] page.
 
=<br/> --#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:<br/>
; 'ProjectId' or 'ProjectName'
: The id or the name of the project in which the target data table exists.
: The id or the name of the project in which the target data table exists.
; 'DataTableId' or 'DataTableName'
; DataTableId or DataTableName
: The id or the name of the existing/new target data table.
: The id or the name of the existing/new target data table.
; 'Append'
; 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.
: Defines what to do with an existing contents of the target datatable. When value is 1, existing rows in the target datatable are not deleted (also new columns in the imported data are created to the datatable). When value is 0, existing rows in the target datatable are deleted before the import (columns are still preserved). Not used when creating a new data table.
; 'CatchOperationExceptions'
; 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:
: 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.
: 1 = don't stop execution of the script, continue running the script from the next statement.
Line 239: Line 173:


== Second Query ==
== Second Query ==
; <nowiki>'<data>'</nowiki>
; <nowiki><data></nowiki>
: 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.
: The database query whose results are to be imported. Note that if the query doesn't return any data, the datatable is not created.


== Examples ==
See examples at the [[ImportDataTable Script Examples]] page.
See examples at the [[ImportDataTable Script Examples]] page.


=<br/> --#ImportEvents =
= --#ImportOdbcQuery =
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.
Extracts data from an ODBC data source and imports it to QPR ProcessAnalyzer datatable or temporary table. Column names from the query result as used. 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. To use ImportOdbcQuery, define 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:
== 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:<br/>
; '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:
: <code>@_ExceptionOccurred</code> If there was an exception, then this value is 1, otherwise 0. INT
: <code>@_ExceptionType</code> If there was an exception, shows the C# class name for the exception, NVARCHAR(MAX), otherwise NULL.
: <code>@_ExceptionMessage</code> If there was an exception, contains a message that would have been displayed, NVARCHAR(MAX), otherwise NULL.
: <code>@_ExceptionDetails</code> If there was an exception, contains the details that would have been displayed, including the system stack trace, NVARCHAR(MAX), otherwise NULL.


== Second Query ==
; TargetTable: 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.  
; <nowiki>'<data>'</nowiki>
; ProjectId / ProjectName
: 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.
 
== Examples ==
See examples at the [[ImportEvents Script Examples]] page.
 
=<br/> --#ImportEventsIncremental =
Synchronizes a model with event data in the specified event data table. May delete and/or add new events into the model.
<br/>
Events are matched between the model and the event data table as follows:<br/>
{| class="wikitable"
!Model
!Event data table
|-
|Event's case name
|First column's data converted into NVARCHAR(440)
|-
|Event's event type name
|Second column's data converted into NVARCHAR(440)
|-
|Event's start time
|Third column's data converted into DATETIME
|}
In addition to this, if the AppliedEventAttributes parameter value is not empty, the events are considered the same only if events pass the following additional equality tests:
* The value of every listed event attribute must be equal according to SQL equality operator both in the model and in the event data table.
** Data type conversions are not performed for either side of the SQL equality operation.
** There must be one column in the event data table for every specified event attribute whose field name equals to the name of the event attribute.
** Also the model itself must have matching event attribute.
** If there are no matching event attributes in either the model or the event data table, the import operation is cancelled and an entry is written into the logfile.
Things to note:
*All event attribute columns (columns starting from index 4) in the event data table not listed in the value of AppliedEventAttributes parameter are imported normally as event attributes and they have no effect in matching events.
* Incremental import will always delete all event cache tables in the model after the import.
* Deleting events in incremental import never causes variations, event types nor cases to be removed from the model. However, they may create new ones.
 
== 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:<br/>
; 'ModelId'
:  Id of the model into which the new events are to be added. Mandatory.
; 'Event_DataTableId'
: Id of the data table from which event data to be imported is read. Mandatory.
; 'DeletedEvents_DataTableId'
: Id of the data table to receive data for all the events deleted from the model during the synchronization operation. Optional. If this parameter is not set, the data from the deleted events is lost.
; 'AddedEvents_DataTableId'
: Id of the data table to receive data for all the events added to the model during the synchronization operation. Optional. If this parameter is not set, the information about what event data was added is not written anywhere.
; 'SkipImport'
: Boolean value defining if the events are really to be synchronized with the model or should the operation just write details on what has changed in the model into data tables defined by the DeletedEvents_DataTableId and AddedEvents_DataTableId parameters. Optional. If this parameter is not set or is set to FALSE, the events are imported to the model.
; 'AppliedEventAttributes'
: A comma separated list of event attribute names that are used in matching the events between the model and the event data table. Optional.
 
== Example ==
See examples in the [[ImportEventsIncremental Script Examples]] page.
 
=<br/> --#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.
== 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:<br/>
; 'TargetTable': 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'
: The id or the name of the project in which the target data table exists.
: The id or the name of the project in which the target data table exists.
; 'DataTableId' or 'DataTableName'
; DataTableId / DataTableName
: The id or the name of the existing/new target data table.
: The id or the name of the existing/new target data table.
; 'Append'
; Append
: Defines what to do with an existing target data table and its contents. TRUE or any other Integer than "0" = the target data table and its existing contents are not deleted before import. If a user imports into a data table with 'Append' = FALSE or "0", the contents of the data table are deleted before the import. If a user imports into a temporary table (i.e. TargetTable) with 'Append' = FALSE or "0", then the whole temporary table is deleted before the import. Not used when creating a new data table.
: Defines what to do with an existing target data table and its contents. TRUE or any other Integer than "0" = the target data table and its existing contents are not deleted before import. If a user imports into a data table with 'Append' = FALSE or "0", the contents of the data table are deleted before the import. If a user imports into a temporary table (i.e. TargetTable) with 'Append' = FALSE or "0", then the whole temporary table is deleted before the import. Not used when creating a new data table.
; 'CatchOperationExceptions'
; 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:
: 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.
: 1 = don't stop execution of the script, continue running the script from the next statement.
Line 338: Line 197:
:<code>@_ExceptionMessage</code> If there was an exception, contains a message that would have been displayed, NVARCHAR(MAX), otherwise NULL.
:<code>@_ExceptionMessage</code> If there was an exception, contains a message that would have been displayed, NVARCHAR(MAX), otherwise NULL.
:<code>@_ExceptionDetails</code> If there was an exception, contains the details that would have been displayed, including the system stack trace, NVARCHAR(MAX), otherwise NULL.
:<code>@_ExceptionDetails</code> If there was an exception, contains the details that would have been displayed, including the system stack trace, NVARCHAR(MAX), otherwise NULL.
 
; OdbcConnectionString
'''ODBC specific parameters'''
: The ODBC driver connection string that includes the settings needed to establish the initial connection. Mandatory. See [http://msdn.microsoft.com/en-us/library/system.data.odbc.odbcconnection.connectionstring%28v=vs.110%29.aspx?cs-save-lang=1&cs-lang=csharp#code-snippet-1 OdbcConnection.ConnectionString Property in Microsoft Development Network] for more information on the possible connection strings.
; 'OdbcConnectionString'
; OdbcConnectionStringKey
: The ODBC driver connection string that includes the settings needed to establish the initial connection. Mandatory. See [http://msdn.microsoft.com/en-us/library/system.data.odbc.odbcconnection.connectionstring%28v=vs.110%29.aspx?cs-save-lang=1&cs-lang=csharp#code-snippet-1 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|How to Configure an ODBC Data Source Name for Connecting to QPR ProcessAnalyzer]].
: [[Storing_Secrets_for_Scripts|Secret name]] for the connection string. Alternative for the OdbcConnectionString property.
; 'OdbcQueryString'
; OdbcQueryString
: 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.
: 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'
; QueryExecutionTimeout
: 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.
: Defines timeout in seconds for the ODBC command execution. If not specified, default value is 600 seconds.
; ExecuteInClientSide
: Defines whether the command is executed from the QPR ScriptLauncher or from the server. This parameter is used when there is no server connection available, for example. TRUE or 1, the query is executed in the QPR ScriptLauncher. FALSE or 0, the query is executed in the server. 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 1, you will receive an error message. Optional. Default value is FALSE.


== Example ==
See examples in the [[ImportOdbcQuery Script Examples]] page.
See examples in the [[ImportOdbcQuery Script Examples]] page.


=<br/> --#ImportOleDbQuery =
= --#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.
Extracts data from an OLE DB data source and imports it to QPR ProcessAnalyzer datatable or a temporary table. Column names from the query result are used. It is possible to both create new datatables as well as modify existing datatables with this command. To use the ImportOleDbQuery, define 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:


== Query ==
; TargetTable
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:<br/>
; 'TargetTable'
: 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.
: 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'
; ProjectId / ProjectName
: The id or the name of the project in which the target data table exists.
: The id or the name of the project in which the target data table exists.
; 'DataTableId' or 'DataTableName'
; DataTableId / DataTableName
: The id or the name of the existing/new target data table.
: The id or the name of the existing/new target data table.
; 'Append'
; Append
: Defines what to do with an existing target data table and its contents. TRUE or any other Integer than "0" = the target data table and its existing contents are not deleted before import. If a user imports into a data table with 'Append' = FALSE or "0", the contents of the data table are deleted before the import. If a user imports into a temporary table(i.e. TargetTable) with 'Append' = FALSE or "0", then the whole temporary table is deleted before the import. Not used when creating a new data table.
: Defines what to do with an existing target data table and its contents. TRUE or any other Integer than "0" = the target data table and its existing contents are not deleted before import. If a user imports into a data table with 'Append' = FALSE or "0", the contents of the data table are deleted before the import. If a user imports into a temporary table(i.e. TargetTable) with 'Append' = FALSE or "0", then the whole temporary table is deleted before the import. Not used when creating a new data table.
; 'CatchOperationExceptions'
; 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:
: 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.
: 1 = don't stop execution of the script, continue running the script from the next statement.
Line 372: Line 230:
:<code>@_ExceptionMessage</code> If there was an exception, contains a message that would have been displayed, NVARCHAR(MAX), otherwise NULL.
:<code>@_ExceptionMessage</code> If there was an exception, contains a message that would have been displayed, NVARCHAR(MAX), otherwise NULL.
:<code>@_ExceptionDetails</code> If there was an exception, contains the details that would have been displayed, including the system stack trace, NVARCHAR(MAX), otherwise NULL.
:<code>@_ExceptionDetails</code> 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
; 'OleDbConnectionString'
: The OLE DB connection string that includes the settings needed to establish the initial connection. Mandatory. See [http://msdn.microsoft.com/en-us/library/system.data.oledb.oledbconnection.connectionstring%28v=vs.110%29.aspx OleDbConnection.ConnectionString Property in Microsoft Development Network] for more information on the possible connection strings.
: The OLE DB connection string that includes the settings needed to establish the initial connection. Mandatory. See [http://msdn.microsoft.com/en-us/library/system.data.oledb.oledbconnection.connectionstring%28v=vs.110%29.aspx OleDbConnection.ConnectionString Property in Microsoft Development Network] for more information on the possible connection strings.
; 'OleDbQueryString'
; OleDbQueryString
: 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.
: 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'
; QueryExecutionTimeout
: 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.
: Defines timeout in seconds for the OLE DB command execution. If not specified, default value is 600 seconds.
; ExecuteInClientSide
: Defines whether the command is executed from the QPR ScriptLauncher or from the server. This parameter is used when there is no server connection available, for example. TRUE or 1, the query is executed in the QPR ScriptLauncher. FALSE or 0, the query is executed in the server. 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.


== Examples ==
See examples at the [[ImportOleDbQuery Script Examples]] page.
See examples at the [[ImportOleDbQuery Script Examples]] page.


=<br/> --#ImportSalesforceQuery =
= --#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!
Extracts data from the Salesforce cloud using its REST API and imports the data to a datatable. The command takes one SELECT query as its parameter. If the query doesn't return any data, the target data table or temporary table is not created.
 
More information about the Salesforce REST API: https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/intro_rest.htm.


This command takes one SELECT query as its parameter.
== Query ==
== 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:<br/>
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:<br/>
; 'TargetTable'
; TargetTable
: 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.
: Temporary table to which the data is imported. If not used, define the target using the ProjectId/ProjectName, DataTableId/DataTableName, and Append parameters described below.
; 'ProjectId' or 'ProjectName'
; ProjectId / ProjectName
: The id or the name of the project in which the target data table exists.
: Id or the name of the project in which the target datatable is located.
; 'DataTableId' or 'DataTableName'
; DataTableId / DataTableName
: The id or the name of the existing/new target data table.
: Id or the name of the target data table. If DataTableName is used, the ProjectId or ProjectName can also be used to define the project where the datatable is located.
; 'Append'
; 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.
: Defines what to do with an existing target data table contents. TRUE or 1, existing contents of the target datatable is not deleted in the import. When FALSE or 0, existing contents of the target datatable are deleted before importing new data. Not used when creating a new data table.
; 'CatchOperationExceptions'
; 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:
: 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.
: 1 = don't stop execution of the script, continue running the script from the next statement.
Line 406: Line 265:
:<code>@_ExceptionMessage</code> If there was an exception, contains a message that would have been displayed, NVARCHAR(MAX), otherwise NULL.
:<code>@_ExceptionMessage</code> If there was an exception, contains a message that would have been displayed, NVARCHAR(MAX), otherwise NULL.
:<code>@_ExceptionDetails</code> If there was an exception, contains the details that would have been displayed, including the system stack trace, NVARCHAR(MAX), otherwise NULL.
:<code>@_ExceptionDetails</code> 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
; 'SalesforceUser'
: Username for the Salesforce cloud.
: Username for the Salesforce cloud.
; 'SalesforcePW'
; SalesforcePW
: Password for the Salesforce cloud.
: Password for the Salesforce cloud.
; 'SalesforceUrl'
; SalesforcePWKey
: Optional. Salesforce service Url for the Salesforce cloud. Default value for QPR ProcessAnalyzer 2016.1 version is <nowiki>'https://login.salesforce.com/services/Soap/u/27.0'</nowiki>. In order to connect to Salesforce's test environment the URL should be like: <nowiki>'https://test.salesforce.com/services/Soap/u/27.0'</nowiki>.
: [[Storing_Secrets_for_Scripts|Secret name]] for the stored Salesforce password. Alternative for the SalesforcePW property.
; 'SalesforceQueryMode'
; SalesforceUrl
: Optional. The Salesforce query function to be used. 1 (default) = [http://www.salesforce.com/us/developer/docs/api/Content/sforce_api_calls_queryall.htm queryall()], 2 = [http://www.salesforce.com/us/developer/docs/api/Content/sforce_api_calls_query.htm query()], 3 = [http://www.salesforce.com/us/developer/docs/api/Content/sforce_api_calls_describesobject.htm describeSObject()].
: Optional. Salesforce web service url.
; 'SalesforceQuery'
; SalesforceQueryMode
: The query to be run in the Salesforce cloud. Note that "*" cannot be used in the query. See [http://www.salesforce.com/us/developer/docs/api/Content/sforce_api_calls_query.htm Salesforce API] and [http://www.salesforce.com/us/developer/docs/soql_sosl/index.htm 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.
: Optional. Determines which Salesforce query function to use. One of the following values (1, 2 or 3) can be used:
; 'SalesforceQueryRetries'
: 1: '''QueryAll''' (default): Executes specified SOQL query, except unlike ''Query'', ''QueryAll'' returns records that are deleted because of a merge or delete. More information: https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_queryall.htm.
: 2: '''Query''': Executes the specified SOQL query. More information: https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_query.htm)
: 3: '''sObject Describe''': Completely describes the individual metadata at all levels for the specified object. For example, this can be used to retrieve the fields, URLs, and child relationships for the Account object. More information: https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_sobject_describe.htm).
; SalesforceQuery
: Query to run in the Salesforce cloud to fetch the data, defined as SOQL (Salesforce Object Query Language). More information: https://developer.salesforce.com/docs/atlas.en-us.236.0.soql_sosl.meta/soql_sosl/sforce_api_calls_soql_sosl_intro.htm.
; SalesforceQueryRetries
: Optional. Number of retries to attempt if the Salesforce query doesn't succeed. Default value is 3.
: Optional. Number of retries to attempt if the Salesforce query doesn't succeed. Default value is 3.
; 'SalesforceQueryRetryWait'
; SalesforceQueryRetryWait
: Optional. Number of milliseconds to wait between query retries. Default is 3000 ms.
: Optional. Number of milliseconds to wait between query retries. Default is 3000 ms.
; 'SalesforceBatchSize'
; SalesforceBatchSize
: Optional. The number of rows of data the query returns in one batch. Minimum = 200, Maximum = 2000, Default = 500. See [http://www.salesforce.com/us/developer/docs/api/Content/sforce_api_calls_query.htm Salesforce API] for more information.
: Optional. Data is queried from Salesforce in batches, and this setting determines the batch size. The value can be between 200 and 2000, and the default value is 500.
 
== Notes ==
If you get error ''INVALID_TYPE sObject type 'Objectname' is not supported'':
* Check that the object in question exists or that the object name is correct.
* Verify that the Salesforce user has rights to the object.  
** You have to give access to the new custom objects and VisualForce pages from the user's profile, and you have to check the "Customize Application" checkbox under the same profile (https://developer.salesforce.com/forums/?id=906F00000008qG6IAI). Contact your Salesforce administrator.
* The Salesforce user may need extra license to access the object. Special 3rd party custom objects may need separate license. Contact your Salesforce application administrator.


== Example ==
See examples at the [[ImportSalesforceQuery Script Examples]] page.
See examples at the [[ImportSalesforceQuery Script Examples]] page.


=<br/> --#ImportSapQuery =
= --#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 [[Installing_QPR_ProcessAnalyzer#Installing_SAP_Connector_for_Microsoft_.NET_Version_3.0_Dll_Files|some dlls]] not provided by QPR Software.
Extracts data from an SAP system and imports it to QPR ProcessAnalyzer datatable or a temporary table. Column names from the query result are used. 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 [[QPR_ProcessAnalyzer_ScriptLauncher#Installing_SAP_NetWeaver_RFC_Library|installing SAP NetWeaver RFC Library]].


== Query ==
To use the ImportSapQuery command, define 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:
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:<br/>
; TargetTable
; 'TargetTable'
: If this parameter is given, store the results into a temporary SQL table in the ETL sandbox. If the TargetTable parameter is not given, use either the ProjectId or ProjectName parameters.
: If this parameter is given, store the results into a temporary SQL table in ETL sandbox.
; ProjectId / ProjectName
If the TargetTable parameter is not given, use the following destination parameters:
; 'ProjectId' or 'ProjectName'
: The id or the name of the project in which the target data table exists.
: The id or the name of the project in which the target data table exists.
; 'DataTableId' or 'DataTableName'
; DataTableId / DataTableName
: The id or the name of the existing/new target data table.
: The id or the name of the existing/new target data table.
; 'Append'
; Append
: Defines what to do with an existing target data table and its contents. TRUE or any other Integer than "0" = the target data table and its existing contents are not deleted before import. If a user imports into a data table with 'Append' = FALSE or "0", the contents of the data table are deleted before the import. If a user imports into a temporary table (i.e. TargetTable) with 'Append' = FALSE or "0", then the whole temporary table is deleted before the import. Not used when creating a new data table.
: Defines what to do with an existing target data table and its contents. TRUE or any other Integer than "0" = the target data table and its existing contents are not deleted before import. If a user imports into a data table with 'Append' = FALSE or "0", the contents of the data table are deleted before the import. If a user imports into a temporary table (i.e. TargetTable) with 'Append' = FALSE or "0", then the whole temporary table is deleted before the import. Not used when creating a new data table.
; 'CatchOperationExceptions'
; ConvertDataTypes
: List of SAP data types that are converted into respective data types supported by SQL Server instead of using NVARCHAR. Defined by listing the data type identifier characters in any order. Available data type identifying characters are '''IFPCDTNX'''. If not defined, all data is converted to NVARCHAR. Example: ''IFP'' (convert only numeric data types: Integer, Float, Packed number) ([[Importing_Data_from_SAP|more information]]).
; 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:
: 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.
: 1 = don't stop execution of the script, continue running the script from the next statement.
Line 450: Line 319:
:<code>@_ExceptionMessage</code> If there was an exception, contains a message that would have been displayed, NVARCHAR(MAX), otherwise NULL.
:<code>@_ExceptionMessage</code> If there was an exception, contains a message that would have been displayed, NVARCHAR(MAX), otherwise NULL.
:<code>@_ExceptionDetails</code> If there was an exception, contains the details that would have been displayed, including the system stack trace, NVARCHAR(MAX), otherwise NULL.
:<code>@_ExceptionDetails</code> If there was an exception, contains the details that would have been displayed, including the system stack trace, NVARCHAR(MAX), otherwise NULL.
 
; SapUser
'''SAP Connection Parameters:'''
; 'SapUser'
: SAP username used to connect to SAP. Mandatory. Corresponds to the "USER" constant on SAP side. See the [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
: SAP username used to connect to SAP. Mandatory. Corresponds to the "USER" constant on SAP side. See the [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
; 'SapPW'
; SapPW
: Password of the SAP user used to connect to SAP. Mandatory. Corresponds to the "PASSWD" constant on SAP side. See the [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
: Password of the SAP user used to connect to SAP. Mandatory. Corresponds to the "PASSWD" constant on SAP side. See the [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
; 'SapClient'
; SapPWKey
: [[Storing_Secrets_for_Scripts|Secret name]] for the stored SAP password. Alternative for the SapPW property.
; SapClient
: The SAP backend client. Mandatory. Corresponds to the "CLIENT" constant on SAP side. See the [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
: The SAP backend client. Mandatory. Corresponds to the "CLIENT" constant on SAP side. See the [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
; 'SapAppServerHost'
; SapAppServerHost
: 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 [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
: 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 [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
; 'SapMessageServerHost'
; SapMessageServerHost
: 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 [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
: 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 [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
; 'SapSystemNumber'
; SapSystemNumber
: The SAP system’s system number. Mandatory if SapSystemID is not defined. Corresponds to the "SYSNR" constant on SAP side. See the [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
: The SAP system’s system number. Mandatory if SapSystemID is not defined. Corresponds to the "SYSNR" constant on SAP side. See the [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
; 'SapSystemID'
; SapSystemID
: The SAP system’s three-letter system ID. Mandatory if SapSystemNumber is not defined. Corresponds to the "SYSID" constant on SAP side. See the [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
: The SAP system’s three-letter system ID. Mandatory if SapSystemNumber is not defined. Corresponds to the "SYSID" constant on SAP side. See the [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
; 'ExecuteInClientSide'
; ExecuteInClientSide
: 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.
: Defines whether the command is executed from the QPR ScriptLauncher or from the server. This parameter is used when there is no server connection available, for example. TRUE or 1, the query is executed in the QPR ScriptLauncher. FALSE or 0, the query is executed in the server. 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.
 
; SapLanguage
'''Other SAP Parameters:'''
; 'SapLanguage'
: SAP language used. Default value is "EN". Optional. Corresponds to the "LANG" constant on SAP side. See the [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
: SAP language used. Default value is "EN". Optional. Corresponds to the "LANG" constant on SAP side. See the [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
; 'SapPoolSize'
; SapPoolSize
: 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 [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
: 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 [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
; 'SapPeakConnectionsLimit'
; SapMaxPoolSize
: 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 [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
: 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 [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
; 'SapConnectionIdleTimeout'
; SapConnectionIdleTimeout
: 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 [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
: 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 [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
; 'SapRouter'
; SapRouter
: 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 [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
: 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 [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
; 'SapLogonGroup'
; SapLogonGroup
: The logon group from which the message server shall select an application server. Optional. Corresponds to the "GROUP" constant on SAP side. See the [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
: The logon group from which the message server shall select an application server. Optional. Corresponds to the "GROUP" constant on SAP side. See the [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
; 'SapQueryMode'
; SapQueryMode
: If this number 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 [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
: If this number 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 [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
; 'SapQueryTable'
; SapQueryTable
: 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 [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm 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.
: 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 [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm 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'
; SapRowcount
: 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 [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
: 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 [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
; 'SapRowskips'
; SapRowskips
: The number of rows to skip. Specifies the value for parameter ROWSKIPS in tab: 'Import' or function module 'rfc_read_table'. in SAP. Optional. See the [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
: The number of rows to skip. Specifies the value for parameter ROWSKIPS in tab: 'Import' or function module 'rfc_read_table'. in SAP. Optional. See the [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
; 'SapWhereClause'
; SapWhereClause
: 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 [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
: 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 [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
; 'SapWhereClauseSelect'
; SapWhereClauseSelect
: 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 [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.<br/>
: 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 [[QPR_ProcessAnalyzer_Logs#Script_Log|Script Log]]. See the [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.<br/>
: See also [[Data_Extraction,_Transformation,_and_Loading#Client_Exception_When_Using_.23ImportSapQuery_Command|Troubleshooting]] for other SAP related limitations.
; SapFieldNames
; 'SapFieldNames'
: 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 [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
: 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 [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
; 'SapFunction'
; SapFunction
: 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 [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
: 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 [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
; UseAnyAsColumnType
: Determines datatable column data types for the created columns. When ''true'', "Any" type of columns are created (resulting into SQL_variant columns in SQL server), and when ''false'', data types depend on the ConvertDataTypes parameter. Default value is true when running the import in SQL script, and otherwise default value is false.
;AliasUser
:
;AppServerService
:
;CharacterFaultIndicatorToken
:
;Codepage
:
;GatewayHost
:
;GatewayService
:
;IdleCheckTime
:
;LogonCheck
:
;MaxPoolWaitTime
:
;MessageServerService
:
;Name
:
;NoCompression
:
;OnCharacterConversionError
:
;PartnerCharSize
:
;PasswordChangeEnforced
:
;ProgramId
:
;R3Name
:
;RegistrationCount
:
;RepositoryDestination
:
;RepositoryPassword
:
;RepositorySncMyName
:
;RepositoryUser
:
;RepositoryX509Certificate
:
;SapSso2Ticket
:
;SncLibraryPath
:Full path including file name of the [[Importing_Data_from_SAP#SNC_encrypted_connection|SNC]] shared library to be used.
;SncMode
: Determines whether connections will be secured with [[Importing_Data_from_SAP#SNC_encrypted_connection|SNC]]. Value '''0''' doesn't use SNC (default) and value '''1''' uses SNC.
;SncMyName
:Token/identifier representing the external RFC program. In most cases this can be omitted. The installed [[Importing_Data_from_SAP#SNC_encrypted_connection|SNC]] solution usually knows its own SNC name. Only for solutions supporting “multiple identities”, you may Varies depending on the installed SNC solution (Secude, Kerberos, NTLM, etc). Example for Secude: p/secude:CN=ALEREMOT SAP Online Help 09.09.2014 SAP .NET Connector 3.0 41 need to specify the identity to be used for this particular destination/server. E, O=Mustermann-AG, C=DE
;SncPartnerName
:The backend's [[Importing_Data_from_SAP#SNC_encrypted_connection|SNC]]name.
;SncPartnerNames
:
;SncQop
:Quality of service to be used for SNC communication of this particular destination/server. One of the following values:
* 1: Digital signature
* 2: Digital signature and encryption
* 3: Digital signature, encryption, and user authentication
* 8: Default value defined by back-end system
* 9: Maximum value that the current security product supports
;SystemIds
:
;UseSapGui
:
;X509Certificate
:


== Examples ==
See examples at the [[ImportSapQuery Script Examples]] page.
See examples at the [[ImportSapQuery Script Examples]] page.


=<br/> --#ImportSqlQuery =
= --#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.
Extracts data from an ADO.Net source (which usually is an SQL Server database) and imports it to QPR ProcessAnalyzer datatable or a temporary table. Column names from the query result are used. It is possible to both create new Data Tables as well as modify existing datatables with this command. To use the ImportSqlQuery command, 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:
== 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:<br/>
; TargetTable
; 'TargetTable'
: 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.
: 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'
; ProjectId / ProjectName
: The id or the name of the project in which the target data table exists.
: The id or the name of the project in which the target data table exists.
; 'DataTableId' or 'DataTableName'
; DataTableId / DataTableName
: The id or the name of the existing/new target data table.
: The id or the name of the existing/new target data table.
; 'Append'
; Append
: Defines what to do with an existing target data table and its contents. TRUE or any other Integer than "0" = the target data table and its existing contents are not deleted before import. If a user imports into a data table with 'Append' = FALSE or "0", the contents of the data table are deleted before the import. If a user imports into a temporary table (i.e. TargetTable) with 'Append' = FALSE or "0", then the whole temporary table is deleted before the import. Not used when creating a new data table.
: Defines what to do with an existing target data table and its contents. TRUE or any other Integer than "0" = the target data table and its existing contents are not deleted before import. If a user imports into a data table with 'Append' = FALSE or "0", the contents of the data table are deleted before the import. If a user imports into a temporary table (i.e. TargetTable) with 'Append' = FALSE or "0", then the whole temporary table is deleted before the import. Not used when creating a new data table.
; 'CatchOperationExceptions'
; 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:
: 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.
: 1 = don't stop execution of the script, continue running the script from the next statement.
Line 524: Line 461:
:<code>@_ExceptionMessage</code> If there was an exception, contains a message that would have been displayed, NVARCHAR(MAX), otherwise NULL.
:<code>@_ExceptionMessage</code> If there was an exception, contains a message that would have been displayed, NVARCHAR(MAX), otherwise NULL.
:<code>@_ExceptionDetails</code> If there was an exception, contains the details that would have been displayed, including the system stack trace, NVARCHAR(MAX), otherwise NULL.
:<code>@_ExceptionDetails</code> 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
; 'SqlConnectionString'
: The SQL connection string that includes the settings needed to establish the initial connection. Mandatory. See [http://msdn.microsoft.com/en-us/library/system.data.sqlclient.sqlconnection.connectionstring%28v=vs.110%29.aspx SqlConnection.ConnectionString Property in Microsoft Development Network] for more information on the connection parameters.
: The SQL connection string that includes the settings needed to establish the initial connection. Mandatory. See [http://msdn.microsoft.com/en-us/library/system.data.sqlclient.sqlconnection.connectionstring%28v=vs.110%29.aspx SqlConnection.ConnectionString Property in Microsoft Development Network] for more information on the connection parameters.
; 'SqlQueryString'
; SqlQueryString
: 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.
: 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'
; QueryExecutionTimeout
: 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.
: Defines timeout in seconds for the SQL command execution. If not specified, default value is 600 seconds.
; ExecuteInClientSide
: Defines whether the command is executed from the QPR ScriptLauncher or from the server. This parameter is used when there is no server connection available, for example. TRUE or 1, the query is executed in the client side. FALSE or 0, the query is executed in the server 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.


== Examples ==
See examples at the [[ImportSqlQuery Script Examples]] page.
See examples at the [[ImportSqlQuery Script Examples]] page.


= --#RemoveCases =
= --#Run =
Removes all or specified cases in the target model. This command takes two SELECT queries as parameters.
Runs another script with specified parameters. This command can take multiple SELECT queries which are passed as parameters to the called script. The first SELECT configures the script call by defining the script id to be called.
== 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:<br/>
; '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:
: <code>@_ExceptionOccurred</code> If there was an exception, then this value is 1, otherwise 0. INT
: <code>@_ExceptionType</code> If there was an exception, shows the C# class name for the exception, NVARCHAR(MAX), otherwise NULL.
: <code>@_ExceptionMessage</code> If there was an exception, contains a message that would have been displayed, NVARCHAR(MAX), otherwise NULL.
: <code>@_ExceptionDetails</code> 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 cases to be removed. Note that if there are several columns in the query, the cases have to be in the first column of the query. If the second query is not given, all cases are removed from the model. If the result of the second query is empty, no cases are removed. Removing a case also removes all events and case attributes associated with the case.


== Examples ==
See examples at the [[RemoveCases Script Examples]] page.
=<br/> --#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 ==
== 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:<br/>
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:<br/>
; 'ProjectId' or 'ProjectName'
; ScriptId
: The id or the name of the project in which the target model exists. Defaults to the current project.
: Mandatory. The Id of the called script.
; 'ModelId' or 'ModelName'
; CatchOperationExceptions
: 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:
: 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.
: 1 = don't stop execution of the script, continue running the script from the next statement.
Line 577: Line 489:
: <code>@_ExceptionDetails</code> If there was an exception, contains the details that would have been displayed, including the system stack trace, NVARCHAR(MAX), otherwise NULL.
: <code>@_ExceptionDetails</code> 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 ==
See examples at the [[RemoveEvents Script Examples]] page.
=<br/> --#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:<br/>
; '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:
: <code>@_ExceptionOccurred</code> If there was an exception, then this value is 1, otherwise 0. INT
: <code>@_ExceptionType</code> If there was an exception, shows the C# class name for the exception, NVARCHAR(MAX), otherwise NULL.
: <code>@_ExceptionMessage</code> If there was an exception, contains a message that would have been displayed, NVARCHAR(MAX), otherwise NULL.
: <code>@_ExceptionDetails</code> If there was an exception, contains the details that would have been displayed, including the system stack trace, NVARCHAR(MAX), otherwise NULL.
== Following Queries ==
== Following Queries ==
The following 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.
Subsequent queries are optional and they are used for passing parameters to the called script. Maximum number of arguments is 10.  Each argument is created as a temporary table with names '''#_Arg1''', '''#_Arg2''', '''#_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.
The possible arguments are as follows:
The possible arguments are as follows:
:* @_Argv - type INT: the number of provided parameters (from 0 to 10)
* '''@_Argv''': Number of provided parameters (between 0 to 10) (type iNT)
:* #_Arg1, ... #_Arg10: arguments passed to that script
* '''#_Arg1''', '''#_Arg2''', ... '''#_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.
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 ==
See examples at the [[Run Script Examples]] page.
See examples at the [[Run Script Examples]] page.
= --#RunQuery =
Runs an [[Web_API:_Expression/query|expression language query]], and stores results to a [[QPR_ProcessAnalyzer_Project_Workspace#Datatables|datatable]] or to a temporary table in the scripting database. Following parameters can be used in the command:
* '''Configuration''': Expression language query to run, written in JSON as specified in [[Web_API:_Expression/query|Web API: Expression/query]]. Queries can be created by using a [[QPR_ProcessAnalyzer_Chart|chart]] where to open the '''Query''' (in the '''Advanced''' tab). It will show the query made by chart that's compatible with what can be specified in the ''Configuration'' parameter.
* '''TargetTable''': When specified, results are stored to a temporary table with that name in the scripting sandbox. The temporary table can be read using the subsequent commands. When the script ends, temporary tables are automatically removed.
* '''DatatableId''': When specified, data is stored to the defined existing datatable. When using datatable id, ProjectName or ProjectId parameter don't need to be defined.
* '''DataTableName''': When specified, data is stored to the datatable with that name, located in the same project as the script. If you want to use different project, specify either the ProjectName or ProjectId parameter.
* '''ProjectName''': Specifies a project by name where the results datatable is stored. Used together with the DataTableName parameter.
* '''ProjectId''': Specifies a project by id where the results datatable is stored. Used together with the DataTableName parameter.
See [[RunQuery Script Examples]].


= --#SendEmail =
= --#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.  
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:<br/>
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:<br/>
; 'CatchOperationExceptions'
; 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:
: 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.
: 1 = don't stop execution of the script, continue running the script from the next statement.
Line 625: Line 524:
:<code>@_ExceptionDetails</code> If there was an exception, contains the details that would have been displayed, including the system stack trace, NVARCHAR(MAX), otherwise NULL.
:<code>@_ExceptionDetails</code> 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'''
'''E-mail Parameters'''
; 'EmailFrom'
; EmailFrom
: Defines the from address for this e-mail message. Mandatory.
: Defines the from address for this e-mail message. Mandatory.
; 'EmailTo'
; EmailTo
: Defines the recipient(s) for this e-mail message given in a list separated by comma. Mandatory.
: Defines the recipient(s) for this e-mail message given in a list separated by comma. Mandatory.
; 'EmailSubject'
; EmailSubject
: Defines the subject of the email. Default value is empty. Optional.
: Defines the subject of the email. Default value is empty. Optional.
; 'EmailBody'
; EmailBody
: Defines the message body. Default value is empty. Optional.
: Defines the message body. Default value is empty. Optional.
; 'EmailCc'
; EmailCc
: Defines the carbon copy recipient(s) for this e-mail message given in a list separated by comma. Optional.
: Defines the carbon copy recipient(s) for this e-mail message given in a list separated by comma. Optional.
; 'EmailBcc'
; EmailBcc
: Defines the blind carbon copy recipient(s) for this e-mail message given in a list separated by comma. Optional.
: Defines the blind carbon copy recipient(s) for this e-mail message given in a list separated by comma. Optional.
; 'EmailIsBodyHtml'
; 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.
: 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'
; EmailSender
: Defines the sender's address for this e-mail message. Default value is empty. Optional.
: Defines the sender's address for this e-mail message. Default value is empty. Optional.
; 'EmailReplyTo'
; EmailReplyTo
: Defines the ReplyTo address(es) for the mail message given in a list separated by comma. Optional.
: Defines the ReplyTo address(es) for the mail message given in a list separated by comma. Optional.
; 'EmailPriority',
; EmailPriority
: Defines the priority of this e-mail message. Possible values are "High", "Normal", and "Low". Default value is "Normal". Optional.
: Defines the priority of this e-mail message. Possible values are "High", "Normal", and "Low". Default value is "Normal". Optional.
; 'EmailDeliveryNotification'
; EmailDeliveryNotification
: Defines the delivery notifications for this e-mail message. Possible values are "Delay", "Never", "None", "OnFailure", and "OnSuccess". Default value is "None". Optional.
: Defines the delivery notifications for this e-mail message. Possible values are "Delay", "Never", "None", "OnFailure", and "OnSuccess". Default value is "None". Optional.
; 'EmailBodyEncoding'
; 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.
: 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. UTF8 is used by default. Optional.
; 'EmailSubjectEncoding'
; 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.
: 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. UTF8 is used by default. Optional.
; 'EmailAttachmentQuery'
; EmailAttachmentQuery
: Defines a query to fetch the parameters for adding attachments to the email. Each row (except the header row)  in the query result corresponds to one attachment. The result must contain the following columns in this order: Name of the attachment, Content for the attachment (Sent as-is without any modifications. Supports binary values.), Media type (supported types are text/plain, text/html, text/xml, and image/jpeg), and Creation time (SQL datetime). Names of the columns do not matter. If the result doesn't contain some of the columns, an error is written into the Progress log, and the email is not sent. Optional.
: Defines a query to fetch the parameters for adding attachments to the email. Each row (except the header row)  in the query result corresponds to one attachment. The result must contain the following columns in this order: Name of the attachment, Content for the attachment (Sent as-is without any modifications. Supports binary values.), Media type (supported types are text/plain, text/html, text/xml, and image/jpeg), and Creation time (SQL datetime). Names of the columns do not matter. If the result doesn't contain some of the columns, an error is written into the Progress log, and the email is not sent. Optional.


'''SMTP Server Parameters'''
'''SMTP Server Parameters'''
; 'SmtpServer'
; SmtpServer
: Defines the hostname or the IP address of the server. Mandatory for the first occurrence of the SendEmail command during script execution.
: Defines the hostname or the IP address of the server. Mandatory for the first occurrence of the SendEmail command during script execution.
; 'SmtpPort'
; SmtpPort
: Defines the port of the SMTP server. Default value is "25". Optional.
: Defines the port of the SMTP server. Default value is "25". Optional.
; 'SmtpAuthenticationUsername'
; 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.
: 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'
; 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.
: 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'
; 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.
: 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.


== Example ==
See examples at the [[SendEmail Script Examples]] page.
See examples at the [[SendEmail Script Examples]] page.


See also [[How to Define the SMTP Server Connection in an On-Site Deployment]].
= --#ShowReport =
 
Outputs result of an SQL query to a CSV file when running script from [[QPR_ProcessAnalyzer_ScriptLauncher|QPR ProcessAnalyzer ScriptLauncher]]. This command takes two SELECT queries as parameters.
=<br/> --#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.
'''Note:''' Excel cannot handle more than 1 million rows to be shown so if the result set contains more rows than that, the data will be truncated to 1 million rows.
 
This command takes two SELECT queries as parameters.
== First Query ==
== First Query ==
A user specified SQL query to be shown in the configured Excel sheet.  
SQL query which results are shown.  
; <nowiki>'<data>'</nowiki>
; <nowiki><data></nowiki>
: Mandatory. The database query whose results are to be returned.
: Mandatory. The database query whose results are to be returned.


== Second Query ==
== Second 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:<br/>
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:<br/>
; '<Analysis Parameter>'
; <Analysis Parameter>
: Optional. The [[Analysis Parameters]] given for the operation. Some suggested parameters to be used:
: Optional. The analysis parameters given for the operation. Some suggested parameters to be used:
:; 'Title'
:; Title
:: The title of the created report. If not given, "Report" will be used as a default.
:: The name of the created CSV file.
:; 'SheetName'
:; MaximumCount
:: The name of the Excel sheet to be created.
:; 'MaximumCount'
:: The maximum number of rows to show (0 = all, default = 1000).
:: The maximum number of rows to show (0 = all, default = 1000).
{{Template:PivotSheet}}
 
; '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:
; 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.
: 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.
: 0 = stop execution of the current script and show the exception.
Line 701: Line 592:
:<code>@_ExceptionDetails</code> If there was an exception, contains the details that would have been displayed, including the system stack trace, NVARCHAR(MAX), otherwise NULL.
:<code>@_ExceptionDetails</code> If there was an exception, contains the details that would have been displayed, including the system stack trace, NVARCHAR(MAX), otherwise NULL.


== Example ==
See examples at the [[ShowReport Script Examples]] page.
See examples at the [[ShowReport Script Examples]] page.


=<br/> --#StartBackground =
= --#StartBackground =
Makes the script be run in background starting from this command, so that using QPR ProcessAnalyzer Excel client is possible while the script is running.<br/>
Continues the script run in background, i.e. the parent script execution completes and the rest of the script execution continues. When running a script in the background, it cannot output any results using the ShowReport command or GetAnalysis with the Show parameter. It's possible to terminate scripts that run in the background via the [[QPR_ProcessAnalyzer_Logs#Task_Log|Task log]]. No also that a script running in the background cannot execute in the client side mode.
The script results are returned to the Excel Client user interface (e.g. when ShowReport is reached in the script) before the StartBackground command is reached. Operations (e.g. ShowReport) resulting into adding new analysis results into the script run results after the StartBackground command is reached are executed, but the results are ignored, and in such cases an error is written into the [[Script Log]]. Any exceptions causing the script run to fail while running the script in the background are written into the Script Log and the [[Operation Log]]. It's possible to terminate scripts that run in the background via the Operation Log.<br/>
 
If an import operation specified in the script requires execution in the client side, the client side execution is ignored and a warning is written into the Script Log.<br/>
Takes one SELECT query as a parameter. Following parameter is supported:
This command is supported only for QPR ProcessAnalyzer Service based data source connections (i.e. not supported for Xpress or Database activations).<br/>
Takes one SELECT query as a parameter.


== Query ==
; Enabled
; 'Enabled'
: Boolean value defining whether the script is run in background starting from this command. TRUE = run in background, FALSE = don't run in background. Default value is TRUE.
: Boolean value defining whether the script is run in background starting from this command. TRUE = run in background, FALSE = don't run in background. Default value is TRUE.


== Examples ==
See examples at the [[StartBackground Script Examples]] page.
See examples at the [[StartBackground Script Examples]] page.


=<br/> --#WriteLog =
= --#WriteLog =
Adds the first column values from the preceding SQL statements to the log that is shown after the whole script execution is completed.
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 [https://docs.microsoft.com/en-us/sql/t-sql/language-elements/print-transact-sql?view=sql-server-ver15 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.


In addition to the WriteLog command, you can also use the [http://msdn.microsoft.com/en-us/library/ms176047.aspx 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.
See examples at the [[WriteLog Script Examples]] page.


== Examples ==
__NOTOC__
See examples at the [[WriteLog Script Examples]] page.
[[Category: QPR ProcessAnalyzer]]

Latest revision as of 14:20, 24 January 2024

This page lists QPR ProcessAnalyzer commands that can be used in the SQL scripts. Each command precedes one or two SQL queries, which sets parameters for the command or defines the data used by the command.

--#CallWebService

Extracts data via Web Service. This command takes one SELECT query as 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:

Address
Defines the URI of the service to call. Mandatory.
Method
Defines the HTTP method to use for the call. Must be any of the following: GET (default), POST, PUT, DELETE. Optional.
Body
Defines the message body text to send to the service. Default value is empty. Optional.
Encoding
Defines the encoding method to use. The supported options are listed in https://msdn.microsoft.com/en-us/library/system.text.encoding%28v=vs.110%29.aspx. Default value is UTF8. Optional.
Timeout
Number of milliseconds to wait before the request times out. Default value is 60000. Optional.
ExecuteInClientSide
Defines whether the web service call is made from the QPR ScriptLauncher or from the server. TRUE or 1, the call is executed in the ScriptLauncher. FALSE or 0, the call is executed in the server. Default value is FALSE. Optional.
DefaultNetworkCredentials
Optional. Defines the possibility to use default network credentials in web service calls:
1 = use the default network credentials.
0 = don't use the default network credentials.
If CallWebService command is run in the server side (ExecuteInClientSide=False), the default network credentials can be used only if in the server configuration AllowForwardingNetworkCredentials is true (it is false by default). Otherwise, if the CallWebService command is run in the client side (ExecuteInClientSide=True), the default network credentials can always be 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.
<other parameters>
All the rest of the passed parameters not listed above are added as extra headers to the request. For example, Content-Type and Accept HTTP headers can be added. Optional.

Result

The result of the request is passed to the script following the CallWebService operation in the following variables:

@_ResponseText The response text received from the remote server. If there was an error in processing the request, this will contain the received error message. NVARCHAR(MAX).
@_ResponseStatusCode The numeric status code received from the remote server. INT.
@_ResponseSuccess True only if the request returned status code that represents a success. BIT.

See examples at the CallWebService Script Examples page.

--#Commit

Commits the currently open SQL transaction in the sandbox database and starts a new transaction. The commit command can be executed at any point in the script. Note that the command does not have any parameters, i.e. there is no preceding SELECT statement before the --#Commit statement.

If the commit command is not used, the database transaction in the sandbox database is committed when the script is completed. On the other hand, if the script execution encounters an error, the SQL transaction is rolled back.

The commit command is useful in following circumstances:

  • If the sandbox database is configured to allow storing permanent objects, commit can be used to preserve changes even if the script execution encounters an error.
  • When the scripting is handling large amount of data, it's better to make commits during the script run, so that the database transaction log doesn't grow too large.
  • Committing changes makes them visible for other users in the database.

Example:

--#Commit

--#Exit

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

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.

See examples at the Exit Script Examples page.

--#GetAnalysis

--#GetAnalysis command is deprecated and it will be removed in a future release. Use the more flexible --#RunQuery command instead.

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. Contains information about the scripts that are running and have been run.​

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>
The --#GetAnalysis command supports the following analysis types:
  • DataTableAnalysis=18: Reads a data table from SQL server and stores it in temporary table​
  • Etl=19
  • EtlReport=20
  • RunScript=25
  • ExpressionAnalysis=33
TargetTable
The temporary table to which the analysis is to be stored. When the TargetTable parameter is used, the "Table" result type of the ForceAnalysisResultType parameter is also automatically used. If the specified temporary table already exists in the database then its contents are deleted before storing analysis.
Show
Optional. If TRUE or 1, the analysis is opened after the script is run. If the Show parameter is set to TRUE or 1 and the TargetTable parameter is used in the same GetAnalysis command, the analysis result is stored in the target table in tabular format.
Title
Optional. Name of the CSV file created when Show is TRUE or 1. Default value is the name of the analysis type.
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.
MaximumCount
Used with Operation Log Analysis analysis type. Integer. The maximum amount of rows returned. Optional. Default value is 1000.

See examples at the GetAnalysis Script Examples page.

--#ImportDataTable

Imports data from an SQL query to a datatable. 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 contents of the target datatable. When value is 1, existing rows in the target datatable are not deleted (also new columns in the imported data are created to the datatable). When value is 0, existing rows in the target datatable are deleted before the import (columns are still preserved). 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 datatable is not created.

See examples at the ImportDataTable Script Examples page.

--#ImportOdbcQuery

Extracts data from an ODBC data source and imports it to QPR ProcessAnalyzer datatable or temporary table. Column names from the query result as used. 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. To use ImportOdbcQuery, define 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:

TargetTable
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 / ProjectName
The id or the name of the project in which the target data table exists.
DataTableId / DataTableName
The id or the name of the existing/new target data table.
Append
Defines what to do with an existing target data table and its contents. TRUE or any other Integer than "0" = the target data table and its existing contents are not deleted before import. If a user imports into a data table with 'Append' = FALSE or "0", the contents of the data table are deleted before the import. If a user imports into a temporary table (i.e. TargetTable) with 'Append' = FALSE or "0", then the whole temporary table is 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.
OdbcConnectionString
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.
OdbcConnectionStringKey
Secret name for the connection string. Alternative for the OdbcConnectionString property.
OdbcQueryString
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.
QueryExecutionTimeout
Defines timeout in seconds for the ODBC command execution. If not specified, default value is 600 seconds.
ExecuteInClientSide
Defines whether the command is executed from the QPR ScriptLauncher or from the server. This parameter is used when there is no server connection available, for example. TRUE or 1, the query is executed in the QPR ScriptLauncher. FALSE or 0, the query is executed in the server. 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 1, you will receive an error message. Optional. Default value is FALSE.

See examples in the ImportOdbcQuery Script Examples page.

--#ImportOleDbQuery

Extracts data from an OLE DB data source and imports it to QPR ProcessAnalyzer datatable or a temporary table. Column names from the query result are used. It is possible to both create new datatables as well as modify existing datatables with this command. To use the ImportOleDbQuery, define 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:

TargetTable
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 / ProjectName
The id or the name of the project in which the target data table exists.
DataTableId / DataTableName
The id or the name of the existing/new target data table.
Append
Defines what to do with an existing target data table and its contents. TRUE or any other Integer than "0" = the target data table and its existing contents are not deleted before import. If a user imports into a data table with 'Append' = FALSE or "0", the contents of the data table are deleted before the import. If a user imports into a temporary table(i.e. TargetTable) with 'Append' = FALSE or "0", then the whole temporary table is 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.
OleDbConnectionString
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
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.
QueryExecutionTimeout
Defines timeout in seconds for the OLE DB command execution. If not specified, default value is 600 seconds.
ExecuteInClientSide
Defines whether the command is executed from the QPR ScriptLauncher or from the server. This parameter is used when there is no server connection available, for example. TRUE or 1, the query is executed in the QPR ScriptLauncher. FALSE or 0, the query is executed in the server. 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.

See examples at the ImportOleDbQuery Script Examples page.

--#ImportSalesforceQuery

Extracts data from the Salesforce cloud using its REST API and imports the data to a datatable. The command takes one SELECT query as its parameter. If the query doesn't return any data, the target data table or temporary table is not created.

More information about the Salesforce REST API: https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/intro_rest.htm.

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:

TargetTable
Temporary table to which the data is imported. If not used, define the target using the ProjectId/ProjectName, DataTableId/DataTableName, and Append parameters described below.
ProjectId / ProjectName
Id or the name of the project in which the target datatable is located.
DataTableId / DataTableName
Id or the name of the target data table. If DataTableName is used, the ProjectId or ProjectName can also be used to define the project where the datatable is located.
Append
Defines what to do with an existing target data table contents. TRUE or 1, existing contents of the target datatable is not deleted in the import. When FALSE or 0, existing contents of the target datatable are deleted before importing new data. 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.
SalesforceUser
Username for the Salesforce cloud.
SalesforcePW
Password for the Salesforce cloud.
SalesforcePWKey
Secret name for the stored Salesforce password. Alternative for the SalesforcePW property.
SalesforceUrl
Optional. Salesforce web service url.
SalesforceQueryMode
Optional. Determines which Salesforce query function to use. One of the following values (1, 2 or 3) can be used:
1: QueryAll (default): Executes specified SOQL query, except unlike Query, QueryAll returns records that are deleted because of a merge or delete. More information: https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_queryall.htm.
2: Query: Executes the specified SOQL query. More information: https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_query.htm)
3: sObject Describe: Completely describes the individual metadata at all levels for the specified object. For example, this can be used to retrieve the fields, URLs, and child relationships for the Account object. More information: https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_sobject_describe.htm).
SalesforceQuery
Query to run in the Salesforce cloud to fetch the data, defined as SOQL (Salesforce Object Query Language). More information: https://developer.salesforce.com/docs/atlas.en-us.236.0.soql_sosl.meta/soql_sosl/sforce_api_calls_soql_sosl_intro.htm.
SalesforceQueryRetries
Optional. Number of retries to attempt if the Salesforce query doesn't succeed. Default value is 3.
SalesforceQueryRetryWait
Optional. Number of milliseconds to wait between query retries. Default is 3000 ms.
SalesforceBatchSize
Optional. Data is queried from Salesforce in batches, and this setting determines the batch size. The value can be between 200 and 2000, and the default value is 500.

Notes

If you get error INVALID_TYPE sObject type 'Objectname' is not supported:

  • Check that the object in question exists or that the object name is correct.
  • Verify that the Salesforce user has rights to the object.
  • The Salesforce user may need extra license to access the object. Special 3rd party custom objects may need separate license. Contact your Salesforce application administrator.

See examples at the ImportSalesforceQuery Script Examples page.

--#ImportSapQuery

Extracts data from an SAP system and imports it to QPR ProcessAnalyzer datatable or a temporary table. Column names from the query result are used. 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 installing SAP NetWeaver RFC Library.

To use the ImportSapQuery command, define 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:

TargetTable
If this parameter is given, store the results into a temporary SQL table in the ETL sandbox. If the TargetTable parameter is not given, use either the ProjectId or ProjectName parameters.
ProjectId / ProjectName
The id or the name of the project in which the target data table exists.
DataTableId / DataTableName
The id or the name of the existing/new target data table.
Append
Defines what to do with an existing target data table and its contents. TRUE or any other Integer than "0" = the target data table and its existing contents are not deleted before import. If a user imports into a data table with 'Append' = FALSE or "0", the contents of the data table are deleted before the import. If a user imports into a temporary table (i.e. TargetTable) with 'Append' = FALSE or "0", then the whole temporary table is deleted before the import. Not used when creating a new data table.
ConvertDataTypes
List of SAP data types that are converted into respective data types supported by SQL Server instead of using NVARCHAR. Defined by listing the data type identifier characters in any order. Available data type identifying characters are IFPCDTNX. If not defined, all data is converted to NVARCHAR. Example: IFP (convert only numeric data types: Integer, Float, Packed number) (more information).
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.
SapUser
SAP username 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 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.
SapPWKey
Secret name for the stored SAP password. Alternative for the SapPW property.
SapClient
The SAP backend client. Mandatory. Corresponds to the "CLIENT" constant on SAP side. See the SAP .NET Connector documentation for more info.
SapAppServerHost
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
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
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
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
Defines whether the command is executed from the QPR ScriptLauncher or from the server. This parameter is used when there is no server connection available, for example. TRUE or 1, the query is executed in the QPR ScriptLauncher. FALSE or 0, the query is executed in the server. 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.
SapLanguage
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
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.
SapMaxPoolSize
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
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 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
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
If this number 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 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
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
The number 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
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
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
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
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.
UseAnyAsColumnType
Determines datatable column data types for the created columns. When true, "Any" type of columns are created (resulting into SQL_variant columns in SQL server), and when false, data types depend on the ConvertDataTypes parameter. Default value is true when running the import in SQL script, and otherwise default value is false.
AliasUser
AppServerService
CharacterFaultIndicatorToken
Codepage
GatewayHost
GatewayService
IdleCheckTime
LogonCheck
MaxPoolWaitTime
MessageServerService
Name
NoCompression
OnCharacterConversionError
PartnerCharSize
PasswordChangeEnforced
ProgramId
R3Name
RegistrationCount
RepositoryDestination
RepositoryPassword
RepositorySncMyName
RepositoryUser
RepositoryX509Certificate
SapSso2Ticket
SncLibraryPath
Full path including file name of the SNC shared library to be used.
SncMode
Determines whether connections will be secured with SNC. Value 0 doesn't use SNC (default) and value 1 uses SNC.
SncMyName
Token/identifier representing the external RFC program. In most cases this can be omitted. The installed SNC solution usually knows its own SNC name. Only for solutions supporting “multiple identities”, you may Varies depending on the installed SNC solution (Secude, Kerberos, NTLM, etc). Example for Secude: p/secude:CN=ALEREMOT SAP Online Help 09.09.2014 SAP .NET Connector 3.0 41 need to specify the identity to be used for this particular destination/server. E, O=Mustermann-AG, C=DE
SncPartnerName
The backend's SNCname.
SncPartnerNames
SncQop
Quality of service to be used for SNC communication of this particular destination/server. One of the following values:
  • 1: Digital signature
  • 2: Digital signature and encryption
  • 3: Digital signature, encryption, and user authentication
  • 8: Default value defined by back-end system
  • 9: Maximum value that the current security product supports
SystemIds
UseSapGui
X509Certificate

See examples at the ImportSapQuery Script Examples page.

--#ImportSqlQuery

Extracts data from an ADO.Net source (which usually is an SQL Server database) and imports it to QPR ProcessAnalyzer datatable or a temporary table. Column names from the query result are used. It is possible to both create new Data Tables as well as modify existing datatables with this command. To use the ImportSqlQuery command, 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:

TargetTable
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 / ProjectName
The id or the name of the project in which the target data table exists.
DataTableId / DataTableName
The id or the name of the existing/new target data table.
Append
Defines what to do with an existing target data table and its contents. TRUE or any other Integer than "0" = the target data table and its existing contents are not deleted before import. If a user imports into a data table with 'Append' = FALSE or "0", the contents of the data table are deleted before the import. If a user imports into a temporary table (i.e. TargetTable) with 'Append' = FALSE or "0", then the whole temporary table is 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.
SqlConnectionString
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
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.
QueryExecutionTimeout
Defines timeout in seconds for the SQL command execution. If not specified, default value is 600 seconds.
ExecuteInClientSide
Defines whether the command is executed from the QPR ScriptLauncher or from the server. This parameter is used when there is no server connection available, for example. TRUE or 1, the query is executed in the client side. FALSE or 0, the query is executed in the server 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.

See examples at the ImportSqlQuery Script Examples page.

--#Run

Runs another script with specified parameters. This command can take multiple SELECT queries which are passed as parameters to the called script. The first SELECT configures the script call by defining the script id to be called.

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.

Following Queries

Subsequent queries are optional and they are used for passing parameters to the called script. Maximum number of arguments is 10. Each argument is created as a temporary table with names #_Arg1, #_Arg2, #_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. The possible arguments are as follows:

  • @_Argv: Number of provided parameters (between 0 to 10) (type iNT)
  • #_Arg1, #_Arg2, ... #_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.

See examples at the Run Script Examples page.

--#RunQuery

Runs an expression language query, and stores results to a datatable or to a temporary table in the scripting database. Following parameters can be used in the command:

  • Configuration: Expression language query to run, written in JSON as specified in Web API: Expression/query. Queries can be created by using a chart where to open the Query (in the Advanced tab). It will show the query made by chart that's compatible with what can be specified in the Configuration parameter.
  • TargetTable: When specified, results are stored to a temporary table with that name in the scripting sandbox. The temporary table can be read using the subsequent commands. When the script ends, temporary tables are automatically removed.
  • DatatableId: When specified, data is stored to the defined existing datatable. When using datatable id, ProjectName or ProjectId parameter don't need to be defined.
  • DataTableName: When specified, data is stored to the datatable with that name, located in the same project as the script. If you want to use different project, specify either the ProjectName or ProjectId parameter.
  • ProjectName: Specifies a project by name where the results datatable is stored. Used together with the DataTableName parameter.
  • ProjectId: Specifies a project by id where the results datatable is stored. Used together with the DataTableName parameter.

See RunQuery Script Examples.

--#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.

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
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. UTF8 is used by default. 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. UTF8 is used by default. Optional.
EmailAttachmentQuery
Defines a query to fetch the parameters for adding attachments to the email. Each row (except the header row) in the query result corresponds to one attachment. The result must contain the following columns in this order: Name of the attachment, Content for the attachment (Sent as-is without any modifications. Supports binary values.), Media type (supported types are text/plain, text/html, text/xml, and image/jpeg), and Creation time (SQL datetime). Names of the columns do not matter. If the result doesn't contain some of the columns, an error is written into the Progress log, and the email is not sent. 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.

See examples at the SendEmail Script Examples page.

--#ShowReport

Outputs result of an SQL query to a CSV file when running script from QPR ProcessAnalyzer ScriptLauncher. This command takes two SELECT queries as parameters.

First Query

SQL query which results are shown.

<data>
Mandatory. The database query whose results are to be returned.

Second 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>
Optional. The analysis parameters given for the operation. Some suggested parameters to be used:
Title
The name of the created CSV file.
MaximumCount
The maximum number of rows to show (0 = all, default = 1000).
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.

See examples at the ShowReport Script Examples page.

--#StartBackground

Continues the script run in background, i.e. the parent script execution completes and the rest of the script execution continues. When running a script in the background, it cannot output any results using the ShowReport command or GetAnalysis with the Show parameter. It's possible to terminate scripts that run in the background via the Task log. No also that a script running in the background cannot execute in the client side mode.

Takes one SELECT query as a parameter. Following parameter is supported:

Enabled
Boolean value defining whether the script is run in background starting from this command. TRUE = run in background, FALSE = don't run in background. Default value is TRUE.

See examples at the StartBackground Script Examples page.

--#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.

See examples at the WriteLog Script Examples page.