QPR ProcessAnalyzer Wiki - User contributions [en]

QPR ProcessAnalyzer ScriptLauncher

2021-11-15T11:45:37Z

VesKivi: /* Installing SAP Connector for ScriptLauncher */

'''QPR ProcessAnalyzer ScriptLauncher''' is a tool to run QPR ProcessAnalyzer scripts stored in the QPR ProcessAnalyzer Server, while enabling connections to datasouces from the site where the ScriptLauncher is running, e.g. on-premise.

== Installing ScriptLauncher ==
Follow these instructions to install QPR ProcessAnalyzer ScriptLauncher:
# Install .Net Framework 4.7.1 or later (https://dotnet.microsoft.com/download/dotnet-framework).
# Download QPR ProcessAnalyzer ScriptLauncher from the [[QPR_Product_Downloads|downloads page]], and extract the package into a suitable location where to place the ScriptLaucher application files.
# If you need to extract data from SAP using the RFC interface, you need to install the [[#Installing SAP Connector for ScriptLauncher|SAP Connector for .Net]].
# Configure ScriptLauncher according to the instructions in the [[#Configuring_ScriptLauncher|next chapter]].
# Installation is now completed. Run scripts using ScriptLauncher by following instructions in the [[#Running_ScriptLauncher|chapter below]].

== Installing SAP Connector for ScriptLauncher ==
Extracting data from SAP using the SAP RFC interface requires to install SAP Connector for Microsoft .NET 3.0 using the following steps:
# SAP connector requires '''Microsoft Visual C++ Redistributable Package 2013''' (download: https://support.microsoft.com/en-us/topic/update-for-visual-c-2013-redistributable-package-d8ccd6a5-4e26-c290-517b-8da6cfdf4f10). Restart the computer after the Microsoft Visual C++ Redistributable Package installation.
# Download '''SAP Connector for Microsoft .NET 3.0 for Windows 64bit (x64)''' from SAP Support Portal (https://support.sap.com/en/product/connectors/msnet.html) (login credentials and sufficient permissions needed).
# Run the SAP Connector for Microsoft .NET 3.0 for Windows 64bit (x64) installer.
# Copy the '''sapnco.dll''' and '''sapnco_utils.dll''' files from '''C:\Program Files (x86)\SAP\SAP_DotNetConnector3_x64''' (this folder has been created by the SAP Connector for Microsoft .NET 3.0 installation) to the folder containing the ScriptLauncher application files.

Note: If you get error ''Could not load file or assembly 'sapnco_utils.dll' or one of its dependencies or ''File Not Found Error''. The specified module could not be found'', the reason might be that the MSVCR100.dll file is missing and solution is install '''Microsoft Visual C++ 2010 Service Pack 1 Redistributable Package MFC Security Update'''' (download https://www.microsoft.com/en-us/download/details.aspx?id=26999). If the problem still persists, verify that the MSVCR100.dll is included in windows PATH.

==Configuring ScriptLauncher==
Before you can start running scripts with QPR ProcessAnalyzer ScriptLauncher, you need to configure connection and other parameters for the tool. You need to have write access to the ScriptLauncher folder, which contains the ScriptLauncher's configuration file Qpr.ProcessAnalyzer.ScriptLauncher.exe.config.

# Open the '''Qpr.ProcessAnalyzer.ScriptLauncher.exe.config''' file in a text editor.
# In the file, go to the section starting with '''<Qpr.ProcessAnalyzer.ScriptLauncher.Properties.Settings>''' and configure the values for the following parameters:
#* '''LogOnName''': QPR ProcessAnalyzer username
#* '''Password''': QPR ProcessAnalyzer password
#* '''ServiceUrl''': QPR ProcessAnalyzer server url
#* '''ScriptId''': Id of the script to run. You can copy the ID from the Scripts tab in the Workspace.
#* '''OutputDirectory''': folder where to store the created [[QPR_ProcessAnalyzer_ScriptLauncher#CSV_Export|CSV export files]]. If the folder doesn't exist, it will be created.
#* '''ProjectId''': Project id
#* '''ModelId''': Model id
#* '''ConnectionType''': Use value ''Service'' for QPR ProcessAnalyzer versions up to 2021.8. Starting from QPR ProcessAnalyzer 2021.8, use value ''WebApi''.
#* '''Parameters''': passes defined custom parameters to the script. The script should have corresponding '''@_Parameter_<ParameterName>''' variables to use the script. Add the following new setting sections to the configuration file to pass custom parameters (parameter1 and parameter2):
<pre>
<setting name="Parameters" serializeAs="Xml">
<value>
<ArrayOfString xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<string>parameter1=value1</string>
<string>parameter2=value2</string>
</ArrayOfString>
</value>
</setting>
</pre>

It's possible to add more than one string. The type of the parameter value is always NVARCHAR.

In case you want to change location of the log file that will be created, you can do that by changing the value of the parameter '''LogFilePath''' in the following section of the configuration file:
<pre>
<applicationSettings>
<Qpr.ProcessAnalyzer.Common.Properties.Settings>
<setting name="LogFilePath" serializeAs="String">
<value>.\Qpr.ProcessAnalyzer.ScriptLauncher.log</value>
</setting>
</Qpr.ProcessAnalyzer.Common.Properties.Settings>
</applicationSettings>
</pre>

Note that the log folder needs to exist before running QPR ProcessAnalyzer ScriptLauncher and you must have rights to write to that folder. By default, the log file will be stored in the same folder as the configuration file.

== Running ScriptLauncher ==
After ScriptLauncher has been configured, '''Qpr.ProcessAnalyzer.ScriptLauncher.exe''' executable file can be run which is located in the ScriptLauncher folder. In addition to the configuration file, all parameters can also be specified in the command line when running the ScriptLauncher. The command line parameters will override the settings in the configuration file. The parameter names are case sensitive. To specify a parameter in the command line, use the following format (note that all custom parameters must start with "Parameter_":
<pre>
-Parameter_<ParameterName>=<SettingValue>
</pre>
For example:
<pre>
Qpr.ProcessAnalyzer.ScriptLauncher.exe -ScriptId=123 -ModelId=12345 -Parameter_MyParameter1=myValue1 -Parameter_MyParameter2="my value 2"
</pre>

Parameters that contain special characters, such as whitespaces, must be escaped by using double quotes. For example:
<pre>
-LogFilePath="C:\Temp\Path to My Log Files\ScriptLauncherDir\"
</pre>

== Connecting through proxy ==
QPR ProcessAnalyzer ScriptLauncher can also be used through a manually configured proxy server. Proxy settings are configured to the '''Qpr.ProcessAnalyzer.ScriptLauncher.exe.config''' file stored into the QPR ProcessAnalyzer ScriptLauncher installation folder.

For example, in order to setup a proxy that uses current Windows credentials for the proxy connection, add the following section inside the '''<configuration>''':
<pre>
<system.net>
<defaultProxy useDefaultCredentials="true" />
</system.net>
</pre>

To configure an explicitly specified proxy server, use the following configuration:
<pre>
<system.net>
<defaultProxy>
<proxy proxyaddress="serverip:portnumber" />
</defaultProxy>
</system.net>
</pre>

More information: https://docs.microsoft.com/en-us/dotnet/framework/network-programming/proxy-configuration

== Exporting Script Results to CSV ==
When a QPR ProcessAnalyzer script contains the GetAnalysis command with the '''Show=TRUE''' parameter or the '''ShowReport''' command, the results are exported into a CSV file. Only tabular analysis types are supported by the CSV export. The exported CSV files have the following formatting:
* '''Column separator''': semicolon
<pre>;</pre>
* '''Decimal separator in numeric fields''': period
<pre>.</pre>
* '''Quotation character for text fields''': double quotes (used when the textual value contains semicolon, double quotes, linebreak or tabulator)
<pre>"</pre>
* '''Escape character''': Double quotes in textual fields are escaped with two double quotes.
<pre>""</pre>
* '''Date format for date fields''': yyyy-MM-dd HH:mm:ss,fff
* '''First line''': contains column headers

[[Category: QPR ProcessAnalyzer]]

QPR ProcessAnalyzer ScriptLauncher

2021-11-15T11:42:17Z

VesKivi: /* Installing SAP Connector for ScriptLauncher */

'''QPR ProcessAnalyzer ScriptLauncher''' is a tool to run QPR ProcessAnalyzer scripts stored in the QPR ProcessAnalyzer Server, while enabling connections to datasouces from the site where the ScriptLauncher is running, e.g. on-premise.

== Installing ScriptLauncher ==
Follow these instructions to install QPR ProcessAnalyzer ScriptLauncher:
# Install .Net Framework 4.7.1 or later (https://dotnet.microsoft.com/download/dotnet-framework).
# Download QPR ProcessAnalyzer ScriptLauncher from the [[QPR_Product_Downloads|downloads page]], and extract the package into a suitable location where to place the ScriptLaucher application files.
# If you need to extract data from SAP using the RFC interface, you need to install the [[#Installing SAP Connector for ScriptLauncher|SAP Connector for .Net]].
# Configure ScriptLauncher according to the instructions in the [[#Configuring_ScriptLauncher|next chapter]].
# Installation is now completed. Run scripts using ScriptLauncher by following instructions in the [[#Running_ScriptLauncher|chapter below]].

== Installing SAP Connector for ScriptLauncher ==
Extracting data from SAP using the SAP RFC interface requires to install SAP Connector for Microsoft .NET 3.0 using the following steps:
# SAP connector requires '''Microsoft Visual C++ Redistributable Package 2013''' (download: https://support.microsoft.com/en-us/topic/update-for-visual-c-2013-redistributable-package-d8ccd6a5-4e26-c290-517b-8da6cfdf4f10). Restart the computer after the Microsoft Visual C++ Redistributable Package installation.
# Download '''SAP Connector for Microsoft .NET 3.0 for Windows 64bit (x64)''' from SAP Support Portal (https://support.sap.com/en/product/connectors/msnet.html) (login credentials and sufficient permissions needed).
# Run the SAP Connector for Microsoft .NET 3.0 for Windows 64bit (x64) installer.
# Copy the '''sapnco.dll''' and '''sapnco_utils.dll''' files from '''C:\Program Files (x86)\SAP\SAP_DotNetConnector3_x64''' (this folder has been created by the SAP Connector for Microsoft .NET 3.0 installation) to the folder containing the ScriptLauncher application files.

Note: If you get error ''Could not load file or assembly 'sapnco_utils.dll' or one of its dependencies. The specified module could not be found'', the reason might be that the MSVCR100.dll file is missing and solution is install '''Microsoft Visual C++ 2010 Service Pack 1 Redistributable Package MFC Security Update'''' (download https://www.microsoft.com/en-us/download/details.aspx?id=26999). If the problem still persists, verify that the MSVCR100.dll is included in windows PATH.

==Configuring ScriptLauncher==
Before you can start running scripts with QPR ProcessAnalyzer ScriptLauncher, you need to configure connection and other parameters for the tool. You need to have write access to the ScriptLauncher folder, which contains the ScriptLauncher's configuration file Qpr.ProcessAnalyzer.ScriptLauncher.exe.config.

# Open the '''Qpr.ProcessAnalyzer.ScriptLauncher.exe.config''' file in a text editor.
# In the file, go to the section starting with '''<Qpr.ProcessAnalyzer.ScriptLauncher.Properties.Settings>''' and configure the values for the following parameters:
#* '''LogOnName''': QPR ProcessAnalyzer username
#* '''Password''': QPR ProcessAnalyzer password
#* '''ServiceUrl''': QPR ProcessAnalyzer server url
#* '''ScriptId''': Id of the script to run. You can copy the ID from the Scripts tab in the Workspace.
#* '''OutputDirectory''': folder where to store the created [[QPR_ProcessAnalyzer_ScriptLauncher#CSV_Export|CSV export files]]. If the folder doesn't exist, it will be created.
#* '''ProjectId''': Project id
#* '''ModelId''': Model id
#* '''ConnectionType''': Use value ''Service'' for QPR ProcessAnalyzer versions up to 2021.8. Starting from QPR ProcessAnalyzer 2021.8, use value ''WebApi''.
#* '''Parameters''': passes defined custom parameters to the script. The script should have corresponding '''@_Parameter_<ParameterName>''' variables to use the script. Add the following new setting sections to the configuration file to pass custom parameters (parameter1 and parameter2):
<pre>
<setting name="Parameters" serializeAs="Xml">
<value>
<ArrayOfString xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<string>parameter1=value1</string>
<string>parameter2=value2</string>
</ArrayOfString>
</value>
</setting>
</pre>

It's possible to add more than one string. The type of the parameter value is always NVARCHAR.

In case you want to change location of the log file that will be created, you can do that by changing the value of the parameter '''LogFilePath''' in the following section of the configuration file:
<pre>
<applicationSettings>
<Qpr.ProcessAnalyzer.Common.Properties.Settings>
<setting name="LogFilePath" serializeAs="String">
<value>.\Qpr.ProcessAnalyzer.ScriptLauncher.log</value>
</setting>
</Qpr.ProcessAnalyzer.Common.Properties.Settings>
</applicationSettings>
</pre>

Note that the log folder needs to exist before running QPR ProcessAnalyzer ScriptLauncher and you must have rights to write to that folder. By default, the log file will be stored in the same folder as the configuration file.

== Running ScriptLauncher ==
After ScriptLauncher has been configured, '''Qpr.ProcessAnalyzer.ScriptLauncher.exe''' executable file can be run which is located in the ScriptLauncher folder. In addition to the configuration file, all parameters can also be specified in the command line when running the ScriptLauncher. The command line parameters will override the settings in the configuration file. The parameter names are case sensitive. To specify a parameter in the command line, use the following format (note that all custom parameters must start with "Parameter_":
<pre>
-Parameter_<ParameterName>=<SettingValue>
</pre>
For example:
<pre>
Qpr.ProcessAnalyzer.ScriptLauncher.exe -ScriptId=123 -ModelId=12345 -Parameter_MyParameter1=myValue1 -Parameter_MyParameter2="my value 2"
</pre>

Parameters that contain special characters, such as whitespaces, must be escaped by using double quotes. For example:
<pre>
-LogFilePath="C:\Temp\Path to My Log Files\ScriptLauncherDir\"
</pre>

== Connecting through proxy ==
QPR ProcessAnalyzer ScriptLauncher can also be used through a manually configured proxy server. Proxy settings are configured to the '''Qpr.ProcessAnalyzer.ScriptLauncher.exe.config''' file stored into the QPR ProcessAnalyzer ScriptLauncher installation folder.

For example, in order to setup a proxy that uses current Windows credentials for the proxy connection, add the following section inside the '''<configuration>''':
<pre>
<system.net>
<defaultProxy useDefaultCredentials="true" />
</system.net>
</pre>

To configure an explicitly specified proxy server, use the following configuration:
<pre>
<system.net>
<defaultProxy>
<proxy proxyaddress="serverip:portnumber" />
</defaultProxy>
</system.net>
</pre>

More information: https://docs.microsoft.com/en-us/dotnet/framework/network-programming/proxy-configuration

== Exporting Script Results to CSV ==
When a QPR ProcessAnalyzer script contains the GetAnalysis command with the '''Show=TRUE''' parameter or the '''ShowReport''' command, the results are exported into a CSV file. Only tabular analysis types are supported by the CSV export. The exported CSV files have the following formatting:
* '''Column separator''': semicolon
<pre>;</pre>
* '''Decimal separator in numeric fields''': period
<pre>.</pre>
* '''Quotation character for text fields''': double quotes (used when the textual value contains semicolon, double quotes, linebreak or tabulator)
<pre>"</pre>
* '''Escape character''': Double quotes in textual fields are escaped with two double quotes.
<pre>""</pre>
* '''Date format for date fields''': yyyy-MM-dd HH:mm:ss,fff
* '''First line''': contains column headers

[[Category: QPR ProcessAnalyzer]]

QPR ProcessAnalyzer ScriptLauncher

2021-11-15T11:41:00Z

VesKivi: /* Installing SAP Connector for ScriptLauncher */

'''QPR ProcessAnalyzer ScriptLauncher''' is a tool to run QPR ProcessAnalyzer scripts stored in the QPR ProcessAnalyzer Server, while enabling connections to datasouces from the site where the ScriptLauncher is running, e.g. on-premise.

== Installing ScriptLauncher ==
Follow these instructions to install QPR ProcessAnalyzer ScriptLauncher:
# Install .Net Framework 4.7.1 or later (https://dotnet.microsoft.com/download/dotnet-framework).
# Download QPR ProcessAnalyzer ScriptLauncher from the [[QPR_Product_Downloads|downloads page]], and extract the package into a suitable location where to place the ScriptLaucher application files.
# If you need to extract data from SAP using the RFC interface, you need to install the [[#Installing SAP Connector for ScriptLauncher|SAP Connector for .Net]].
# Configure ScriptLauncher according to the instructions in the [[#Configuring_ScriptLauncher|next chapter]].
# Installation is now completed. Run scripts using ScriptLauncher by following instructions in the [[#Running_ScriptLauncher|chapter below]].

== Installing SAP Connector for ScriptLauncher ==
Extracting data from SAP using the SAP RFC interface requires to install SAP Connector for Microsoft .NET 3.0 using the following steps:
# SAP connector requires '''Microsoft Visual C++ Redistributable Package 2013''' (download: https://support.microsoft.com/en-us/topic/update-for-visual-c-2013-redistributable-package-d8ccd6a5-4e26-c290-517b-8da6cfdf4f10). Restart the computer after the Microsoft Visual C++ Redistributable Package installation.
# Download '''SAP Connector for Microsoft .NET 3.0 for Windows 64bit (x64)''' from SAP Support Portal (https://support.sap.com/en/product/connectors/msnet.html) (login credentials and sufficient permissions needed).
# Run the SAP Connector for Microsoft .NET 3.0 for Windows 64bit (x64) installer.
# Copy the '''sapnco.dll''' and '''sapnco_utils.dll''' files from '''C:\Program Files (x86)\SAP\SAP_DotNetConnector3_x64''' (this folder has been created by the SAP Connector for Microsoft .NET 3.0 installation) to the folder containing the ScriptLauncher application files.

Note: If you get error ''Could not load file or assembly 'sapnco_utils.dll' or one of its dependencies. The specified module could not be found'', the reason might be that the MSVCR100.dll file is missing and solution is install Microsoft Visual '''C++ 2010 Redistributable Package'''. If the problem still persists, verify that the MSVCR100.dll is included in windows PATH. Or install '''Microsoft Visual C++ 2010 Service Pack 1 Redistributable Package MFC Security Update''' (download https://www.microsoft.com/en-us/download/details.aspx?id=26999)

==Configuring ScriptLauncher==
Before you can start running scripts with QPR ProcessAnalyzer ScriptLauncher, you need to configure connection and other parameters for the tool. You need to have write access to the ScriptLauncher folder, which contains the ScriptLauncher's configuration file Qpr.ProcessAnalyzer.ScriptLauncher.exe.config.

# Open the '''Qpr.ProcessAnalyzer.ScriptLauncher.exe.config''' file in a text editor.
# In the file, go to the section starting with '''<Qpr.ProcessAnalyzer.ScriptLauncher.Properties.Settings>''' and configure the values for the following parameters:
#* '''LogOnName''': QPR ProcessAnalyzer username
#* '''Password''': QPR ProcessAnalyzer password
#* '''ServiceUrl''': QPR ProcessAnalyzer server url
#* '''ScriptId''': Id of the script to run. You can copy the ID from the Scripts tab in the Workspace.
#* '''OutputDirectory''': folder where to store the created [[QPR_ProcessAnalyzer_ScriptLauncher#CSV_Export|CSV export files]]. If the folder doesn't exist, it will be created.
#* '''ProjectId''': Project id
#* '''ModelId''': Model id
#* '''ConnectionType''': Use value ''Service'' for QPR ProcessAnalyzer versions up to 2021.8. Starting from QPR ProcessAnalyzer 2021.8, use value ''WebApi''.
#* '''Parameters''': passes defined custom parameters to the script. The script should have corresponding '''@_Parameter_<ParameterName>''' variables to use the script. Add the following new setting sections to the configuration file to pass custom parameters (parameter1 and parameter2):
<pre>
<setting name="Parameters" serializeAs="Xml">
<value>
<ArrayOfString xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<string>parameter1=value1</string>
<string>parameter2=value2</string>
</ArrayOfString>
</value>
</setting>
</pre>

It's possible to add more than one string. The type of the parameter value is always NVARCHAR.

In case you want to change location of the log file that will be created, you can do that by changing the value of the parameter '''LogFilePath''' in the following section of the configuration file:
<pre>
<applicationSettings>
<Qpr.ProcessAnalyzer.Common.Properties.Settings>
<setting name="LogFilePath" serializeAs="String">
<value>.\Qpr.ProcessAnalyzer.ScriptLauncher.log</value>
</setting>
</Qpr.ProcessAnalyzer.Common.Properties.Settings>
</applicationSettings>
</pre>

Note that the log folder needs to exist before running QPR ProcessAnalyzer ScriptLauncher and you must have rights to write to that folder. By default, the log file will be stored in the same folder as the configuration file.

== Running ScriptLauncher ==
After ScriptLauncher has been configured, '''Qpr.ProcessAnalyzer.ScriptLauncher.exe''' executable file can be run which is located in the ScriptLauncher folder. In addition to the configuration file, all parameters can also be specified in the command line when running the ScriptLauncher. The command line parameters will override the settings in the configuration file. The parameter names are case sensitive. To specify a parameter in the command line, use the following format (note that all custom parameters must start with "Parameter_":
<pre>
-Parameter_<ParameterName>=<SettingValue>
</pre>
For example:
<pre>
Qpr.ProcessAnalyzer.ScriptLauncher.exe -ScriptId=123 -ModelId=12345 -Parameter_MyParameter1=myValue1 -Parameter_MyParameter2="my value 2"
</pre>

Parameters that contain special characters, such as whitespaces, must be escaped by using double quotes. For example:
<pre>
-LogFilePath="C:\Temp\Path to My Log Files\ScriptLauncherDir\"
</pre>

== Connecting through proxy ==
QPR ProcessAnalyzer ScriptLauncher can also be used through a manually configured proxy server. Proxy settings are configured to the '''Qpr.ProcessAnalyzer.ScriptLauncher.exe.config''' file stored into the QPR ProcessAnalyzer ScriptLauncher installation folder.

For example, in order to setup a proxy that uses current Windows credentials for the proxy connection, add the following section inside the '''<configuration>''':
<pre>
<system.net>
<defaultProxy useDefaultCredentials="true" />
</system.net>
</pre>

To configure an explicitly specified proxy server, use the following configuration:
<pre>
<system.net>
<defaultProxy>
<proxy proxyaddress="serverip:portnumber" />
</defaultProxy>
</system.net>
</pre>

More information: https://docs.microsoft.com/en-us/dotnet/framework/network-programming/proxy-configuration

== Exporting Script Results to CSV ==
When a QPR ProcessAnalyzer script contains the GetAnalysis command with the '''Show=TRUE''' parameter or the '''ShowReport''' command, the results are exported into a CSV file. Only tabular analysis types are supported by the CSV export. The exported CSV files have the following formatting:
* '''Column separator''': semicolon
<pre>;</pre>
* '''Decimal separator in numeric fields''': period
<pre>.</pre>
* '''Quotation character for text fields''': double quotes (used when the textual value contains semicolon, double quotes, linebreak or tabulator)
<pre>"</pre>
* '''Escape character''': Double quotes in textual fields are escaped with two double quotes.
<pre>""</pre>
* '''Date format for date fields''': yyyy-MM-dd HH:mm:ss,fff
* '''First line''': contains column headers

[[Category: QPR ProcessAnalyzer]]

QPR ProcessAnalyzer ScriptLauncher

2021-11-15T09:19:13Z

VesKivi: /* Installing SAP Connector for ScriptLauncher */

'''QPR ProcessAnalyzer ScriptLauncher''' is a tool to run QPR ProcessAnalyzer scripts stored in the QPR ProcessAnalyzer Server, while enabling connections to datasouces from the site where the ScriptLauncher is running, e.g. on-premise.

== Installing ScriptLauncher ==
Follow these instructions to install QPR ProcessAnalyzer ScriptLauncher:
# Install .Net Framework 4.7.1 or later (https://dotnet.microsoft.com/download/dotnet-framework).
# Download QPR ProcessAnalyzer ScriptLauncher from the [[QPR_Product_Downloads|downloads page]], and extract the package into a suitable location where to place the ScriptLaucher application files.
# If you need to extract data from SAP using the RFC interface, you need to install the [[#Installing SAP Connector for ScriptLauncher|SAP Connector for .Net]].
# Configure ScriptLauncher according to the instructions in the [[#Configuring_ScriptLauncher|next chapter]].
# Installation is now completed. Run scripts using ScriptLauncher by following instructions in the [[#Running_ScriptLauncher|chapter below]].

== Installing SAP Connector for ScriptLauncher ==
Extracting data from SAP using the SAP RFC interface requires to install SAP Connector for Microsoft .NET 3.0 using the following steps:
# SAP connector requires '''Microsoft Visual C++ Redistributable Package 2013''' (download: https://support.microsoft.com/en-us/topic/update-for-visual-c-2013-redistributable-package-d8ccd6a5-4e26-c290-517b-8da6cfdf4f10). Restart the computer after the Microsoft Visual C++ Redistributable Package installation.
# Download '''SAP Connector for Microsoft .NET 3.0 for Windows 64bit (x64)''' from SAP Support Portal (https://support.sap.com/en/product/connectors/msnet.html) (login credentials and sufficient permissions needed).
# Run the SAP Connector for Microsoft .NET 3.0 for Windows 64bit (x64) installer.
# Copy the '''sapnco.dll''' and '''sapnco_utils.dll''' files from '''C:\Program Files (x86)\SAP\SAP_DotNetConnector3_x64''' (this folder has been created by the SAP Connector for Microsoft .NET 3.0 installation) to the folder containing the ScriptLauncher application files.

Note: If you get error ''Could not load file or assembly 'sapnco_utils.dll' or one of its dependencies. The specified module could not be found'', the reason might be that the MSVCR100.dll file is missing and solution is install Microsoft Visual '''C++ 2010 Redistributable Package'''. If the problem still persists, verify that the MSVCR100.dll is included in windows PATH. Or install '''Microsoft Visual C++ 2010 Service Pack 1 Redistributable Package MFC Security Update''' (download ttps://www.microsoft.com/en-us/download/details.aspx?id=26999)

==Configuring ScriptLauncher==
Before you can start running scripts with QPR ProcessAnalyzer ScriptLauncher, you need to configure connection and other parameters for the tool. You need to have write access to the ScriptLauncher folder, which contains the ScriptLauncher's configuration file Qpr.ProcessAnalyzer.ScriptLauncher.exe.config.

# Open the '''Qpr.ProcessAnalyzer.ScriptLauncher.exe.config''' file in a text editor.
# In the file, go to the section starting with '''<Qpr.ProcessAnalyzer.ScriptLauncher.Properties.Settings>''' and configure the values for the following parameters:
#* '''LogOnName''': QPR ProcessAnalyzer username
#* '''Password''': QPR ProcessAnalyzer password
#* '''ServiceUrl''': QPR ProcessAnalyzer server url
#* '''ScriptId''': Id of the script to run. You can copy the ID from the Scripts tab in the Workspace.
#* '''OutputDirectory''': folder where to store the created [[QPR_ProcessAnalyzer_ScriptLauncher#CSV_Export|CSV export files]]. If the folder doesn't exist, it will be created.
#* '''ProjectId''': Project id
#* '''ModelId''': Model id
#* '''ConnectionType''': Use value ''Service'' for QPR ProcessAnalyzer versions up to 2021.8. Starting from QPR ProcessAnalyzer 2021.8, use value ''WebApi''.
#* '''Parameters''': passes defined custom parameters to the script. The script should have corresponding '''@_Parameter_<ParameterName>''' variables to use the script. Add the following new setting sections to the configuration file to pass custom parameters (parameter1 and parameter2):
<pre>
<setting name="Parameters" serializeAs="Xml">
<value>
<ArrayOfString xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<string>parameter1=value1</string>
<string>parameter2=value2</string>
</ArrayOfString>
</value>
</setting>
</pre>

It's possible to add more than one string. The type of the parameter value is always NVARCHAR.

In case you want to change location of the log file that will be created, you can do that by changing the value of the parameter '''LogFilePath''' in the following section of the configuration file:
<pre>
<applicationSettings>
<Qpr.ProcessAnalyzer.Common.Properties.Settings>
<setting name="LogFilePath" serializeAs="String">
<value>.\Qpr.ProcessAnalyzer.ScriptLauncher.log</value>
</setting>
</Qpr.ProcessAnalyzer.Common.Properties.Settings>
</applicationSettings>
</pre>

Note that the log folder needs to exist before running QPR ProcessAnalyzer ScriptLauncher and you must have rights to write to that folder. By default, the log file will be stored in the same folder as the configuration file.

== Running ScriptLauncher ==
After ScriptLauncher has been configured, '''Qpr.ProcessAnalyzer.ScriptLauncher.exe''' executable file can be run which is located in the ScriptLauncher folder. In addition to the configuration file, all parameters can also be specified in the command line when running the ScriptLauncher. The command line parameters will override the settings in the configuration file. The parameter names are case sensitive. To specify a parameter in the command line, use the following format (note that all custom parameters must start with "Parameter_":
<pre>
-Parameter_<ParameterName>=<SettingValue>
</pre>
For example:
<pre>
Qpr.ProcessAnalyzer.ScriptLauncher.exe -ScriptId=123 -ModelId=12345 -Parameter_MyParameter1=myValue1 -Parameter_MyParameter2="my value 2"
</pre>

Parameters that contain special characters, such as whitespaces, must be escaped by using double quotes. For example:
<pre>
-LogFilePath="C:\Temp\Path to My Log Files\ScriptLauncherDir\"
</pre>

== Connecting through proxy ==
QPR ProcessAnalyzer ScriptLauncher can also be used through a manually configured proxy server. Proxy settings are configured to the '''Qpr.ProcessAnalyzer.ScriptLauncher.exe.config''' file stored into the QPR ProcessAnalyzer ScriptLauncher installation folder.

For example, in order to setup a proxy that uses current Windows credentials for the proxy connection, add the following section inside the '''<configuration>''':
<pre>
<system.net>
<defaultProxy useDefaultCredentials="true" />
</system.net>
</pre>

To configure an explicitly specified proxy server, use the following configuration:
<pre>
<system.net>
<defaultProxy>
<proxy proxyaddress="serverip:portnumber" />
</defaultProxy>
</system.net>
</pre>

More information: https://docs.microsoft.com/en-us/dotnet/framework/network-programming/proxy-configuration

== Exporting Script Results to CSV ==
When a QPR ProcessAnalyzer script contains the GetAnalysis command with the '''Show=TRUE''' parameter or the '''ShowReport''' command, the results are exported into a CSV file. Only tabular analysis types are supported by the CSV export. The exported CSV files have the following formatting:
* '''Column separator''': semicolon
<pre>;</pre>
* '''Decimal separator in numeric fields''': period
<pre>.</pre>
* '''Quotation character for text fields''': double quotes (used when the textual value contains semicolon, double quotes, linebreak or tabulator)
<pre>"</pre>
* '''Escape character''': Double quotes in textual fields are escaped with two double quotes.
<pre>""</pre>
* '''Date format for date fields''': yyyy-MM-dd HH:mm:ss,fff
* '''First line''': contains column headers

[[Category: QPR ProcessAnalyzer]]

QPR ProcessAnalyzer API

2019-11-15T09:50:21Z

VesKivi: /* Get Flowchart Image */

QPR ProcessAnalyzer WCF Web Service API (Application Programming Interface) can be used to automate operations and to create integration with other applications. All Web Service operations only accept HTTP POST method (HTTP GET is not allowed). QPR ProcessAnalyzer WCF Web Service API can be used with wsHttp (SOAP) and webHttp endpoints.

== WCF Web Service API Methods ==
The following methods are available in the WCF Web Service API:
* [[QPR ProcessAnalyzer API: Authenticate|Authenticate]]: Tries to authenticate given user with given password and authentication parameters.
* [[QPR ProcessAnalyzer API: CancelQueryOperation|CancelQueryOperation]]: Cancels running operation using query identifier.
* [[QPR ProcessAnalyzer API: DeleteModel|DeleteModel]]: Deletes a model.
* [[QPR ProcessAnalyzer API: DeleteProject|DeleteProject]]: Deletes a project.
* [[QPR ProcessAnalyzer API: GetAnalysis|GetAnalysis]]: Calculates and returns QPR ProcessAnalyzer analysis.
* [[QPR ProcessAnalyzer API: GetAnalysisImageAsByteArray|GetAnalysisImageAsByteArray]]: Get [[Flowchart_Analysis_(PAPO)|Flowchart Analysis]] as image.
* [[QPR ProcessAnalyzer API: GetModel|GetModel]]: Can be used to query QPR ProcessAnalyzer model data.
* [[QPR ProcessAnalyzer API: GetModels|GetModels]]: Can be used to query QPR ProcessAnalyzer model related information.
* [[QPR ProcessAnalyzer API: GetModelAsStream|GetModelAsStream]]: Exports a model or a filtered data as a .pacm file.
* [[QPR ProcessAnalyzer API: GetStream|GetStream]] can be used to query contents of a stream bound to the given session identified by given stream id.
* [[QPR ProcessAnalyzer API: GetUsers|GetUsers]]: can be used to get user related information.
* [[QPR ProcessAnalyzer API: LogOff|LogOff]]: Logs off the user session.
* [[QPR ProcessAnalyzer API: QueryObjectProperties|QueryObjectProperties]] returns all the listed properties queried for all the listed objects identified by unique identifiers.
* [[QPR ProcessAnalyzer API: ResetModelCache|ResetModelCache]]: Can be used to clear all cached model information of the given model.
* [[QPR ProcessAnalyzer API: RunScript|RunScript]] can be used to execute given PA script using given parameters.
* [[QPR ProcessAnalyzer API: SetModel|SetModel]]: Can be used to set model related information.
* [[QPR ProcessAnalyzer API: SetUser|SetUser]]: Can be used to set user information.
* [[QPR ProcessAnalyzer API: ValidateModel|ValidateModel]] can be used to perform all the pending tasks stored in the work queue of the given model.
* [[QPR ProcessAnalyzer API: GetUserPermissions|GetUserPermissions]] can be used to query permissions given user has for a set of objects.
* [[QPR ProcessAnalyzer API: ModifyUserRelations|ModifyUserRelations]] can be used to modify permissions given user.
* [[QPR ProcessAnalyzer API: GetUserRoles|GetUserRoles]] can be used to get available user roles.

== WCF Web Service API Usage Examples ==
=== JavaScript Examples ===
<pre>
//login
$.ajax({
"method": "POST",
"url": "http://localhost/qprpa/Mainservice.svc/webHttp/Authenticate",
"dataType": "json", "contentType": "application/json; charset=utf-8",
"data": JSON.stringify({
'logOnName': '<username>',
'password': '<password>',
'parameters': ''
})
});
</pre>

<pre>
//create user
$.ajax({
"method": "POST",
"url": "http://localhost/qprpa/Mainservice.svc/webHttp/SetUser",
"dataType": "json", "contentType": "application/json; charset=utf-8",
"data": JSON.stringify({
"sessionId": sessionId,
"user": {"Name": "user", "FullName": "first last" },
"parameters": [{"Key": "Password", "Value": "demo"}]
})
});
</pre>

<pre>
//add user to group, value 8:12:0 is user:group:member type
$.ajax({
"method": "POST",
"url": "http://localhost/qprpa/Mainservice.svc/webHttp/ModifyUserRelations",
"dataType": "json", "contentType": "application/json; charset=utf-8",
"data": JSON.stringify({
"sessionId": sessionId,
"parameters": [{"Key": "AddGroups", "Value": "8:12:0"}]
})
});
</pre>

<pre>
//log off
$.ajax({
"method": "POST",
"url": "http://localhost/qprpa/Mainservice.svc/webHttp/LogOff",
"dataType": "json", "contentType": "application/json; charset=utf-8",
"data": JSON.stringify({
"sessionId": sessionId
})
});
</pre>

=== PowerShell Examples ===
==== [[Move Data from QPR ProcessAnalyzer to Database using PowerShell]] ====
==== List Users ====
<pre>
$paService=New-WebServiceProxy –Uri "http://localhost/qprpa/MainService.svc"
$connection=$paService.Authenticate("username", "password", @())
$token=$connection.GetValue(0).Value

$param=@()
$users=$paService.GetUsers($token, $null, $param)
$users
$paService | get-member | ? {$_.definition -match "GetAnalysis"}
</pre>

==== Update Model Configuration ====
<pre>
$paService=New-WebServiceProxy –Uri "http://localhost/qprpa/MainService.svc"
$connection=$paService.Authenticate("username", "password", @())
$token=$connection.GetValue(0).Value
$param=@()
$modelId=@(2)
$model=$paService.GetModels($token,$modelId, $param)

$model[0]
$model[0].ConfigurationJson = "{}"

$paService.SetModel($token,$model[0], $param)
</pre>

==== Get Flowchart Image ====
<pre>
$paService=New-WebServiceProxy –Uri "http://localhost/qprpa/MainService.svc" -Namespace "WebServiceProxy" -Class "PaService"
$connection=$paService.Authenticate("username", "password", @())
$token=$connection.GetValue(0).Value

$ids = new-object WebServiceProxy.ModelViewId
$ids.ViewId = 13
$ids.ViewIdSpecified = 1

$analysisType = 0
$processAnalysisType = 4
$minTransitionPercentage = 0.0

$png= $paService.GetAnalysisImageAsByteArray($token, $ids, $analysisType,1, $processAnalysisType,1 , $minTransitionPercentage,1)
[IO.File]::WriteAllBytes('c:\tmp\image.png', $png)
</pre>

__NOTOC__

QPR ProcessAnalyzer Model Datasources

2019-10-15T07:17:09Z

VesKivi: /* Read data from CSV file */

Data to QPR Processanalyzer models can be loaded from many different sources using different techniques. The following type of datasources can be used:
* [[#Loading Data from Datatables|Datatables]]: Data can be loaded from QPR ProcessAnalyzer's own datatables.
* [[#Loading Data from ODBC Datasource|ODBC datasources]]: Data can be loaded from any ODBC compliant source system, such as many database systems, SAP HANA, ServiceNow, Excel files and CSV files.
* [[#Loading Data from Expression Datasource|Expression]]: Data can be loaded from a dataset that is produced by an expression written in QPR ProcessAnalyzer [[QPR_ProcessAnalyzer_Expressions|expression language]]. With the expression language, it's possible to e.g. fetch data from other QPR ProcessAnalyzer models, transform the data and then load them to a model using the expression datasource.
* Models stored to QPR ProcessAnalyze database (legacy method)

For the datatables, ODBC and expression datasources two datasource queries needs to be defined: one for '''cases''' and one for '''events'''. It's also possible that cases and event are loaded from different types of datasources, e.g. cases from an ODBC datasource and events from a datatable.

Mappings for the columns in the datasets can be defined freely, so the order of columns is not relevant for QPR ProcessAnalyzer.

== Loading Data from Datatables ==
In the ''DataSource'' section, when the ''DataSourceType'' is defined as ''datatable'', data is loaded from a QPR ProcessAnalyzer [[Data_Tables_in_QPR_ProcessAnalyzer|datatable]]. Datatables can be created by importing data to them from a CSV file, or as a result of an [[Data_Extraction,_Transformation,_and_Loading|ETL script]].

{| class="wikitable"
!'''Property'''
! '''Description'''
|-
||DataSource/Cases/DataSourceType
||Datasource type to use, when fetching the Cases data. Supported values are '''database''' (default), '''datatable''', '''expression''' and '''odbc'''.
|-
||DataSource/Cases/DataTableName
||Name of the datatable where to fetch the cases data.
|-
||DataSource/Cases/Columns
||Column name mappings for QPR ProcessAnalyzer data model. Only supported mapping is '''CaseId''' defining the case id (case name). Example:
<pre>
{
"CaseId": "SalesOrderHeaderId"
}
</pre>
All unmapped columns are taken to the model as case attributes. If the fetched data doesn't contain a mapped column, the model loading fails and an error message is given.
|-
||DataSource/Events/DataSourceType
||Datasource type to use, when fetching the Events data. Supported values are '''database''' (default), '''datatable''', '''expression''' and '''odbc'''.
|-
||DataSource/Events/DataTableName
||Name of the datatable where to fetch the events data.
|-
||DataSource/Events/Columns
||
Column name mappings for QPR ProcessAnalyzer data model. Supported mappings for Events are '''CaseId''', '''EventType''' and '''Timestamp'''. Example:
<pre>
{
"CaseId": "SalesOrderHeaderId",
"EventType": "EventType",
"Timestamp": "CreatedDate"
}
</pre>
All unmapped columns are taken to the model as event attributes. If the fetched data doesn't contain a mapped column, the model loading fails and an error message is given.
|}

== Loading Data from ODBC Datasource ==
In the ''DataSource'' section, when the ''DataSourceType'' is defined as ''odbc'' (for cases or events), data is loaded from an ODBC datasource. There needs to be a suitable ODBC driver installed in QPR ProcesAnalyzer server, and ODBC connection string and query needs to be defined (more below).

{| class="wikitable"
!'''Property'''
! '''Description'''
|-
||DataSource/Cases/DataSourceType
||Use value '''odbc''' when loading data from an ODBC datasource. More information about DataSourceType, see [[QPR_ProcessAnalyzer_Model_JSON_Settings#Loading_Data_from_Datatables|Loading Data from Datatables]].
|-
||DataSource/Cases/OdbcConnectionString
||ODBC connection string to use to fetch the Cases data. Connection strings can be found in https://www.connectionstrings.com.
|-
||DataSource/Cases/OdbcQuery
||ODBC query to use to fetch the Cases data. Query syntax depends on the source system where the data is fetched.
|-
||DataSource/Cases/Columns
||For more information, see [[QPR_ProcessAnalyzer_Model_JSON_Settings#Loading_Data_from_Datatables|Loading Data from Datatables]].
|-
||DataSource/Events/DataSourceType
||Use value '''odbc''' when loading data from an ODBC datasource. More information about DataSourceType, see [[QPR_ProcessAnalyzer_Model_JSON_Settings#Loading_Data_from_Datatables|Loading Data from Datatables]].
|-
||DataSource/Events/OdbcConnectionString
||ODBC connection string to use to fetch the Events data. Connection strings can be found in https://www.connectionstrings.com.
|-
||DataSource/Events/OdbcQuery
||ODBC query to use to fetch the Events data. Query syntax depends on the source system where the data is fetched.
|-
||DataSource/Events/Columns
||For more information, see [[QPR_ProcessAnalyzer_Model_JSON_Settings#Loading_Data_from_Datatables|Loading Data from Datatables]].
|}

=== Configurations examples ===

==== ODBC Driver Installation ====
'''Microsoft Access Database Engine 2016 Redistributable''' is software package that contains ODBC drivers for
* Microsoft SQL Server
* Microsoft Access (*.mdb and *.accdb) files
* Microsoft Excel (*.xls, *.xlsx, and *.xlsb) files
* CSV text files

The package needs to be installed in the same computer where the QPR ProcessAnalyzer Server is running. Installation instructions:
# Go to https://www.microsoft.com/en-us/download/details.aspx?id=54920 and click Download.
# Select whether to use the 32bit or 64bit (x64) version (usually it's the 64bit version).
# Double-click the executable file on your hard disk to start the setup program.
# Follow the instructions on the screen to complete the installation.

If 32-bit office is installed in machine then 64-bit ODBC driver need install using /passive parameter.
More information
* https://stackoverflow.com/questions/7116019/hand-install-of-64-bit-ms-access-odbc-drivers-when-32-bit-office-is-present
* https://techblog.aimms.com/2014/10/27/installing-32-bit-and-64-bit-microsoft-access-drivers-next-to-each-other/

==== Read data from CSV file ====
In this example, data is loaded from CSV files located in the file system using ''Microsoft Access Text Driver (*.txt, *.csv)'' driver. Loaded files are C:\ProcessMiningData\ModelCaseAttributes.csv and C:\ProcessMiningData\ModelEventData.csv.
<pre>
{
"DataSource": {
"Cases": {
"DataSourceType": "odbc",
"OdbcConnectionString": "Driver={Microsoft Access Text Driver (*.txt, *.csv)};DefaultDir=C:\\ProcessMiningData\\;Extensions=asc,csv,tab,txt",
"OdbcQuery": "SELECT * FROM [ModelCaseAttributes.csv]",
"Columns": {
"CaseId": "Name"
}
},
"Events": {
"DataSourceType": "odbc",
"OdbcConnectionString": "Driver={Microsoft Access Text Driver (*.txt, *.csv)};DefaultDir=C:\\ProcessMiningData\\;Extensions=asc,csv,tab,txt",
"OdbcQuery": "SELECT * FROM [ModelEventData.csv]",
"Columns": {
"CaseId": "Case",
"EventType": "Event Type",
"Timestamp": "Start Time"
}
}
}
}
</pre>

When reading from CSV files, you may need to set the CSV file format for the ODBC driver using the '''Schema.ini''' file (more information: https://docs.microsoft.com/en-us/sql/odbc/microsoft/schema-ini-file-text-file-driver?view=sql-server-2017).
* Example: ODBC text driver may guess column data type and return null values in case when guessed column type not match. Guessing based top rows of data.
* Note: ODBC text driver support only one data type per column mixed data types is not supported.

==== Read data from Excel file ====
In this example, data is loaded from a Excel file that is accessible in the file system. In this example, the loaded file is C:\ProcessMiningData\ModelData.xlsx and cases are in sheet ''MyCases'' and events in sheet ''MyEvents''.

<pre>
{
"DataSource": {
"Cases": {
"DataSourceType": "odbc",
"OdbcConnectionString": "Driver={Microsoft Excel Driver (*.xls, *.xlsx, *.xlsm, *.xlsb)};DBQ=C:\\ProcessMiningData\\ModelData.xlsx",
"OdbcQuery": "SELECT * FROM [MyCases$]",
"Columns": {
"CaseId": "Case ID"
}
},
"Events": {
"DataSourceType": "odbc",
"OdbcConnectionString": "Driver={Microsoft Excel Driver (*.xls, *.xlsx, *.xlsm, *.xlsb)};DBQ=C:\\ProcessMiningData\\ModelData.xlsx",
"OdbcQuery": "SELECT * FROM [MyEvents$]",
"Columns": {
"CaseId": "Case ID",
"EventType": "Activity",
"Timestamp": "Start Time"
}
}
}
}
</pre>

==== Read data from SQL Server table ====
Recommended driver: https://www.microsoft.com/en-us/download/details.aspx?id=56567

In this example, data is loaded from an SQL Server table. SQL Server hostname is ''myServerName'', instance name is ''myInstanceName'' and database name is ''MyDatabase''. The ''Trusted_Connection'' is for Windows authentication.

<pre>
{
"DataSource": {
"Cases": {
"DataSourceType": "odbc",
"OdbcConnectionString": "Driver={ODBC Driver 17 for SQL Server};Server=myServerName\\myInstanceName;DataBase=MyDatabase;Trusted_Connection=Yes;",
"OdbcQuery": "SELECT CASENAME, COST, COUNTRY, PRODUCT FROM CASES_TABLE",
"Columns": {
"CaseId": "CASENAME"
}
},
"Events": {
"DataSourceType": "odbc",
"OdbcConnectionString": "Driver={ODBC Driver 17 for SQL Server};Server=myServerName\\myInstanceName;DataBase=MyDatabase;Trusted_Connection=Yes;",
"OdbcQuery": "SELECT CASENAME, CREATED_DATE, CREATED_BY FROM EVENTS_TABLE",
"Columns": {
"CaseId": "CASENAME",
"Timestamp": "CREATED_DATE",
"EventType": "CREATED_BY"
}
}
}
}
</pre>

If SQL Server authentication is used, the connection string is
<pre>
Driver={ODBC Driver 17 for SQL Server};Server=myServerName\myInstanceName;DataBase=MyDatabase;Trusted_Connection=No;Uid=myUsername;PWD=myPassword;
</pre>

More about SQL Server connection strings: https://www.connectionstrings.com/sql-server/

=== Troubleshooting ===

The following error message may be encountered: ''System.Data.Odbc.OdbcException (0x80131937): ERROR [IM002] [Microsoft][ODBC Driver Manager] Data source name not found and no default driver specified''. Probable reason is that the ODBC driver is missing or driver name is not correct. To solve the issue:
* Check ODBC drivers is installed by running '''C:\Windows\System32\odbcad32.exe'''.
* Check the connection string.

The following error message may be encountered: '''ERROR [HY024] [Microsoft][ODBC Text Driver] '(unknown)' is not a valid path. Make sure that the path name is spelled correctly and that you are connected to the server on which the file resides.'''.
Example error when specified directory is missing:

Error when CSV file is missing: '''System.Data.Odbc.OdbcException (0x80131937): ERROR [42S02] [Microsoft][ODBC Text Driver] The Microsoft Access database engine could not find the object 'CaseAttributes.csv'. Make sure the object exists and that you spell its name and the path name correctly. If 'CaseAttributes.csv' is not a local object, check your network connection or contact the server administrator.'''

Error codes for troubleshooting: [https://docs.microsoft.com/en-us/sql/odbc/reference/appendixes/appendix-a-odbc-error-codes?view=sql-server-2017| ODBC Error Codes].

If the error message mention about Case or Event attributes named as ''F<column number>'' (e.g. F10), the data might be inconsistent, as there might be different amount of columns in different rows.

== Loading Data from Expression Datasource ==
Data (cases and events) loaded to a QPR ProcessAnalyzer model can be defined using an expression. The principle with column mappings is similar than in the odbc datasource.

{| class="wikitable"
!'''Property'''
! '''Description'''
|-
||DataSource/Cases/DataSourceType
||Use value '''expression''' when loading data from an expression. More information about DataSourceType, see [[QPR_ProcessAnalyzer_Model_JSON_Settings#Loading_Data_from_Datatables|Loading Data from Datatables]].
|-
||DataSource/Cases/Expression
||Expression to get cases. The data structure is an array of arrays, where the outer array contains rows and inner array contains data cells in a row. The first row must contain headers.
|-
||DataSource/Cases/Columns
||For more information, see [[QPR_ProcessAnalyzer_Model_JSON_Settings#Loading_Data_from_Datatables|Loading Data from Datatables]].
|-
||DataSource/Events/DataSourceType
||Use value '''expression''' when loading data from an expression. More information about DataSourceType, see [[QPR_ProcessAnalyzer_Model_JSON_Settings#Loading_Data_from_Datatables|Loading Data from Datatables]].
|-
||DataSource/Events/Expression
||Expression to get events. The data structure is an array of arrays, where the outer array contains rows and inner array contains data cells in a row. The first row must contain headers.
|-
||DataSource/Events/Columns
||For more information, see [[QPR_ProcessAnalyzer_Model_JSON_Settings#Loading_Data_from_Datatables|Loading Data from Datatables]].
|-
|}

Examples:

Create model from another model:
<pre>
{
  "DataSource": {
    "Events": {
      "DataSourceType": "expression",
      "Expression": "ConcatTop([[["CaseId", "EventType", "Timestamp"]], EventLogById(1).Events.[Case.Name, TypeName, Timestamp]])",
      "Columns": {
        "CaseId": "Case",
        "Timestamp": "Timestamp",
        "EventType": "EventType"
      }
    }
}
}
</pre>

<pre>
{
  "DataSource": {
    "Events": {
      "DataSourceType": "expression",
      "Expression": "Let(\"maxEventsPerModel\", 1000);Let(\"ms\", [\"SAP_OrderToCash\", \"BPIC13_incidents\"].(Let(\"modelName\", _), Models.Where(Name == modelName))[0]);Let(\"eventAttributes\", ToDictionary());ms.EventAttributes.(Let(\"ea\", _), eventAttributes.Set(ea.Name, ea));Let(\"orderedEventAttributes\", OrderByValue(eventAttributes.Keys));ConcatTop([[Flatten([\"Case\", \"EventType\", \"TimeStamp\", orderedEventAttributes])],ConcatTop(ms.EventLog.Events[NumberRange(0, Min(CountTop(_), maxEventsPerModel) - 1)].Flatten([Case.Name, Type.Name, TimeStamp, (Let(\"evt\", _), orderedEventAttributes.(Let(\"att\", _), evt.Attribute(att)))]))])",
      "Columns": {
        "CaseId": "Case",
        "Timestamp": "TimeStamp",
        "EventType": "EventType"
      }
    },
    "Cases": {
      "DataSourceType": "expression",
      "Expression": "Let(\"maxEventsPerModel\", 1000);Let(\"ms\", [\"SAP_OrderToCash\", \"BPIC13_incidents\"].(Let(\"modelName\", _), Models.Where(Name == modelName))[0]);Let(\"caseAttributes\", ToDictionary());ms.CaseAttributes.(Let(\"ca\", _), caseAttributes.Set(ca.Name, ca));Let(\"orderedCaseAttributes\", OrderByValue(caseAttributes.Keys));Let(\"cases\", ToDictionary());ms.EventLog.Events[NumberRange(0, Min(CountTop(_), maxEventsPerModel) - 1)].Case.(Let(\"c\", _), cases.Set(c, true));ConcatTop([[Flatten([\"Case\", \"Model\", orderedCaseAttributes])],cases.Keys.Flatten([Name, EventLog.Name, (Let(\"c\", _), orderedCaseAttributes.(Let(\"att\", _), c.Attribute(att)))])])",
      "Columns": {
        "CaseId": "Case"
      }
    }
  }
}
</pre>

<pre>
{
  "DataSource": {
    "Events": {
      "DataSourceType": "expression",
      "Expression": "[[\"Case\", \"EventType\", \"TimeStamp\"],[\"a\", \"et1\", DateTime(2019,1)],[\"a\", \"et2\", DateTime(2019,2)],[\"a\", \"et3\", DateTime(2019,3)],[\"b\", \"et1\", DateTime(2019,2)],[\"c\", \"et3\", DateTime(2019,2)],[\"c\", \"et2\", DateTime(2019,3)],[\"c\", \"et2\", DateTime(2019,4)],[\"c\", \"et3\", DateTime(2019,5)],[\"c\", \"et4\", DateTime(2019,6)]]",
      "Columns": {
        "CaseId": "Case",
        "Timestamp": "TimeStamp",
        "EventType": "EventType"
      }
    }
  }
}
</pre>

[[Category: QPR ProcessAnalyzer]]

QPR ProcessAnalyzer Model Datasources

2019-10-15T07:14:00Z

VesKivi: /* Read data from CSV file */

Data to QPR Processanalyzer models can be loaded from many different sources using different techniques. The following type of datasources can be used:
* [[#Loading Data from Datatables|Datatables]]: Data can be loaded from QPR ProcessAnalyzer's own datatables.
* [[#Loading Data from ODBC Datasource|ODBC datasources]]: Data can be loaded from any ODBC compliant source system, such as many database systems, SAP HANA, ServiceNow, Excel files and CSV files.
* [[#Loading Data from Expression Datasource|Expression]]: Data can be loaded from a dataset that is produced by an expression written in QPR ProcessAnalyzer [[QPR_ProcessAnalyzer_Expressions|expression language]]. With the expression language, it's possible to e.g. fetch data from other QPR ProcessAnalyzer models, transform the data and then load them to a model using the expression datasource.
* Models stored to QPR ProcessAnalyze database (legacy method)

For the datatables, ODBC and expression datasources two datasource queries needs to be defined: one for '''cases''' and one for '''events'''. It's also possible that cases and event are loaded from different types of datasources, e.g. cases from an ODBC datasource and events from a datatable.

Mappings for the columns in the datasets can be defined freely, so the order of columns is not relevant for QPR ProcessAnalyzer.

== Loading Data from Datatables ==
In the ''DataSource'' section, when the ''DataSourceType'' is defined as ''datatable'', data is loaded from a QPR ProcessAnalyzer [[Data_Tables_in_QPR_ProcessAnalyzer|datatable]]. Datatables can be created by importing data to them from a CSV file, or as a result of an [[Data_Extraction,_Transformation,_and_Loading|ETL script]].

{| class="wikitable"
!'''Property'''
! '''Description'''
|-
||DataSource/Cases/DataSourceType
||Datasource type to use, when fetching the Cases data. Supported values are '''database''' (default), '''datatable''', '''expression''' and '''odbc'''.
|-
||DataSource/Cases/DataTableName
||Name of the datatable where to fetch the cases data.
|-
||DataSource/Cases/Columns
||Column name mappings for QPR ProcessAnalyzer data model. Only supported mapping is '''CaseId''' defining the case id (case name). Example:
<pre>
{
"CaseId": "SalesOrderHeaderId"
}
</pre>
All unmapped columns are taken to the model as case attributes. If the fetched data doesn't contain a mapped column, the model loading fails and an error message is given.
|-
||DataSource/Events/DataSourceType
||Datasource type to use, when fetching the Events data. Supported values are '''database''' (default), '''datatable''', '''expression''' and '''odbc'''.
|-
||DataSource/Events/DataTableName
||Name of the datatable where to fetch the events data.
|-
||DataSource/Events/Columns
||
Column name mappings for QPR ProcessAnalyzer data model. Supported mappings for Events are '''CaseId''', '''EventType''' and '''Timestamp'''. Example:
<pre>
{
"CaseId": "SalesOrderHeaderId",
"EventType": "EventType",
"Timestamp": "CreatedDate"
}
</pre>
All unmapped columns are taken to the model as event attributes. If the fetched data doesn't contain a mapped column, the model loading fails and an error message is given.
|}

== Loading Data from ODBC Datasource ==
In the ''DataSource'' section, when the ''DataSourceType'' is defined as ''odbc'' (for cases or events), data is loaded from an ODBC datasource. There needs to be a suitable ODBC driver installed in QPR ProcesAnalyzer server, and ODBC connection string and query needs to be defined (more below).

{| class="wikitable"
!'''Property'''
! '''Description'''
|-
||DataSource/Cases/DataSourceType
||Use value '''odbc''' when loading data from an ODBC datasource. More information about DataSourceType, see [[QPR_ProcessAnalyzer_Model_JSON_Settings#Loading_Data_from_Datatables|Loading Data from Datatables]].
|-
||DataSource/Cases/OdbcConnectionString
||ODBC connection string to use to fetch the Cases data. Connection strings can be found in https://www.connectionstrings.com.
|-
||DataSource/Cases/OdbcQuery
||ODBC query to use to fetch the Cases data. Query syntax depends on the source system where the data is fetched.
|-
||DataSource/Cases/Columns
||For more information, see [[QPR_ProcessAnalyzer_Model_JSON_Settings#Loading_Data_from_Datatables|Loading Data from Datatables]].
|-
||DataSource/Events/DataSourceType
||Use value '''odbc''' when loading data from an ODBC datasource. More information about DataSourceType, see [[QPR_ProcessAnalyzer_Model_JSON_Settings#Loading_Data_from_Datatables|Loading Data from Datatables]].
|-
||DataSource/Events/OdbcConnectionString
||ODBC connection string to use to fetch the Events data. Connection strings can be found in https://www.connectionstrings.com.
|-
||DataSource/Events/OdbcQuery
||ODBC query to use to fetch the Events data. Query syntax depends on the source system where the data is fetched.
|-
||DataSource/Events/Columns
||For more information, see [[QPR_ProcessAnalyzer_Model_JSON_Settings#Loading_Data_from_Datatables|Loading Data from Datatables]].
|}

=== Configurations examples ===

==== ODBC Driver Installation ====
'''Microsoft Access Database Engine 2016 Redistributable''' is software package that contains ODBC drivers for
* Microsoft SQL Server
* Microsoft Access (*.mdb and *.accdb) files
* Microsoft Excel (*.xls, *.xlsx, and *.xlsb) files
* CSV text files

The package needs to be installed in the same computer where the QPR ProcessAnalyzer Server is running. Installation instructions:
# Go to https://www.microsoft.com/en-us/download/details.aspx?id=54920 and click Download.
# Select whether to use the 32bit or 64bit (x64) version (usually it's the 64bit version).
# Double-click the executable file on your hard disk to start the setup program.
# Follow the instructions on the screen to complete the installation.

If 32-bit office is installed in machine then 64-bit ODBC driver need install using /passive parameter.
More information
* https://stackoverflow.com/questions/7116019/hand-install-of-64-bit-ms-access-odbc-drivers-when-32-bit-office-is-present
* https://techblog.aimms.com/2014/10/27/installing-32-bit-and-64-bit-microsoft-access-drivers-next-to-each-other/

==== Read data from CSV file ====
In this example, data is loaded from CSV files located in the file system using ''Microsoft Access Text Driver (*.txt, *.csv)'' driver. Loaded files are C:\ProcessMiningData\ModelCaseAttributes.csv and C:\ProcessMiningData\ModelEventData.csv.
<pre>
{
"DataSource": {
"Cases": {
"DataSourceType": "odbc",
"OdbcConnectionString": "Driver={Microsoft Access Text Driver (*.txt, *.csv)};DefaultDir=C:\\ProcessMiningData\\;Extensions=asc,csv,tab,txt",
"OdbcQuery": "SELECT * FROM [ModelCaseAttributes.csv]",
"Columns": {
"CaseId": "Name"
}
},
"Events": {
"DataSourceType": "odbc",
"OdbcConnectionString": "Driver={Microsoft Access Text Driver (*.txt, *.csv)};DefaultDir=C:\\ProcessMiningData\\;Extensions=asc,csv,tab,txt",
"OdbcQuery": "SELECT * FROM [ModelEventData.csv]",
"Columns": {
"CaseId": "Case",
"EventType": "Event Type",
"Timestamp": "Start Time"
}
}
}
}
</pre>

When reading from CSV files, you may need to set the CSV file format for the ODBC driver using the '''Schema.ini''' file (more information: https://docs.microsoft.com/en-us/sql/odbc/microsoft/schema-ini-file-text-file-driver?view=sql-server-2017). Example: ODBC text driver may guess column data type and return null values in case when guessed column type not match. Guessing based top rows of data.

==== Read data from Excel file ====
In this example, data is loaded from a Excel file that is accessible in the file system. In this example, the loaded file is C:\ProcessMiningData\ModelData.xlsx and cases are in sheet ''MyCases'' and events in sheet ''MyEvents''.

<pre>
{
"DataSource": {
"Cases": {
"DataSourceType": "odbc",
"OdbcConnectionString": "Driver={Microsoft Excel Driver (*.xls, *.xlsx, *.xlsm, *.xlsb)};DBQ=C:\\ProcessMiningData\\ModelData.xlsx",
"OdbcQuery": "SELECT * FROM [MyCases$]",
"Columns": {
"CaseId": "Case ID"
}
},
"Events": {
"DataSourceType": "odbc",
"OdbcConnectionString": "Driver={Microsoft Excel Driver (*.xls, *.xlsx, *.xlsm, *.xlsb)};DBQ=C:\\ProcessMiningData\\ModelData.xlsx",
"OdbcQuery": "SELECT * FROM [MyEvents$]",
"Columns": {
"CaseId": "Case ID",
"EventType": "Activity",
"Timestamp": "Start Time"
}
}
}
}
</pre>

==== Read data from SQL Server table ====
Recommended driver: https://www.microsoft.com/en-us/download/details.aspx?id=56567

In this example, data is loaded from an SQL Server table. SQL Server hostname is ''myServerName'', instance name is ''myInstanceName'' and database name is ''MyDatabase''. The ''Trusted_Connection'' is for Windows authentication.

<pre>
{
"DataSource": {
"Cases": {
"DataSourceType": "odbc",
"OdbcConnectionString": "Driver={ODBC Driver 17 for SQL Server};Server=myServerName\\myInstanceName;DataBase=MyDatabase;Trusted_Connection=Yes;",
"OdbcQuery": "SELECT CASENAME, COST, COUNTRY, PRODUCT FROM CASES_TABLE",
"Columns": {
"CaseId": "CASENAME"
}
},
"Events": {
"DataSourceType": "odbc",
"OdbcConnectionString": "Driver={ODBC Driver 17 for SQL Server};Server=myServerName\\myInstanceName;DataBase=MyDatabase;Trusted_Connection=Yes;",
"OdbcQuery": "SELECT CASENAME, CREATED_DATE, CREATED_BY FROM EVENTS_TABLE",
"Columns": {
"CaseId": "CASENAME",
"Timestamp": "CREATED_DATE",
"EventType": "CREATED_BY"
}
}
}
}
</pre>

If SQL Server authentication is used, the connection string is
<pre>
Driver={ODBC Driver 17 for SQL Server};Server=myServerName\myInstanceName;DataBase=MyDatabase;Trusted_Connection=No;Uid=myUsername;PWD=myPassword;
</pre>

More about SQL Server connection strings: https://www.connectionstrings.com/sql-server/

=== Troubleshooting ===

The following error message may be encountered: ''System.Data.Odbc.OdbcException (0x80131937): ERROR [IM002] [Microsoft][ODBC Driver Manager] Data source name not found and no default driver specified''. Probable reason is that the ODBC driver is missing or driver name is not correct. To solve the issue:
* Check ODBC drivers is installed by running '''C:\Windows\System32\odbcad32.exe'''.
* Check the connection string.

The following error message may be encountered: '''ERROR [HY024] [Microsoft][ODBC Text Driver] '(unknown)' is not a valid path. Make sure that the path name is spelled correctly and that you are connected to the server on which the file resides.'''.
Example error when specified directory is missing:

Error when CSV file is missing: '''System.Data.Odbc.OdbcException (0x80131937): ERROR [42S02] [Microsoft][ODBC Text Driver] The Microsoft Access database engine could not find the object 'CaseAttributes.csv'. Make sure the object exists and that you spell its name and the path name correctly. If 'CaseAttributes.csv' is not a local object, check your network connection or contact the server administrator.'''

Error codes for troubleshooting: [https://docs.microsoft.com/en-us/sql/odbc/reference/appendixes/appendix-a-odbc-error-codes?view=sql-server-2017| ODBC Error Codes].

If the error message mention about Case or Event attributes named as ''F<column number>'' (e.g. F10), the data might be inconsistent, as there might be different amount of columns in different rows.

== Loading Data from Expression Datasource ==
Data (cases and events) loaded to a QPR ProcessAnalyzer model can be defined using an expression. The principle with column mappings is similar than in the odbc datasource.

{| class="wikitable"
!'''Property'''
! '''Description'''
|-
||DataSource/Cases/DataSourceType
||Use value '''expression''' when loading data from an expression. More information about DataSourceType, see [[QPR_ProcessAnalyzer_Model_JSON_Settings#Loading_Data_from_Datatables|Loading Data from Datatables]].
|-
||DataSource/Cases/Expression
||Expression to get cases. The data structure is an array of arrays, where the outer array contains rows and inner array contains data cells in a row. The first row must contain headers.
|-
||DataSource/Cases/Columns
||For more information, see [[QPR_ProcessAnalyzer_Model_JSON_Settings#Loading_Data_from_Datatables|Loading Data from Datatables]].
|-
||DataSource/Events/DataSourceType
||Use value '''expression''' when loading data from an expression. More information about DataSourceType, see [[QPR_ProcessAnalyzer_Model_JSON_Settings#Loading_Data_from_Datatables|Loading Data from Datatables]].
|-
||DataSource/Events/Expression
||Expression to get events. The data structure is an array of arrays, where the outer array contains rows and inner array contains data cells in a row. The first row must contain headers.
|-
||DataSource/Events/Columns
||For more information, see [[QPR_ProcessAnalyzer_Model_JSON_Settings#Loading_Data_from_Datatables|Loading Data from Datatables]].
|-
|}

Examples:

Create model from another model:
<pre>
{
  "DataSource": {
    "Events": {
      "DataSourceType": "expression",
      "Expression": "ConcatTop([[["CaseId", "EventType", "Timestamp"]], EventLogById(1).Events.[Case.Name, TypeName, Timestamp]])",
      "Columns": {
        "CaseId": "Case",
        "Timestamp": "Timestamp",
        "EventType": "EventType"
      }
    }
}
}
</pre>

<pre>
{
  "DataSource": {
    "Events": {
      "DataSourceType": "expression",
      "Expression": "Let(\"maxEventsPerModel\", 1000);Let(\"ms\", [\"SAP_OrderToCash\", \"BPIC13_incidents\"].(Let(\"modelName\", _), Models.Where(Name == modelName))[0]);Let(\"eventAttributes\", ToDictionary());ms.EventAttributes.(Let(\"ea\", _), eventAttributes.Set(ea.Name, ea));Let(\"orderedEventAttributes\", OrderByValue(eventAttributes.Keys));ConcatTop([[Flatten([\"Case\", \"EventType\", \"TimeStamp\", orderedEventAttributes])],ConcatTop(ms.EventLog.Events[NumberRange(0, Min(CountTop(_), maxEventsPerModel) - 1)].Flatten([Case.Name, Type.Name, TimeStamp, (Let(\"evt\", _), orderedEventAttributes.(Let(\"att\", _), evt.Attribute(att)))]))])",
      "Columns": {
        "CaseId": "Case",
        "Timestamp": "TimeStamp",
        "EventType": "EventType"
      }
    },
    "Cases": {
      "DataSourceType": "expression",
      "Expression": "Let(\"maxEventsPerModel\", 1000);Let(\"ms\", [\"SAP_OrderToCash\", \"BPIC13_incidents\"].(Let(\"modelName\", _), Models.Where(Name == modelName))[0]);Let(\"caseAttributes\", ToDictionary());ms.CaseAttributes.(Let(\"ca\", _), caseAttributes.Set(ca.Name, ca));Let(\"orderedCaseAttributes\", OrderByValue(caseAttributes.Keys));Let(\"cases\", ToDictionary());ms.EventLog.Events[NumberRange(0, Min(CountTop(_), maxEventsPerModel) - 1)].Case.(Let(\"c\", _), cases.Set(c, true));ConcatTop([[Flatten([\"Case\", \"Model\", orderedCaseAttributes])],cases.Keys.Flatten([Name, EventLog.Name, (Let(\"c\", _), orderedCaseAttributes.(Let(\"att\", _), c.Attribute(att)))])])",
      "Columns": {
        "CaseId": "Case"
      }
    }
  }
}
</pre>

<pre>
{
  "DataSource": {
    "Events": {
      "DataSourceType": "expression",
      "Expression": "[[\"Case\", \"EventType\", \"TimeStamp\"],[\"a\", \"et1\", DateTime(2019,1)],[\"a\", \"et2\", DateTime(2019,2)],[\"a\", \"et3\", DateTime(2019,3)],[\"b\", \"et1\", DateTime(2019,2)],[\"c\", \"et3\", DateTime(2019,2)],[\"c\", \"et2\", DateTime(2019,3)],[\"c\", \"et2\", DateTime(2019,4)],[\"c\", \"et3\", DateTime(2019,5)],[\"c\", \"et4\", DateTime(2019,6)]]",
      "Columns": {
        "CaseId": "Case",
        "Timestamp": "TimeStamp",
        "EventType": "EventType"
      }
    }
  }
}
</pre>

[[Category: QPR ProcessAnalyzer]]

SQL Scripting Commands

2019-07-23T06:46:52Z

VesKivi: /* --#RemoveEvents */

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.

= --#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 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 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.
; '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.
: 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.
: In QPR ProcessAnalyzer Xpress or QPR ProcessAnalyzer Database, it is always possible to use network credentials.
; '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.
;<nowiki><other parameters></nowiki>
: All the rest of the passed parameters not listed above are added as extra headers to the request. Optional.

== Result ==
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>@_ResponseStatusCode</code> The numeric status code received from the remote server. INT.
: <code>@_ResponseSuccess</code> True only if the request returned status code that represents a success. BIT.

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

= --#CreateFilter =
Creates a new filter with the specified parameters. Returns the id of the newly created filter in SQL dynamic variable @_CreatedFilterId.

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'
: Id of the filter/view for which the new filter is applied. Mandatory.
; 'FilterType'
: Type of the additional filter to apply. Supported values are:
:: 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.

See examples at the [[CreateFilter Script Examples]] page.

= --#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:<br/>
; '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:
: <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.

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

= --#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. 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:<br/>
; '<Analysis Parameter>'
: See [[QPR ProcessAnalyzer Analysis Parameters]] for a list of supported analysis parameters in QPR ProcessAnalyzer.
: The --#GetAnalysis command supports the following analysis types:
0.'''Flowchart Analysis'''

Draws the flowchart of model defined in parameter

1.'''Variation Analysis in the Chart Mode'''

Opens Variation analysis of the model defined

3.'''Path Analysis'''

Opens Path analysis of model defined

4.'''Event Type Analysis in the Chart Mode'''

Opens Event Type analysis of model defined

5.'''Case Analysis'''
Prints the detailed list of cases and attributes of defined model

6.'''Event Analysis'''

Prints the detailed list of Events from defined model

7.'''Event Type Analysis in the Table Mode'''

Opens Event Type analysis of model defined

8.'''Variation Analysis in the Table Mode'''

Opens Variation analysis of the model defined

9.'''Duration Analysis'''

Opens Duration analysis of the model defined

10.'''Profiling Analysis'''

Opens Profiling analysis of the model defined

11.'''User Report'''

Opens a detailed list of users in server

12.'''Operation Log Analysis'''

Opens the operation log of ProcessAnalyzer

13.'''Flow Analysis'''

Opens Flow analysis of the model defined

14.'''Influence Analysis'''

Open Influence analysis of model defined, with defined parameters

18.'''Data Table Analysis'''

Reads a data table from SQL server and stores it in temporary table

21.'''Model Report'''

Opens a detailed list of models in server

22.'''Project Report'''

Opens a detailed list of projects in server

23.'''Data Table Report'''

Opens a detailed list of data tables in server

24.'''Script Report'''

Opens a detailed list of scripts in server

25.'''RunScript'''

Starts a script (used in UI)

26.'''Event Type Analysis in the Trends Mode'''

Opens Event Type analysis of model defined

28.'''Profiling Analysis in the Trends Mode'''

Opens Profiling analysis of the model defined

29.'''Profiling Analysis in the Trends Mode'''

Opens duration influence analysis of model defined

30.'''Filter Report'''

Opens a detailed list of filters in a model defined

31.'''Filter Rule Report'''
Contains information about the filter rule in filter defined

32.'''Script Log Report'''

33.'''[[QPR_ProcessAnalyzer_Expression_Analysis|Expression Analysis]]'''

: 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 [[QPR ProcessAnalyzer 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.
; '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.
; 'Title'
: Optional. The title for the Excel sheet created when Show is TRUE or 1. Default value is the name of the analysis type.
; 'SheetName'
: Optional. The name of the Excel sheet created when Show is TRUE or 1. Default value is the name of the analysis type.

; 'PivotSheetName'
: Optional. The name of the Excel sheet to be created. The sheet will contain a pivot table that includes all columns and rows in the report. The pivot sheet doesn't support drill-down. The pivot sheet has the following additional parameters:
:; 'PivotFilters'
::A comma separated list of result sheet column names that should be used in pivot table filters dimension.
:; 'PivotRows'
:: A comma separated list of row names to be used in the pivot table rows dimension. To sort the results, add the following parameters separated by commas "(SortDirection=<Ascending or Descending>)" and/or "(SortBy=<Sort Field Name>)" to the row name. For example: "Region(SortDirection=Ascending, SortBy="Average of DurationDays"), Country(SortBy="Sum of Cost")"
:; 'PivotColumns'
:: A comma separated list of column names to be used in the pivot table columns dimension. To sort the results, add the following parameters separated by commas "(SortDirection=<Ascending or Descending>)" and/or "(SortBy=<Sort Field Name>)" to the column name. For example: "Region(SortDirection=Ascending, SortBy="Average of DurationDays"), Country(SortBy="Sum of Cost")"
:; 'PivotValues'
:: A comma separated list of column names to be used as the pivot table values. The summarize value field can be defined by adding a summarize value parameter to the end of each value name as follows: "(SummarizeBy=<Summarize value tag)". If the parameter is not defined, the Excel default value for summarize is used: "Sum" for numbers and "Count" for other types. The supported summarize value tags are: Sum, Count, Average, Max, Min, Product, CountNumbers, StdDev, StdDevp, Var, Varp. For example: "Duration Days(SummarizeBy="Average"),Cost(SummarizeBy="Sum")"
:; 'PivotTitle'
:: The title of the pivot sheet to be created. If undefined, the name defined in PivotSheetName will 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:
:<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.
; 'ScriptId'
: Mandatory with the RunScript analysis type. Defines the script that should be run.
; '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 the Script Log Report and Operation Log Analysis analysis types. A date time parameter which specifies the earliest start time in the log entries. Format is ISO8601: yyyy-mm-ddThh:mm:ss.fff. The maximum year is 2030 and the minimum year is 1970. 'fff' stands for fractions of seconds and it is given in 3ms accuracy and the last digit must be 0, 3 or 7.
:* For Script Log Report analysis type: Mandatory if ScriptIds parameter is not defined.
:* For Operation Log Analysis analysis type: Optional. Default value is no earliest start time limit.
; 'MaxStartTime'
: Used with Script Log Report and Operation Log Analysis analysis types. A date time parameter which specifies the latest start time in the log entries. Format is ISO8601: yyyy-mm-ddThh:mm:ss.fff. The maximum year is 2030 and the minimum year is 1970. 'fff' stands for fractions of seconds and it is given in 3ms accuracy and the last digit must be 0, 3 or 7. Optional. Default value is no latest start time limit.
; 'IncludeCaseVariationRelations'
: Used with Event Analysis analysis type. Boolean value (default value = FALSE). If set to TRUE, the result of the event analysis will include a "CaseIdToVariationIdMap" property which is an array. Every item in the array describes the mapping between a case and a variation by ids formatted as simple array of length 2 (first item being case id, the second being variation id of that case).
; 'IncludeEventTypeNames'
: Used with Event Analysis analysis type. Boolean value (default value = FALSE). If set to TRUE, the result of the event analysis will include an "EventTypeNames" property which is an array of objects. Every item in the array maps event type id ("Key" property) into the name of that event type ("Value" property).
; 'UseMillisecondsSince1970DateTimeFormatting'
: Used with Event Analysis analysis type. Boolean value (default value = FALSE). If set to TRUE, the start time of every event is actually an integer number of milliseconds after 1.1.1970.
; 'UseIdsInsteadOfNames'
: Used with Event Analysis analysis type. Boolean value (default = FALSE). If set to TRUE, instead of returning case and event type names, the event analysis returns case and event type identifiers.
; 'IncludeCaseAttributeValues'
: Used with Event Analysis analysis type. Boolean value (default = FALSE). If set to TRUE, the result of the event analysis will include a "CaseAttributeValues" array which is an array of arrays. The first item in each inner array is the id of the case. All the items following that are the attribute values of case attributes sorted by case attribute name.
; 'MaxTextLength'
: Used with Operation Log Analysis analysis type. Integer. The maximum number of characters to return from the 'Name', 'Session Id', 'User Name', 'Model Name', 'Message', and 'Additional Data' fields. If 0 (default), all characters are returned.
; 'MaximumCount'
: Used with Operation Log Analysis analysis type. Integer. The maximum amount of rows returned. Optional. Default value is 1000.
; 'ShowOpenOnly'
: Used with Operation Log Analysis analysis type. Boolean. When TRUE, the Operation Log Analysis returns only operations that don't have end time. Optional. Default value is FALSE.

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

= --#ImportCaseAttributes =
Loads Case Attributes from the data which the preceding SQL statements given as parameters provide into the specified model. This command takes two SELECT queries as parameters. Models with external data source ([[QPR_ProcessAnalyzer_Model_JSON_Settings#Loading_Data_from_ODBC_Datasources|ODBC_Datasource]]) not support this command.

== 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 an existing target model case attributes. TRUE or any other Integer than "0" = the existing case attributes in the target model are not deleted before import, FALSE or "0" = the existing case attributes of the target model are deleted before the import. If the target model is set to use another model as the Case Attribute Model, those case attributes are not deleted. Not used when creating a new model. Default value is TRUE.
; 'CatchOperationExceptions'
: Optional. Defines whether to stop the script execution or to continue to run the script from the next statement if an exception occurs when running the script:
: 1 = don't stop execution of the script, continue running the script from the next statement.
: 0 = stop execution of the current script and show the exception.
: The following script variables will be set and are shown in the script log:
: <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.

See examples at the [[ImportCaseAttributes Script Examples]] page.

= --#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.
; 'DataTableId' or 'DataTableName'
: The id or the name of the existing/new target data table.
; 'Append'
: Defines what to do with an existing target data table contents. TRUE or any other Integer than "0" = the existing contents in the target data table are not deleted before import, FALSE or "0" = the existing contents of the target data table are deleted before the import. Not used when creating a new data table.
; 'CatchOperationExceptions'
: Optional. Defines whether to stop the script execution or to continue to run the script from the next statement if an exception occurs when running the script:
: 1 = don't stop execution of the script, continue running the script from the next statement.
: 0 = stop execution of the current script and show the exception.
: The following script variables will be set and are shown in the script log:
:<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 if the query doesn't return any data, the data table is not created.

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

= --#ImportEvents =
Loads Events from the data which the preceding SQL statements given as parameters provide into the specified model. This command takes two SELECT queries as parameters. Models with external data source ([[QPR_ProcessAnalyzer_Model_JSON_Settings#Loading_Data_from_ODBC_Datasources|ODBC_Datasource]]) not support this command.
== 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 ==
; <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 ImportEvents command.

See examples at the [[ImportEvents Script Examples]] page.

= --#ImportEventsIncremental =
Synchronizes a model with event data in the specified event data table. May delete and/or add new events into the model. Events are matched between the model and the event data table as follows:

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

See examples in the [[ImportEventsIncremental Script Examples]] page.

= --#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.
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.
; 'DataTableId' or 'DataTableName'
: The id or the name of the existing/new target data table.
; 'Append'
: Defines what to do with an existing target data table 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:
:<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.

'''ODBC specific parameters'''
; 'OdbcConnectionString'
: 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]].
; '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.
; '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.

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

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

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.
; 'DataTableId' or 'DataTableName'
: The id or the name of the existing/new target data table.
; 'Append'
: Defines what to do with an existing target data table 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:
:<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.
'''OLE DB Query Parameters'''
; '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.
; '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.
; '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.

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

= --#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. 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/>
; '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.
; 'DataTableId' or 'DataTableName'
: The id or the name of the existing/new target data table.
; 'Append'
: Defines what to do with an existing target data table contents. TRUE or any other Integer than "0" = the existing contents in the target data table are not deleted before import, FALSE or "0" = the existing contents of the target data table are deleted before the import. Not used when creating a new data table.
; 'CatchOperationExceptions'
: Optional. Defines whether to stop the script execution or to continue to run the script from the next statement if an exception occurs when running the script:
: 1 = don't stop execution of the script, continue running the script from the next statement.
: 0 = stop execution of the current script and show the exception.
: The following script variables will be set and are shown in the script log:
:<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.
'''Salesforce Query Parameters'''
; 'SalesforceUser'
: Username for the Salesforce cloud.
; 'SalesforcePW'
: Password for the Salesforce cloud.
; 'SalesforceUrl'
: 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>.
; 'SalesforceQueryMode'
: 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()].
; 'SalesforceQuery'
: 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.
; '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. 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.

== Notes ==
If you get error in --#ImportSalesforceQuery PA Operation saying "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 lisence 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 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 Excel Client#Installing_SAP_Connector_for_Microsoft_.NET_Version_3.0_Dll_Files|some dlls]] not provided by QPR Software.

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'
: If this parameter is given, store the results into a temporary SQL table in ETL sandbox.
If the TargetTable parameter is not given, use the following destination parameters:
; 'ProjectId' or 'ProjectName'
: The id or the name of the project in which the target data table exists.
; 'DataTableId' or 'DataTableName'
: The id or the name of the existing/new target data table.
; 'Append'
: Defines what to do with an existing target data table 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:
:<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.

'''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.
; '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.
; '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.
; '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.
; '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.
; '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.
; '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.
; '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.

'''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.
; '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.
; 'SapPeakConnectionsLimit'
: 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'
: 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'
: 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.
; '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.
; '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.
; '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.
; '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.
; '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.
; '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.
; '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 [[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'
: 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'
: 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.

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

= --#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.
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.
; 'DataTableId' or 'DataTableName'
: The id or the name of the existing/new target data table.
; 'Append'
: Defines what to do with an existing target data table 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:
:<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.
'''SQL Query Parameters'''
; '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.
; '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.
; '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.

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

= --#RemoveCases =
Removes all or specified cases in the target model. This command takes two SELECT queries as parameters. Models with external data source ([[QPR_ProcessAnalyzer_Model_JSON_Settings#Loading_Data_from_ODBC_Datasources|ODBC_Datasource]]) not support this command.
== 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.

See examples at the [[RemoveCases Script Examples]] page.

= --#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. Models with external data source ([[QPR_ProcessAnalyzer_Model_JSON_Settings#Loading_Data_from_ODBC_Datasources|ODBC_Datasource]]) not support this command.
== 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 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.

See examples at the [[RemoveEvents Script Examples]] page.

= --#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 ==
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.
The possible arguments are as follows:
:* @_Argv - type INT: the number of provided parameters (from 0 to 10)
:* #_Arg1, ... #_Arg10: arguments passed to that script

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

See examples at the [[Run Script Examples]] page.

= --#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:<br/>
; '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.
'''E-mail Parameters'''
; 'EmailFrom'
: Defines the from address for this e-mail message. Mandatory.
; 'EmailTo'
: Defines the recipient(s) for this e-mail message given in a list separated by comma. Mandatory.
; 'EmailSubject'
: Defines the subject of the email. Default value is empty. Optional.
; 'EmailBody'
: Defines the message body. Default value is empty. Optional.
; 'EmailCc'
: Defines the carbon copy recipient(s) for this e-mail message given in a list separated by comma. Optional.
; 'EmailBcc'
: Defines the blind carbon copy recipient(s) for this e-mail message given in a list separated by comma. Optional.
; 'EmailIsBodyHtml'
: Defines whether the e-mail message body is in HTML. TRUE or any other Integer than "0" = body is in HTML, FALSE or "0" = body is not in HTML. Default value is FALSE. Optional.
; 'EmailSender'
: Defines the sender's address for this e-mail message. Default value is empty. Optional.
; 'EmailReplyTo'
: Defines the ReplyTo address(es) for the mail message given in a list separated by comma. Optional.
; 'EmailPriority',
: Defines the priority of this e-mail message. Possible values are "High", "Normal", and "Low". Default value is "Normal". Optional.
; 'EmailDeliveryNotification'
: Defines the delivery notifications for this e-mail message. Possible values are "Delay", "Never", "None", "OnFailure", and "OnSuccess". Default value is "None". Optional.
; 'EmailBodyEncoding'
: Defines the encoding used to encode the message body. Supported encodings are listed in the "Remarks" section at http://msdn.microsoft.com/en-us/library/System.Text.Encoding.aspx. Optional.
; 'EmailSubjectEncoding'
: Defines the encoding used for the subject content for this e-mail message. Supported encodings are listed in the "Remarks" section at http://msdn.microsoft.com/en-us/library/System.Text.Encoding.aspx. Optional.
; '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.

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

= --#ShowReport =
Creates a new Excel sheet containing a table that contains the results of the user specified SQL query. The result column names are the field names of the SQL query and the rows are the actual data rows of the SQL query. The report can be used to see, for example, the events that would be loaded into QPR ProcessAnalyzer before actually loading them. If the events have problems that cause errors when loaded it is useful to be able to see the row data in a report.
'''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 ==
A user specified SQL query to be shown in the configured Excel sheet.
; <nowiki>'<data>'</nowiki>
: 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:<br/>
; '<Analysis Parameter>'
: Optional. The [[QPR ProcessAnalyzer Analysis Parameters]] given for the operation. Some suggested parameters to be used:
:; 'Title'
:: The title of the created report. If not given, "Report" will be used as a default.
:; 'SheetName'
:: The name of the Excel sheet to be created.
:; 'MaximumCount'
:: The maximum number of rows to show (0 = all, default = 1000).

; 'PivotSheetName'
: Optional. The name of the Excel sheet to be created. The sheet will contain a pivot table that includes all columns and rows in the report. The pivot sheet doesn't support drill-down. The pivot sheet has the following additional parameters:
:; 'PivotFilters'
::A comma separated list of result sheet column names that should be used in pivot table filters dimension.
:; 'PivotRows'
:: A comma separated list of row names to be used in the pivot table rows dimension. To sort the results, add the following parameters separated by commas "(SortDirection=<Ascending or Descending>)" and/or "(SortBy=<Sort Field Name>)" to the row name. For example: "Region(SortDirection=Ascending, SortBy="Average of DurationDays"), Country(SortBy="Sum of Cost")"
:; 'PivotColumns'
:: A comma separated list of column names to be used in the pivot table columns dimension. To sort the results, add the following parameters separated by commas "(SortDirection=<Ascending or Descending>)" and/or "(SortBy=<Sort Field Name>)" to the column name. For example: "Region(SortDirection=Ascending, SortBy="Average of DurationDays"), Country(SortBy="Sum of Cost")"
:; 'PivotValues'
:: A comma separated list of column names to be used as the pivot table values. The summarize value field can be defined by adding a summarize value parameter to the end of each value name as follows: "(SummarizeBy=<Summarize value tag)". If the parameter is not defined, the Excel default value for summarize is used: "Sum" for numbers and "Count" for other types. The supported summarize value tags are: Sum, Count, Average, Max, Min, Product, CountNumbers, StdDev, StdDevp, Var, Varp. For example: "Duration Days(SummarizeBy="Average"),Cost(SummarizeBy="Sum")"
:; 'PivotTitle'
:: The title of the pivot sheet to be created. If undefined, the name defined in PivotSheetName will 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:
:<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.

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

= --#StartBackground =
Makes the script run in background starting from this command, so that using QPR ProcessAnalyzer Excel client is possible while the script is running. 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 [[QPR_ProcessAnalyzer_Logs#Script_Log|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. 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.

This command is supported only for QPR ProcessAnalyzer Service based data source connections (i.e. not supported for Xpress or Database activations). 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 [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.

SQL Scripting Commands

2019-07-23T06:46:34Z

VesKivi: /* --#RemoveCases */

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.

= --#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 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 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.
; '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.
: 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.
: In QPR ProcessAnalyzer Xpress or QPR ProcessAnalyzer Database, it is always possible to use network credentials.
; '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.
;<nowiki><other parameters></nowiki>
: All the rest of the passed parameters not listed above are added as extra headers to the request. Optional.

== Result ==
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>@_ResponseStatusCode</code> The numeric status code received from the remote server. INT.
: <code>@_ResponseSuccess</code> True only if the request returned status code that represents a success. BIT.

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

= --#CreateFilter =
Creates a new filter with the specified parameters. Returns the id of the newly created filter in SQL dynamic variable @_CreatedFilterId.

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'
: Id of the filter/view for which the new filter is applied. Mandatory.
; 'FilterType'
: Type of the additional filter to apply. Supported values are:
:: 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.

See examples at the [[CreateFilter Script Examples]] page.

= --#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:<br/>
; '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:
: <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.

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

= --#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. 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:<br/>
; '<Analysis Parameter>'
: See [[QPR ProcessAnalyzer Analysis Parameters]] for a list of supported analysis parameters in QPR ProcessAnalyzer.
: The --#GetAnalysis command supports the following analysis types:
0.'''Flowchart Analysis'''

Draws the flowchart of model defined in parameter

1.'''Variation Analysis in the Chart Mode'''

Opens Variation analysis of the model defined

3.'''Path Analysis'''

Opens Path analysis of model defined

4.'''Event Type Analysis in the Chart Mode'''

Opens Event Type analysis of model defined

5.'''Case Analysis'''
Prints the detailed list of cases and attributes of defined model

6.'''Event Analysis'''

Prints the detailed list of Events from defined model

7.'''Event Type Analysis in the Table Mode'''

Opens Event Type analysis of model defined

8.'''Variation Analysis in the Table Mode'''

Opens Variation analysis of the model defined

9.'''Duration Analysis'''

Opens Duration analysis of the model defined

10.'''Profiling Analysis'''

Opens Profiling analysis of the model defined

11.'''User Report'''

Opens a detailed list of users in server

12.'''Operation Log Analysis'''

Opens the operation log of ProcessAnalyzer

13.'''Flow Analysis'''

Opens Flow analysis of the model defined

14.'''Influence Analysis'''

Open Influence analysis of model defined, with defined parameters

18.'''Data Table Analysis'''

Reads a data table from SQL server and stores it in temporary table

21.'''Model Report'''

Opens a detailed list of models in server

22.'''Project Report'''

Opens a detailed list of projects in server

23.'''Data Table Report'''

Opens a detailed list of data tables in server

24.'''Script Report'''

Opens a detailed list of scripts in server

25.'''RunScript'''

Starts a script (used in UI)

26.'''Event Type Analysis in the Trends Mode'''

Opens Event Type analysis of model defined

28.'''Profiling Analysis in the Trends Mode'''

Opens Profiling analysis of the model defined

29.'''Profiling Analysis in the Trends Mode'''

Opens duration influence analysis of model defined

30.'''Filter Report'''

Opens a detailed list of filters in a model defined

31.'''Filter Rule Report'''
Contains information about the filter rule in filter defined

32.'''Script Log Report'''

33.'''[[QPR_ProcessAnalyzer_Expression_Analysis|Expression Analysis]]'''

: 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 [[QPR ProcessAnalyzer 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.
; '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.
; 'Title'
: Optional. The title for the Excel sheet created when Show is TRUE or 1. Default value is the name of the analysis type.
; 'SheetName'
: Optional. The name of the Excel sheet created when Show is TRUE or 1. Default value is the name of the analysis type.

; 'PivotSheetName'
: Optional. The name of the Excel sheet to be created. The sheet will contain a pivot table that includes all columns and rows in the report. The pivot sheet doesn't support drill-down. The pivot sheet has the following additional parameters:
:; 'PivotFilters'
::A comma separated list of result sheet column names that should be used in pivot table filters dimension.
:; 'PivotRows'
:: A comma separated list of row names to be used in the pivot table rows dimension. To sort the results, add the following parameters separated by commas "(SortDirection=<Ascending or Descending>)" and/or "(SortBy=<Sort Field Name>)" to the row name. For example: "Region(SortDirection=Ascending, SortBy="Average of DurationDays"), Country(SortBy="Sum of Cost")"
:; 'PivotColumns'
:: A comma separated list of column names to be used in the pivot table columns dimension. To sort the results, add the following parameters separated by commas "(SortDirection=<Ascending or Descending>)" and/or "(SortBy=<Sort Field Name>)" to the column name. For example: "Region(SortDirection=Ascending, SortBy="Average of DurationDays"), Country(SortBy="Sum of Cost")"
:; 'PivotValues'
:: A comma separated list of column names to be used as the pivot table values. The summarize value field can be defined by adding a summarize value parameter to the end of each value name as follows: "(SummarizeBy=<Summarize value tag)". If the parameter is not defined, the Excel default value for summarize is used: "Sum" for numbers and "Count" for other types. The supported summarize value tags are: Sum, Count, Average, Max, Min, Product, CountNumbers, StdDev, StdDevp, Var, Varp. For example: "Duration Days(SummarizeBy="Average"),Cost(SummarizeBy="Sum")"
:; 'PivotTitle'
:: The title of the pivot sheet to be created. If undefined, the name defined in PivotSheetName will 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:
:<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.
; 'ScriptId'
: Mandatory with the RunScript analysis type. Defines the script that should be run.
; '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 the Script Log Report and Operation Log Analysis analysis types. A date time parameter which specifies the earliest start time in the log entries. Format is ISO8601: yyyy-mm-ddThh:mm:ss.fff. The maximum year is 2030 and the minimum year is 1970. 'fff' stands for fractions of seconds and it is given in 3ms accuracy and the last digit must be 0, 3 or 7.
:* For Script Log Report analysis type: Mandatory if ScriptIds parameter is not defined.
:* For Operation Log Analysis analysis type: Optional. Default value is no earliest start time limit.
; 'MaxStartTime'
: Used with Script Log Report and Operation Log Analysis analysis types. A date time parameter which specifies the latest start time in the log entries. Format is ISO8601: yyyy-mm-ddThh:mm:ss.fff. The maximum year is 2030 and the minimum year is 1970. 'fff' stands for fractions of seconds and it is given in 3ms accuracy and the last digit must be 0, 3 or 7. Optional. Default value is no latest start time limit.
; 'IncludeCaseVariationRelations'
: Used with Event Analysis analysis type. Boolean value (default value = FALSE). If set to TRUE, the result of the event analysis will include a "CaseIdToVariationIdMap" property which is an array. Every item in the array describes the mapping between a case and a variation by ids formatted as simple array of length 2 (first item being case id, the second being variation id of that case).
; 'IncludeEventTypeNames'
: Used with Event Analysis analysis type. Boolean value (default value = FALSE). If set to TRUE, the result of the event analysis will include an "EventTypeNames" property which is an array of objects. Every item in the array maps event type id ("Key" property) into the name of that event type ("Value" property).
; 'UseMillisecondsSince1970DateTimeFormatting'
: Used with Event Analysis analysis type. Boolean value (default value = FALSE). If set to TRUE, the start time of every event is actually an integer number of milliseconds after 1.1.1970.
; 'UseIdsInsteadOfNames'
: Used with Event Analysis analysis type. Boolean value (default = FALSE). If set to TRUE, instead of returning case and event type names, the event analysis returns case and event type identifiers.
; 'IncludeCaseAttributeValues'
: Used with Event Analysis analysis type. Boolean value (default = FALSE). If set to TRUE, the result of the event analysis will include a "CaseAttributeValues" array which is an array of arrays. The first item in each inner array is the id of the case. All the items following that are the attribute values of case attributes sorted by case attribute name.
; 'MaxTextLength'
: Used with Operation Log Analysis analysis type. Integer. The maximum number of characters to return from the 'Name', 'Session Id', 'User Name', 'Model Name', 'Message', and 'Additional Data' fields. If 0 (default), all characters are returned.
; 'MaximumCount'
: Used with Operation Log Analysis analysis type. Integer. The maximum amount of rows returned. Optional. Default value is 1000.
; 'ShowOpenOnly'
: Used with Operation Log Analysis analysis type. Boolean. When TRUE, the Operation Log Analysis returns only operations that don't have end time. Optional. Default value is FALSE.

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

= --#ImportCaseAttributes =
Loads Case Attributes from the data which the preceding SQL statements given as parameters provide into the specified model. This command takes two SELECT queries as parameters. Models with external data source ([[QPR_ProcessAnalyzer_Model_JSON_Settings#Loading_Data_from_ODBC_Datasources|ODBC_Datasource]]) not support this command.

== 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 an existing target model case attributes. TRUE or any other Integer than "0" = the existing case attributes in the target model are not deleted before import, FALSE or "0" = the existing case attributes of the target model are deleted before the import. If the target model is set to use another model as the Case Attribute Model, those case attributes are not deleted. Not used when creating a new model. Default value is TRUE.
; 'CatchOperationExceptions'
: Optional. Defines whether to stop the script execution or to continue to run the script from the next statement if an exception occurs when running the script:
: 1 = don't stop execution of the script, continue running the script from the next statement.
: 0 = stop execution of the current script and show the exception.
: The following script variables will be set and are shown in the script log:
: <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.

See examples at the [[ImportCaseAttributes Script Examples]] page.

= --#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.
; 'DataTableId' or 'DataTableName'
: The id or the name of the existing/new target data table.
; 'Append'
: Defines what to do with an existing target data table contents. TRUE or any other Integer than "0" = the existing contents in the target data table are not deleted before import, FALSE or "0" = the existing contents of the target data table are deleted before the import. Not used when creating a new data table.
; 'CatchOperationExceptions'
: Optional. Defines whether to stop the script execution or to continue to run the script from the next statement if an exception occurs when running the script:
: 1 = don't stop execution of the script, continue running the script from the next statement.
: 0 = stop execution of the current script and show the exception.
: The following script variables will be set and are shown in the script log:
:<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 if the query doesn't return any data, the data table is not created.

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

= --#ImportEvents =
Loads Events from the data which the preceding SQL statements given as parameters provide into the specified model. This command takes two SELECT queries as parameters. Models with external data source ([[QPR_ProcessAnalyzer_Model_JSON_Settings#Loading_Data_from_ODBC_Datasources|ODBC_Datasource]]) not support this command.
== 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 ==
; <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 ImportEvents command.

See examples at the [[ImportEvents Script Examples]] page.

= --#ImportEventsIncremental =
Synchronizes a model with event data in the specified event data table. May delete and/or add new events into the model. Events are matched between the model and the event data table as follows:

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

See examples in the [[ImportEventsIncremental Script Examples]] page.

= --#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.
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.
; 'DataTableId' or 'DataTableName'
: The id or the name of the existing/new target data table.
; 'Append'
: Defines what to do with an existing target data table 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:
:<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.

'''ODBC specific parameters'''
; 'OdbcConnectionString'
: 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]].
; '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.
; '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.

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

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

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.
; 'DataTableId' or 'DataTableName'
: The id or the name of the existing/new target data table.
; 'Append'
: Defines what to do with an existing target data table 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:
:<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.
'''OLE DB Query Parameters'''
; '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.
; '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.
; '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.

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

= --#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. 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/>
; '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.
; 'DataTableId' or 'DataTableName'
: The id or the name of the existing/new target data table.
; 'Append'
: Defines what to do with an existing target data table contents. TRUE or any other Integer than "0" = the existing contents in the target data table are not deleted before import, FALSE or "0" = the existing contents of the target data table are deleted before the import. Not used when creating a new data table.
; 'CatchOperationExceptions'
: Optional. Defines whether to stop the script execution or to continue to run the script from the next statement if an exception occurs when running the script:
: 1 = don't stop execution of the script, continue running the script from the next statement.
: 0 = stop execution of the current script and show the exception.
: The following script variables will be set and are shown in the script log:
:<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.
'''Salesforce Query Parameters'''
; 'SalesforceUser'
: Username for the Salesforce cloud.
; 'SalesforcePW'
: Password for the Salesforce cloud.
; 'SalesforceUrl'
: 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>.
; 'SalesforceQueryMode'
: 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()].
; 'SalesforceQuery'
: 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.
; '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. 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.

== Notes ==
If you get error in --#ImportSalesforceQuery PA Operation saying "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 lisence 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 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 Excel Client#Installing_SAP_Connector_for_Microsoft_.NET_Version_3.0_Dll_Files|some dlls]] not provided by QPR Software.

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'
: If this parameter is given, store the results into a temporary SQL table in ETL sandbox.
If the TargetTable parameter is not given, use the following destination parameters:
; 'ProjectId' or 'ProjectName'
: The id or the name of the project in which the target data table exists.
; 'DataTableId' or 'DataTableName'
: The id or the name of the existing/new target data table.
; 'Append'
: Defines what to do with an existing target data table 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:
:<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.

'''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.
; '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.
; '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.
; '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.
; '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.
; '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.
; '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.
; '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.

'''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.
; '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.
; 'SapPeakConnectionsLimit'
: 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'
: 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'
: 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.
; '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.
; '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.
; '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.
; '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.
; '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.
; '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.
; '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 [[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'
: 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'
: 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.

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

= --#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.
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.
; 'DataTableId' or 'DataTableName'
: The id or the name of the existing/new target data table.
; 'Append'
: Defines what to do with an existing target data table 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:
:<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.
'''SQL Query Parameters'''
; '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.
; '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.
; '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.

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

= --#RemoveCases =
Removes all or specified cases in the target model. This command takes two SELECT queries as parameters. Models with external data source ([[QPR_ProcessAnalyzer_Model_JSON_Settings#Loading_Data_from_ODBC_Datasources|ODBC_Datasource]]) not support this command.
== 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.

See examples at the [[RemoveCases Script Examples]] page.

= --#RemoveEvents =
Removes all or specified events in the target model, but retains Cases, Event Types, and Variations. This command takes two SELECT queries as parameters.
== First Query ==
Configures the command using a SELECT statement returning two columns: the first column is for a key and the second one is for a value of that key. The values in both the key column and in the value column are of type NVARCHAR. The supported keys for this command are:<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 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.

See examples at the [[RemoveEvents Script Examples]] page.

= --#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 ==
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.
The possible arguments are as follows:
:* @_Argv - type INT: the number of provided parameters (from 0 to 10)
:* #_Arg1, ... #_Arg10: arguments passed to that script

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

See examples at the [[Run Script Examples]] page.

= --#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:<br/>
; '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.
'''E-mail Parameters'''
; 'EmailFrom'
: Defines the from address for this e-mail message. Mandatory.
; 'EmailTo'
: Defines the recipient(s) for this e-mail message given in a list separated by comma. Mandatory.
; 'EmailSubject'
: Defines the subject of the email. Default value is empty. Optional.
; 'EmailBody'
: Defines the message body. Default value is empty. Optional.
; 'EmailCc'
: Defines the carbon copy recipient(s) for this e-mail message given in a list separated by comma. Optional.
; 'EmailBcc'
: Defines the blind carbon copy recipient(s) for this e-mail message given in a list separated by comma. Optional.
; 'EmailIsBodyHtml'
: Defines whether the e-mail message body is in HTML. TRUE or any other Integer than "0" = body is in HTML, FALSE or "0" = body is not in HTML. Default value is FALSE. Optional.
; 'EmailSender'
: Defines the sender's address for this e-mail message. Default value is empty. Optional.
; 'EmailReplyTo'
: Defines the ReplyTo address(es) for the mail message given in a list separated by comma. Optional.
; 'EmailPriority',
: Defines the priority of this e-mail message. Possible values are "High", "Normal", and "Low". Default value is "Normal". Optional.
; 'EmailDeliveryNotification'
: Defines the delivery notifications for this e-mail message. Possible values are "Delay", "Never", "None", "OnFailure", and "OnSuccess". Default value is "None". Optional.
; 'EmailBodyEncoding'
: Defines the encoding used to encode the message body. Supported encodings are listed in the "Remarks" section at http://msdn.microsoft.com/en-us/library/System.Text.Encoding.aspx. Optional.
; 'EmailSubjectEncoding'
: Defines the encoding used for the subject content for this e-mail message. Supported encodings are listed in the "Remarks" section at http://msdn.microsoft.com/en-us/library/System.Text.Encoding.aspx. Optional.
; '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.

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

= --#ShowReport =
Creates a new Excel sheet containing a table that contains the results of the user specified SQL query. The result column names are the field names of the SQL query and the rows are the actual data rows of the SQL query. The report can be used to see, for example, the events that would be loaded into QPR ProcessAnalyzer before actually loading them. If the events have problems that cause errors when loaded it is useful to be able to see the row data in a report.
'''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 ==
A user specified SQL query to be shown in the configured Excel sheet.
; <nowiki>'<data>'</nowiki>
: 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:<br/>
; '<Analysis Parameter>'
: Optional. The [[QPR ProcessAnalyzer Analysis Parameters]] given for the operation. Some suggested parameters to be used:
:; 'Title'
:: The title of the created report. If not given, "Report" will be used as a default.
:; 'SheetName'
:: The name of the Excel sheet to be created.
:; 'MaximumCount'
:: The maximum number of rows to show (0 = all, default = 1000).

; 'PivotSheetName'
: Optional. The name of the Excel sheet to be created. The sheet will contain a pivot table that includes all columns and rows in the report. The pivot sheet doesn't support drill-down. The pivot sheet has the following additional parameters:
:; 'PivotFilters'
::A comma separated list of result sheet column names that should be used in pivot table filters dimension.
:; 'PivotRows'
:: A comma separated list of row names to be used in the pivot table rows dimension. To sort the results, add the following parameters separated by commas "(SortDirection=<Ascending or Descending>)" and/or "(SortBy=<Sort Field Name>)" to the row name. For example: "Region(SortDirection=Ascending, SortBy="Average of DurationDays"), Country(SortBy="Sum of Cost")"
:; 'PivotColumns'
:: A comma separated list of column names to be used in the pivot table columns dimension. To sort the results, add the following parameters separated by commas "(SortDirection=<Ascending or Descending>)" and/or "(SortBy=<Sort Field Name>)" to the column name. For example: "Region(SortDirection=Ascending, SortBy="Average of DurationDays"), Country(SortBy="Sum of Cost")"
:; 'PivotValues'
:: A comma separated list of column names to be used as the pivot table values. The summarize value field can be defined by adding a summarize value parameter to the end of each value name as follows: "(SummarizeBy=<Summarize value tag)". If the parameter is not defined, the Excel default value for summarize is used: "Sum" for numbers and "Count" for other types. The supported summarize value tags are: Sum, Count, Average, Max, Min, Product, CountNumbers, StdDev, StdDevp, Var, Varp. For example: "Duration Days(SummarizeBy="Average"),Cost(SummarizeBy="Sum")"
:; 'PivotTitle'
:: The title of the pivot sheet to be created. If undefined, the name defined in PivotSheetName will 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:
:<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.

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

= --#StartBackground =
Makes the script run in background starting from this command, so that using QPR ProcessAnalyzer Excel client is possible while the script is running. 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 [[QPR_ProcessAnalyzer_Logs#Script_Log|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. 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.

This command is supported only for QPR ProcessAnalyzer Service based data source connections (i.e. not supported for Xpress or Database activations). 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 [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.

SQL Scripting Commands

2019-07-23T06:45:48Z

VesKivi: /* --#ImportEventsIncremental */

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.

= --#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 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 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.
; '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.
: 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.
: In QPR ProcessAnalyzer Xpress or QPR ProcessAnalyzer Database, it is always possible to use network credentials.
; '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.
;<nowiki><other parameters></nowiki>
: All the rest of the passed parameters not listed above are added as extra headers to the request. Optional.

== Result ==
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>@_ResponseStatusCode</code> The numeric status code received from the remote server. INT.
: <code>@_ResponseSuccess</code> True only if the request returned status code that represents a success. BIT.

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

= --#CreateFilter =
Creates a new filter with the specified parameters. Returns the id of the newly created filter in SQL dynamic variable @_CreatedFilterId.

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'
: Id of the filter/view for which the new filter is applied. Mandatory.
; 'FilterType'
: Type of the additional filter to apply. Supported values are:
:: 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.

See examples at the [[CreateFilter Script Examples]] page.

= --#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:<br/>
; '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:
: <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.

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

= --#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. 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:<br/>
; '<Analysis Parameter>'
: See [[QPR ProcessAnalyzer Analysis Parameters]] for a list of supported analysis parameters in QPR ProcessAnalyzer.
: The --#GetAnalysis command supports the following analysis types:
0.'''Flowchart Analysis'''

Draws the flowchart of model defined in parameter

1.'''Variation Analysis in the Chart Mode'''

Opens Variation analysis of the model defined

3.'''Path Analysis'''

Opens Path analysis of model defined

4.'''Event Type Analysis in the Chart Mode'''

Opens Event Type analysis of model defined

5.'''Case Analysis'''
Prints the detailed list of cases and attributes of defined model

6.'''Event Analysis'''

Prints the detailed list of Events from defined model

7.'''Event Type Analysis in the Table Mode'''

Opens Event Type analysis of model defined

8.'''Variation Analysis in the Table Mode'''

Opens Variation analysis of the model defined

9.'''Duration Analysis'''

Opens Duration analysis of the model defined

10.'''Profiling Analysis'''

Opens Profiling analysis of the model defined

11.'''User Report'''

Opens a detailed list of users in server

12.'''Operation Log Analysis'''

Opens the operation log of ProcessAnalyzer

13.'''Flow Analysis'''

Opens Flow analysis of the model defined

14.'''Influence Analysis'''

Open Influence analysis of model defined, with defined parameters

18.'''Data Table Analysis'''

Reads a data table from SQL server and stores it in temporary table

21.'''Model Report'''

Opens a detailed list of models in server

22.'''Project Report'''

Opens a detailed list of projects in server

23.'''Data Table Report'''

Opens a detailed list of data tables in server

24.'''Script Report'''

Opens a detailed list of scripts in server

25.'''RunScript'''

Starts a script (used in UI)

26.'''Event Type Analysis in the Trends Mode'''

Opens Event Type analysis of model defined

28.'''Profiling Analysis in the Trends Mode'''

Opens Profiling analysis of the model defined

29.'''Profiling Analysis in the Trends Mode'''

Opens duration influence analysis of model defined

30.'''Filter Report'''

Opens a detailed list of filters in a model defined

31.'''Filter Rule Report'''
Contains information about the filter rule in filter defined

32.'''Script Log Report'''

33.'''[[QPR_ProcessAnalyzer_Expression_Analysis|Expression Analysis]]'''

: 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 [[QPR ProcessAnalyzer 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.
; '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.
; 'Title'
: Optional. The title for the Excel sheet created when Show is TRUE or 1. Default value is the name of the analysis type.
; 'SheetName'
: Optional. The name of the Excel sheet created when Show is TRUE or 1. Default value is the name of the analysis type.

; 'PivotSheetName'
: Optional. The name of the Excel sheet to be created. The sheet will contain a pivot table that includes all columns and rows in the report. The pivot sheet doesn't support drill-down. The pivot sheet has the following additional parameters:
:; 'PivotFilters'
::A comma separated list of result sheet column names that should be used in pivot table filters dimension.
:; 'PivotRows'
:: A comma separated list of row names to be used in the pivot table rows dimension. To sort the results, add the following parameters separated by commas "(SortDirection=<Ascending or Descending>)" and/or "(SortBy=<Sort Field Name>)" to the row name. For example: "Region(SortDirection=Ascending, SortBy="Average of DurationDays"), Country(SortBy="Sum of Cost")"
:; 'PivotColumns'
:: A comma separated list of column names to be used in the pivot table columns dimension. To sort the results, add the following parameters separated by commas "(SortDirection=<Ascending or Descending>)" and/or "(SortBy=<Sort Field Name>)" to the column name. For example: "Region(SortDirection=Ascending, SortBy="Average of DurationDays"), Country(SortBy="Sum of Cost")"
:; 'PivotValues'
:: A comma separated list of column names to be used as the pivot table values. The summarize value field can be defined by adding a summarize value parameter to the end of each value name as follows: "(SummarizeBy=<Summarize value tag)". If the parameter is not defined, the Excel default value for summarize is used: "Sum" for numbers and "Count" for other types. The supported summarize value tags are: Sum, Count, Average, Max, Min, Product, CountNumbers, StdDev, StdDevp, Var, Varp. For example: "Duration Days(SummarizeBy="Average"),Cost(SummarizeBy="Sum")"
:; 'PivotTitle'
:: The title of the pivot sheet to be created. If undefined, the name defined in PivotSheetName will 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:
:<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.
; 'ScriptId'
: Mandatory with the RunScript analysis type. Defines the script that should be run.
; '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 the Script Log Report and Operation Log Analysis analysis types. A date time parameter which specifies the earliest start time in the log entries. Format is ISO8601: yyyy-mm-ddThh:mm:ss.fff. The maximum year is 2030 and the minimum year is 1970. 'fff' stands for fractions of seconds and it is given in 3ms accuracy and the last digit must be 0, 3 or 7.
:* For Script Log Report analysis type: Mandatory if ScriptIds parameter is not defined.
:* For Operation Log Analysis analysis type: Optional. Default value is no earliest start time limit.
; 'MaxStartTime'
: Used with Script Log Report and Operation Log Analysis analysis types. A date time parameter which specifies the latest start time in the log entries. Format is ISO8601: yyyy-mm-ddThh:mm:ss.fff. The maximum year is 2030 and the minimum year is 1970. 'fff' stands for fractions of seconds and it is given in 3ms accuracy and the last digit must be 0, 3 or 7. Optional. Default value is no latest start time limit.
; 'IncludeCaseVariationRelations'
: Used with Event Analysis analysis type. Boolean value (default value = FALSE). If set to TRUE, the result of the event analysis will include a "CaseIdToVariationIdMap" property which is an array. Every item in the array describes the mapping between a case and a variation by ids formatted as simple array of length 2 (first item being case id, the second being variation id of that case).
; 'IncludeEventTypeNames'
: Used with Event Analysis analysis type. Boolean value (default value = FALSE). If set to TRUE, the result of the event analysis will include an "EventTypeNames" property which is an array of objects. Every item in the array maps event type id ("Key" property) into the name of that event type ("Value" property).
; 'UseMillisecondsSince1970DateTimeFormatting'
: Used with Event Analysis analysis type. Boolean value (default value = FALSE). If set to TRUE, the start time of every event is actually an integer number of milliseconds after 1.1.1970.
; 'UseIdsInsteadOfNames'
: Used with Event Analysis analysis type. Boolean value (default = FALSE). If set to TRUE, instead of returning case and event type names, the event analysis returns case and event type identifiers.
; 'IncludeCaseAttributeValues'
: Used with Event Analysis analysis type. Boolean value (default = FALSE). If set to TRUE, the result of the event analysis will include a "CaseAttributeValues" array which is an array of arrays. The first item in each inner array is the id of the case. All the items following that are the attribute values of case attributes sorted by case attribute name.
; 'MaxTextLength'
: Used with Operation Log Analysis analysis type. Integer. The maximum number of characters to return from the 'Name', 'Session Id', 'User Name', 'Model Name', 'Message', and 'Additional Data' fields. If 0 (default), all characters are returned.
; 'MaximumCount'
: Used with Operation Log Analysis analysis type. Integer. The maximum amount of rows returned. Optional. Default value is 1000.
; 'ShowOpenOnly'
: Used with Operation Log Analysis analysis type. Boolean. When TRUE, the Operation Log Analysis returns only operations that don't have end time. Optional. Default value is FALSE.

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

= --#ImportCaseAttributes =
Loads Case Attributes from the data which the preceding SQL statements given as parameters provide into the specified model. This command takes two SELECT queries as parameters. Models with external data source ([[QPR_ProcessAnalyzer_Model_JSON_Settings#Loading_Data_from_ODBC_Datasources|ODBC_Datasource]]) not support this command.

== 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 an existing target model case attributes. TRUE or any other Integer than "0" = the existing case attributes in the target model are not deleted before import, FALSE or "0" = the existing case attributes of the target model are deleted before the import. If the target model is set to use another model as the Case Attribute Model, those case attributes are not deleted. Not used when creating a new model. Default value is TRUE.
; 'CatchOperationExceptions'
: Optional. Defines whether to stop the script execution or to continue to run the script from the next statement if an exception occurs when running the script:
: 1 = don't stop execution of the script, continue running the script from the next statement.
: 0 = stop execution of the current script and show the exception.
: The following script variables will be set and are shown in the script log:
: <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.

See examples at the [[ImportCaseAttributes Script Examples]] page.

= --#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.
; 'DataTableId' or 'DataTableName'
: The id or the name of the existing/new target data table.
; 'Append'
: Defines what to do with an existing target data table contents. TRUE or any other Integer than "0" = the existing contents in the target data table are not deleted before import, FALSE or "0" = the existing contents of the target data table are deleted before the import. Not used when creating a new data table.
; 'CatchOperationExceptions'
: Optional. Defines whether to stop the script execution or to continue to run the script from the next statement if an exception occurs when running the script:
: 1 = don't stop execution of the script, continue running the script from the next statement.
: 0 = stop execution of the current script and show the exception.
: The following script variables will be set and are shown in the script log:
:<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 if the query doesn't return any data, the data table is not created.

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

= --#ImportEvents =
Loads Events from the data which the preceding SQL statements given as parameters provide into the specified model. This command takes two SELECT queries as parameters. Models with external data source ([[QPR_ProcessAnalyzer_Model_JSON_Settings#Loading_Data_from_ODBC_Datasources|ODBC_Datasource]]) not support this command.
== 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 ==
; <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 ImportEvents command.

See examples at the [[ImportEvents Script Examples]] page.

= --#ImportEventsIncremental =
Synchronizes a model with event data in the specified event data table. May delete and/or add new events into the model. Events are matched between the model and the event data table as follows:

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

See examples in the [[ImportEventsIncremental Script Examples]] page.

= --#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.
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.
; 'DataTableId' or 'DataTableName'
: The id or the name of the existing/new target data table.
; 'Append'
: Defines what to do with an existing target data table 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:
:<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.

'''ODBC specific parameters'''
; 'OdbcConnectionString'
: 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]].
; '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.
; '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.

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

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

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.
; 'DataTableId' or 'DataTableName'
: The id or the name of the existing/new target data table.
; 'Append'
: Defines what to do with an existing target data table 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:
:<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.
'''OLE DB Query Parameters'''
; '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.
; '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.
; '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.

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

= --#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. 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/>
; '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.
; 'DataTableId' or 'DataTableName'
: The id or the name of the existing/new target data table.
; 'Append'
: Defines what to do with an existing target data table contents. TRUE or any other Integer than "0" = the existing contents in the target data table are not deleted before import, FALSE or "0" = the existing contents of the target data table are deleted before the import. Not used when creating a new data table.
; 'CatchOperationExceptions'
: Optional. Defines whether to stop the script execution or to continue to run the script from the next statement if an exception occurs when running the script:
: 1 = don't stop execution of the script, continue running the script from the next statement.
: 0 = stop execution of the current script and show the exception.
: The following script variables will be set and are shown in the script log:
:<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.
'''Salesforce Query Parameters'''
; 'SalesforceUser'
: Username for the Salesforce cloud.
; 'SalesforcePW'
: Password for the Salesforce cloud.
; 'SalesforceUrl'
: 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>.
; 'SalesforceQueryMode'
: 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()].
; 'SalesforceQuery'
: 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.
; '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. 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.

== Notes ==
If you get error in --#ImportSalesforceQuery PA Operation saying "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 lisence 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 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 Excel Client#Installing_SAP_Connector_for_Microsoft_.NET_Version_3.0_Dll_Files|some dlls]] not provided by QPR Software.

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'
: If this parameter is given, store the results into a temporary SQL table in ETL sandbox.
If the TargetTable parameter is not given, use the following destination parameters:
; 'ProjectId' or 'ProjectName'
: The id or the name of the project in which the target data table exists.
; 'DataTableId' or 'DataTableName'
: The id or the name of the existing/new target data table.
; 'Append'
: Defines what to do with an existing target data table 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:
:<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.

'''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.
; '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.
; '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.
; '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.
; '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.
; '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.
; '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.
; '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.

'''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.
; '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.
; 'SapPeakConnectionsLimit'
: 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'
: 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'
: 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.
; '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.
; '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.
; '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.
; '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.
; '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.
; '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.
; '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 [[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'
: 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'
: 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.

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

= --#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.
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.
; 'DataTableId' or 'DataTableName'
: The id or the name of the existing/new target data table.
; 'Append'
: Defines what to do with an existing target data table 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:
:<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.
'''SQL Query Parameters'''
; '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.
; '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.
; '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.

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

= --#RemoveCases =
Removes all or specified cases in the target model. This command takes two SELECT queries as parameters.
== First Query ==
Configures the command using a SELECT statement returning two columns: the first column is for a key and the second one is for a value of that key. The values in both the key column and in the value column are of type NVARCHAR. The supported keys for this command are:<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.

See examples at the [[RemoveCases Script Examples]] page.

= --#RemoveEvents =
Removes all or specified events in the target model, but retains Cases, Event Types, and Variations. This command takes two SELECT queries as parameters.
== First Query ==
Configures the command using a SELECT statement returning two columns: the first column is for a key and the second one is for a value of that key. The values in both the key column and in the value column are of type NVARCHAR. The supported keys for this command are:<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 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.

See examples at the [[RemoveEvents Script Examples]] page.

= --#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 ==
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.
The possible arguments are as follows:
:* @_Argv - type INT: the number of provided parameters (from 0 to 10)
:* #_Arg1, ... #_Arg10: arguments passed to that script

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

See examples at the [[Run Script Examples]] page.

= --#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:<br/>
; '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.
'''E-mail Parameters'''
; 'EmailFrom'
: Defines the from address for this e-mail message. Mandatory.
; 'EmailTo'
: Defines the recipient(s) for this e-mail message given in a list separated by comma. Mandatory.
; 'EmailSubject'
: Defines the subject of the email. Default value is empty. Optional.
; 'EmailBody'
: Defines the message body. Default value is empty. Optional.
; 'EmailCc'
: Defines the carbon copy recipient(s) for this e-mail message given in a list separated by comma. Optional.
; 'EmailBcc'
: Defines the blind carbon copy recipient(s) for this e-mail message given in a list separated by comma. Optional.
; 'EmailIsBodyHtml'
: Defines whether the e-mail message body is in HTML. TRUE or any other Integer than "0" = body is in HTML, FALSE or "0" = body is not in HTML. Default value is FALSE. Optional.
; 'EmailSender'
: Defines the sender's address for this e-mail message. Default value is empty. Optional.
; 'EmailReplyTo'
: Defines the ReplyTo address(es) for the mail message given in a list separated by comma. Optional.
; 'EmailPriority',
: Defines the priority of this e-mail message. Possible values are "High", "Normal", and "Low". Default value is "Normal". Optional.
; 'EmailDeliveryNotification'
: Defines the delivery notifications for this e-mail message. Possible values are "Delay", "Never", "None", "OnFailure", and "OnSuccess". Default value is "None". Optional.
; 'EmailBodyEncoding'
: Defines the encoding used to encode the message body. Supported encodings are listed in the "Remarks" section at http://msdn.microsoft.com/en-us/library/System.Text.Encoding.aspx. Optional.
; 'EmailSubjectEncoding'
: Defines the encoding used for the subject content for this e-mail message. Supported encodings are listed in the "Remarks" section at http://msdn.microsoft.com/en-us/library/System.Text.Encoding.aspx. Optional.
; '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.

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

= --#ShowReport =
Creates a new Excel sheet containing a table that contains the results of the user specified SQL query. The result column names are the field names of the SQL query and the rows are the actual data rows of the SQL query. The report can be used to see, for example, the events that would be loaded into QPR ProcessAnalyzer before actually loading them. If the events have problems that cause errors when loaded it is useful to be able to see the row data in a report.
'''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 ==
A user specified SQL query to be shown in the configured Excel sheet.
; <nowiki>'<data>'</nowiki>
: 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:<br/>
; '<Analysis Parameter>'
: Optional. The [[QPR ProcessAnalyzer Analysis Parameters]] given for the operation. Some suggested parameters to be used:
:; 'Title'
:: The title of the created report. If not given, "Report" will be used as a default.
:; 'SheetName'
:: The name of the Excel sheet to be created.
:; 'MaximumCount'
:: The maximum number of rows to show (0 = all, default = 1000).

; 'PivotSheetName'
: Optional. The name of the Excel sheet to be created. The sheet will contain a pivot table that includes all columns and rows in the report. The pivot sheet doesn't support drill-down. The pivot sheet has the following additional parameters:
:; 'PivotFilters'
::A comma separated list of result sheet column names that should be used in pivot table filters dimension.
:; 'PivotRows'
:: A comma separated list of row names to be used in the pivot table rows dimension. To sort the results, add the following parameters separated by commas "(SortDirection=<Ascending or Descending>)" and/or "(SortBy=<Sort Field Name>)" to the row name. For example: "Region(SortDirection=Ascending, SortBy="Average of DurationDays"), Country(SortBy="Sum of Cost")"
:; 'PivotColumns'
:: A comma separated list of column names to be used in the pivot table columns dimension. To sort the results, add the following parameters separated by commas "(SortDirection=<Ascending or Descending>)" and/or "(SortBy=<Sort Field Name>)" to the column name. For example: "Region(SortDirection=Ascending, SortBy="Average of DurationDays"), Country(SortBy="Sum of Cost")"
:; 'PivotValues'
:: A comma separated list of column names to be used as the pivot table values. The summarize value field can be defined by adding a summarize value parameter to the end of each value name as follows: "(SummarizeBy=<Summarize value tag)". If the parameter is not defined, the Excel default value for summarize is used: "Sum" for numbers and "Count" for other types. The supported summarize value tags are: Sum, Count, Average, Max, Min, Product, CountNumbers, StdDev, StdDevp, Var, Varp. For example: "Duration Days(SummarizeBy="Average"),Cost(SummarizeBy="Sum")"
:; 'PivotTitle'
:: The title of the pivot sheet to be created. If undefined, the name defined in PivotSheetName will 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:
:<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.

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

= --#StartBackground =
Makes the script run in background starting from this command, so that using QPR ProcessAnalyzer Excel client is possible while the script is running. 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 [[QPR_ProcessAnalyzer_Logs#Script_Log|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. 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.

This command is supported only for QPR ProcessAnalyzer Service based data source connections (i.e. not supported for Xpress or Database activations). 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 [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.

SQL Scripting Commands

2019-07-23T06:45:29Z

VesKivi: /* --#ImportEventsIncremental */

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.

= --#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 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 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.
; '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.
: 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.
: In QPR ProcessAnalyzer Xpress or QPR ProcessAnalyzer Database, it is always possible to use network credentials.
; '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.
;<nowiki><other parameters></nowiki>
: All the rest of the passed parameters not listed above are added as extra headers to the request. Optional.

== Result ==
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>@_ResponseStatusCode</code> The numeric status code received from the remote server. INT.
: <code>@_ResponseSuccess</code> True only if the request returned status code that represents a success. BIT.

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

= --#CreateFilter =
Creates a new filter with the specified parameters. Returns the id of the newly created filter in SQL dynamic variable @_CreatedFilterId.

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'
: Id of the filter/view for which the new filter is applied. Mandatory.
; 'FilterType'
: Type of the additional filter to apply. Supported values are:
:: 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.

See examples at the [[CreateFilter Script Examples]] page.

= --#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:<br/>
; '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:
: <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.

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

= --#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. 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:<br/>
; '<Analysis Parameter>'
: See [[QPR ProcessAnalyzer Analysis Parameters]] for a list of supported analysis parameters in QPR ProcessAnalyzer.
: The --#GetAnalysis command supports the following analysis types:
0.'''Flowchart Analysis'''

Draws the flowchart of model defined in parameter

1.'''Variation Analysis in the Chart Mode'''

Opens Variation analysis of the model defined

3.'''Path Analysis'''

Opens Path analysis of model defined

4.'''Event Type Analysis in the Chart Mode'''

Opens Event Type analysis of model defined

5.'''Case Analysis'''
Prints the detailed list of cases and attributes of defined model

6.'''Event Analysis'''

Prints the detailed list of Events from defined model

7.'''Event Type Analysis in the Table Mode'''

Opens Event Type analysis of model defined

8.'''Variation Analysis in the Table Mode'''

Opens Variation analysis of the model defined

9.'''Duration Analysis'''

Opens Duration analysis of the model defined

10.'''Profiling Analysis'''

Opens Profiling analysis of the model defined

11.'''User Report'''

Opens a detailed list of users in server

12.'''Operation Log Analysis'''

Opens the operation log of ProcessAnalyzer

13.'''Flow Analysis'''

Opens Flow analysis of the model defined

14.'''Influence Analysis'''

Open Influence analysis of model defined, with defined parameters

18.'''Data Table Analysis'''

Reads a data table from SQL server and stores it in temporary table

21.'''Model Report'''

Opens a detailed list of models in server

22.'''Project Report'''

Opens a detailed list of projects in server

23.'''Data Table Report'''

Opens a detailed list of data tables in server

24.'''Script Report'''

Opens a detailed list of scripts in server

25.'''RunScript'''

Starts a script (used in UI)

26.'''Event Type Analysis in the Trends Mode'''

Opens Event Type analysis of model defined

28.'''Profiling Analysis in the Trends Mode'''

Opens Profiling analysis of the model defined

29.'''Profiling Analysis in the Trends Mode'''

Opens duration influence analysis of model defined

30.'''Filter Report'''

Opens a detailed list of filters in a model defined

31.'''Filter Rule Report'''
Contains information about the filter rule in filter defined

32.'''Script Log Report'''

33.'''[[QPR_ProcessAnalyzer_Expression_Analysis|Expression Analysis]]'''

: 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 [[QPR ProcessAnalyzer 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.
; '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.
; 'Title'
: Optional. The title for the Excel sheet created when Show is TRUE or 1. Default value is the name of the analysis type.
; 'SheetName'
: Optional. The name of the Excel sheet created when Show is TRUE or 1. Default value is the name of the analysis type.

; 'PivotSheetName'
: Optional. The name of the Excel sheet to be created. The sheet will contain a pivot table that includes all columns and rows in the report. The pivot sheet doesn't support drill-down. The pivot sheet has the following additional parameters:
:; 'PivotFilters'
::A comma separated list of result sheet column names that should be used in pivot table filters dimension.
:; 'PivotRows'
:: A comma separated list of row names to be used in the pivot table rows dimension. To sort the results, add the following parameters separated by commas "(SortDirection=<Ascending or Descending>)" and/or "(SortBy=<Sort Field Name>)" to the row name. For example: "Region(SortDirection=Ascending, SortBy="Average of DurationDays"), Country(SortBy="Sum of Cost")"
:; 'PivotColumns'
:: A comma separated list of column names to be used in the pivot table columns dimension. To sort the results, add the following parameters separated by commas "(SortDirection=<Ascending or Descending>)" and/or "(SortBy=<Sort Field Name>)" to the column name. For example: "Region(SortDirection=Ascending, SortBy="Average of DurationDays"), Country(SortBy="Sum of Cost")"
:; 'PivotValues'
:: A comma separated list of column names to be used as the pivot table values. The summarize value field can be defined by adding a summarize value parameter to the end of each value name as follows: "(SummarizeBy=<Summarize value tag)". If the parameter is not defined, the Excel default value for summarize is used: "Sum" for numbers and "Count" for other types. The supported summarize value tags are: Sum, Count, Average, Max, Min, Product, CountNumbers, StdDev, StdDevp, Var, Varp. For example: "Duration Days(SummarizeBy="Average"),Cost(SummarizeBy="Sum")"
:; 'PivotTitle'
:: The title of the pivot sheet to be created. If undefined, the name defined in PivotSheetName will 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:
:<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.
; 'ScriptId'
: Mandatory with the RunScript analysis type. Defines the script that should be run.
; '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 the Script Log Report and Operation Log Analysis analysis types. A date time parameter which specifies the earliest start time in the log entries. Format is ISO8601: yyyy-mm-ddThh:mm:ss.fff. The maximum year is 2030 and the minimum year is 1970. 'fff' stands for fractions of seconds and it is given in 3ms accuracy and the last digit must be 0, 3 or 7.
:* For Script Log Report analysis type: Mandatory if ScriptIds parameter is not defined.
:* For Operation Log Analysis analysis type: Optional. Default value is no earliest start time limit.
; 'MaxStartTime'
: Used with Script Log Report and Operation Log Analysis analysis types. A date time parameter which specifies the latest start time in the log entries. Format is ISO8601: yyyy-mm-ddThh:mm:ss.fff. The maximum year is 2030 and the minimum year is 1970. 'fff' stands for fractions of seconds and it is given in 3ms accuracy and the last digit must be 0, 3 or 7. Optional. Default value is no latest start time limit.
; 'IncludeCaseVariationRelations'
: Used with Event Analysis analysis type. Boolean value (default value = FALSE). If set to TRUE, the result of the event analysis will include a "CaseIdToVariationIdMap" property which is an array. Every item in the array describes the mapping between a case and a variation by ids formatted as simple array of length 2 (first item being case id, the second being variation id of that case).
; 'IncludeEventTypeNames'
: Used with Event Analysis analysis type. Boolean value (default value = FALSE). If set to TRUE, the result of the event analysis will include an "EventTypeNames" property which is an array of objects. Every item in the array maps event type id ("Key" property) into the name of that event type ("Value" property).
; 'UseMillisecondsSince1970DateTimeFormatting'
: Used with Event Analysis analysis type. Boolean value (default value = FALSE). If set to TRUE, the start time of every event is actually an integer number of milliseconds after 1.1.1970.
; 'UseIdsInsteadOfNames'
: Used with Event Analysis analysis type. Boolean value (default = FALSE). If set to TRUE, instead of returning case and event type names, the event analysis returns case and event type identifiers.
; 'IncludeCaseAttributeValues'
: Used with Event Analysis analysis type. Boolean value (default = FALSE). If set to TRUE, the result of the event analysis will include a "CaseAttributeValues" array which is an array of arrays. The first item in each inner array is the id of the case. All the items following that are the attribute values of case attributes sorted by case attribute name.
; 'MaxTextLength'
: Used with Operation Log Analysis analysis type. Integer. The maximum number of characters to return from the 'Name', 'Session Id', 'User Name', 'Model Name', 'Message', and 'Additional Data' fields. If 0 (default), all characters are returned.
; 'MaximumCount'
: Used with Operation Log Analysis analysis type. Integer. The maximum amount of rows returned. Optional. Default value is 1000.
; 'ShowOpenOnly'
: Used with Operation Log Analysis analysis type. Boolean. When TRUE, the Operation Log Analysis returns only operations that don't have end time. Optional. Default value is FALSE.

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

= --#ImportCaseAttributes =
Loads Case Attributes from the data which the preceding SQL statements given as parameters provide into the specified model. This command takes two SELECT queries as parameters. Models with external data source ([[QPR_ProcessAnalyzer_Model_JSON_Settings#Loading_Data_from_ODBC_Datasources|ODBC_Datasource]]) not support this command.

== 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 an existing target model case attributes. TRUE or any other Integer than "0" = the existing case attributes in the target model are not deleted before import, FALSE or "0" = the existing case attributes of the target model are deleted before the import. If the target model is set to use another model as the Case Attribute Model, those case attributes are not deleted. Not used when creating a new model. Default value is TRUE.
; 'CatchOperationExceptions'
: Optional. Defines whether to stop the script execution or to continue to run the script from the next statement if an exception occurs when running the script:
: 1 = don't stop execution of the script, continue running the script from the next statement.
: 0 = stop execution of the current script and show the exception.
: The following script variables will be set and are shown in the script log:
: <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.

See examples at the [[ImportCaseAttributes Script Examples]] page.

= --#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.
; 'DataTableId' or 'DataTableName'
: The id or the name of the existing/new target data table.
; 'Append'
: Defines what to do with an existing target data table contents. TRUE or any other Integer than "0" = the existing contents in the target data table are not deleted before import, FALSE or "0" = the existing contents of the target data table are deleted before the import. Not used when creating a new data table.
; 'CatchOperationExceptions'
: Optional. Defines whether to stop the script execution or to continue to run the script from the next statement if an exception occurs when running the script:
: 1 = don't stop execution of the script, continue running the script from the next statement.
: 0 = stop execution of the current script and show the exception.
: The following script variables will be set and are shown in the script log:
:<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 if the query doesn't return any data, the data table is not created.

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

= --#ImportEvents =
Loads Events from the data which the preceding SQL statements given as parameters provide into the specified model. This command takes two SELECT queries as parameters. Models with external data source ([[QPR_ProcessAnalyzer_Model_JSON_Settings#Loading_Data_from_ODBC_Datasources|ODBC_Datasource]]) not support this command.
== 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 ==
; <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 ImportEvents command.

See examples at the [[ImportEvents Script Examples]] page.

= --#ImportEventsIncremental =
Models with external data source ([[QPR_ProcessAnalyzer_Model_JSON_Settings#Loading_Data_from_ODBC_Datasources|ODBC_Datasource]]) not support this command.
Synchronizes a model with event data in the specified event data table. May delete and/or add new events into the model. Events are matched between the model and the event data table as follows:

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

See examples in the [[ImportEventsIncremental Script Examples]] page.

= --#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.
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.
; 'DataTableId' or 'DataTableName'
: The id or the name of the existing/new target data table.
; 'Append'
: Defines what to do with an existing target data table 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:
:<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.

'''ODBC specific parameters'''
; 'OdbcConnectionString'
: 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]].
; '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.
; '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.

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

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

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.
; 'DataTableId' or 'DataTableName'
: The id or the name of the existing/new target data table.
; 'Append'
: Defines what to do with an existing target data table 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:
:<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.
'''OLE DB Query Parameters'''
; '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.
; '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.
; '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.

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

= --#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. 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/>
; '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.
; 'DataTableId' or 'DataTableName'
: The id or the name of the existing/new target data table.
; 'Append'
: Defines what to do with an existing target data table contents. TRUE or any other Integer than "0" = the existing contents in the target data table are not deleted before import, FALSE or "0" = the existing contents of the target data table are deleted before the import. Not used when creating a new data table.
; 'CatchOperationExceptions'
: Optional. Defines whether to stop the script execution or to continue to run the script from the next statement if an exception occurs when running the script:
: 1 = don't stop execution of the script, continue running the script from the next statement.
: 0 = stop execution of the current script and show the exception.
: The following script variables will be set and are shown in the script log:
:<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.
'''Salesforce Query Parameters'''
; 'SalesforceUser'
: Username for the Salesforce cloud.
; 'SalesforcePW'
: Password for the Salesforce cloud.
; 'SalesforceUrl'
: 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>.
; 'SalesforceQueryMode'
: 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()].
; 'SalesforceQuery'
: 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.
; '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. 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.

== Notes ==
If you get error in --#ImportSalesforceQuery PA Operation saying "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 lisence 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 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 Excel Client#Installing_SAP_Connector_for_Microsoft_.NET_Version_3.0_Dll_Files|some dlls]] not provided by QPR Software.

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'
: If this parameter is given, store the results into a temporary SQL table in ETL sandbox.
If the TargetTable parameter is not given, use the following destination parameters:
; 'ProjectId' or 'ProjectName'
: The id or the name of the project in which the target data table exists.
; 'DataTableId' or 'DataTableName'
: The id or the name of the existing/new target data table.
; 'Append'
: Defines what to do with an existing target data table 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:
:<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.

'''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.
; '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.
; '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.
; '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.
; '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.
; '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.
; '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.
; '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.

'''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.
; '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.
; 'SapPeakConnectionsLimit'
: 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'
: 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'
: 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.
; '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.
; '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.
; '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.
; '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.
; '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.
; '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.
; '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 [[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'
: 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'
: 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.

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

= --#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.
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.
; 'DataTableId' or 'DataTableName'
: The id or the name of the existing/new target data table.
; 'Append'
: Defines what to do with an existing target data table 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:
:<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.
'''SQL Query Parameters'''
; '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.
; '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.
; '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.

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

= --#RemoveCases =
Removes all or specified cases in the target model. This command takes two SELECT queries as parameters.
== First Query ==
Configures the command using a SELECT statement returning two columns: the first column is for a key and the second one is for a value of that key. The values in both the key column and in the value column are of type NVARCHAR. The supported keys for this command are:<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.

See examples at the [[RemoveCases Script Examples]] page.

= --#RemoveEvents =
Removes all or specified events in the target model, but retains Cases, Event Types, and Variations. This command takes two SELECT queries as parameters.
== First Query ==
Configures the command using a SELECT statement returning two columns: the first column is for a key and the second one is for a value of that key. The values in both the key column and in the value column are of type NVARCHAR. The supported keys for this command are:<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 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.

See examples at the [[RemoveEvents Script Examples]] page.

= --#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 ==
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.
The possible arguments are as follows:
:* @_Argv - type INT: the number of provided parameters (from 0 to 10)
:* #_Arg1, ... #_Arg10: arguments passed to that script

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

See examples at the [[Run Script Examples]] page.

= --#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:<br/>
; '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.
'''E-mail Parameters'''
; 'EmailFrom'
: Defines the from address for this e-mail message. Mandatory.
; 'EmailTo'
: Defines the recipient(s) for this e-mail message given in a list separated by comma. Mandatory.
; 'EmailSubject'
: Defines the subject of the email. Default value is empty. Optional.
; 'EmailBody'
: Defines the message body. Default value is empty. Optional.
; 'EmailCc'
: Defines the carbon copy recipient(s) for this e-mail message given in a list separated by comma. Optional.
; 'EmailBcc'
: Defines the blind carbon copy recipient(s) for this e-mail message given in a list separated by comma. Optional.
; 'EmailIsBodyHtml'
: Defines whether the e-mail message body is in HTML. TRUE or any other Integer than "0" = body is in HTML, FALSE or "0" = body is not in HTML. Default value is FALSE. Optional.
; 'EmailSender'
: Defines the sender's address for this e-mail message. Default value is empty. Optional.
; 'EmailReplyTo'
: Defines the ReplyTo address(es) for the mail message given in a list separated by comma. Optional.
; 'EmailPriority',
: Defines the priority of this e-mail message. Possible values are "High", "Normal", and "Low". Default value is "Normal". Optional.
; 'EmailDeliveryNotification'
: Defines the delivery notifications for this e-mail message. Possible values are "Delay", "Never", "None", "OnFailure", and "OnSuccess". Default value is "None". Optional.
; 'EmailBodyEncoding'
: Defines the encoding used to encode the message body. Supported encodings are listed in the "Remarks" section at http://msdn.microsoft.com/en-us/library/System.Text.Encoding.aspx. Optional.
; 'EmailSubjectEncoding'
: Defines the encoding used for the subject content for this e-mail message. Supported encodings are listed in the "Remarks" section at http://msdn.microsoft.com/en-us/library/System.Text.Encoding.aspx. Optional.
; '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.

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

= --#ShowReport =
Creates a new Excel sheet containing a table that contains the results of the user specified SQL query. The result column names are the field names of the SQL query and the rows are the actual data rows of the SQL query. The report can be used to see, for example, the events that would be loaded into QPR ProcessAnalyzer before actually loading them. If the events have problems that cause errors when loaded it is useful to be able to see the row data in a report.
'''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 ==
A user specified SQL query to be shown in the configured Excel sheet.
; <nowiki>'<data>'</nowiki>
: 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:<br/>
; '<Analysis Parameter>'
: Optional. The [[QPR ProcessAnalyzer Analysis Parameters]] given for the operation. Some suggested parameters to be used:
:; 'Title'
:: The title of the created report. If not given, "Report" will be used as a default.
:; 'SheetName'
:: The name of the Excel sheet to be created.
:; 'MaximumCount'
:: The maximum number of rows to show (0 = all, default = 1000).

; 'PivotSheetName'
: Optional. The name of the Excel sheet to be created. The sheet will contain a pivot table that includes all columns and rows in the report. The pivot sheet doesn't support drill-down. The pivot sheet has the following additional parameters:
:; 'PivotFilters'
::A comma separated list of result sheet column names that should be used in pivot table filters dimension.
:; 'PivotRows'
:: A comma separated list of row names to be used in the pivot table rows dimension. To sort the results, add the following parameters separated by commas "(SortDirection=<Ascending or Descending>)" and/or "(SortBy=<Sort Field Name>)" to the row name. For example: "Region(SortDirection=Ascending, SortBy="Average of DurationDays"), Country(SortBy="Sum of Cost")"
:; 'PivotColumns'
:: A comma separated list of column names to be used in the pivot table columns dimension. To sort the results, add the following parameters separated by commas "(SortDirection=<Ascending or Descending>)" and/or "(SortBy=<Sort Field Name>)" to the column name. For example: "Region(SortDirection=Ascending, SortBy="Average of DurationDays"), Country(SortBy="Sum of Cost")"
:; 'PivotValues'
:: A comma separated list of column names to be used as the pivot table values. The summarize value field can be defined by adding a summarize value parameter to the end of each value name as follows: "(SummarizeBy=<Summarize value tag)". If the parameter is not defined, the Excel default value for summarize is used: "Sum" for numbers and "Count" for other types. The supported summarize value tags are: Sum, Count, Average, Max, Min, Product, CountNumbers, StdDev, StdDevp, Var, Varp. For example: "Duration Days(SummarizeBy="Average"),Cost(SummarizeBy="Sum")"
:; 'PivotTitle'
:: The title of the pivot sheet to be created. If undefined, the name defined in PivotSheetName will 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:
:<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.

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

= --#StartBackground =
Makes the script run in background starting from this command, so that using QPR ProcessAnalyzer Excel client is possible while the script is running. 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 [[QPR_ProcessAnalyzer_Logs#Script_Log|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. 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.

This command is supported only for QPR ProcessAnalyzer Service based data source connections (i.e. not supported for Xpress or Database activations). 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 [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.

SQL Scripting Commands

2019-07-23T06:44:52Z

VesKivi: /* --#ImportEvents */

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.

= --#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 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 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.
; '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.
: 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.
: In QPR ProcessAnalyzer Xpress or QPR ProcessAnalyzer Database, it is always possible to use network credentials.
; '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.
;<nowiki><other parameters></nowiki>
: All the rest of the passed parameters not listed above are added as extra headers to the request. Optional.

== Result ==
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>@_ResponseStatusCode</code> The numeric status code received from the remote server. INT.
: <code>@_ResponseSuccess</code> True only if the request returned status code that represents a success. BIT.

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

= --#CreateFilter =
Creates a new filter with the specified parameters. Returns the id of the newly created filter in SQL dynamic variable @_CreatedFilterId.

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'
: Id of the filter/view for which the new filter is applied. Mandatory.
; 'FilterType'
: Type of the additional filter to apply. Supported values are:
:: 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.

See examples at the [[CreateFilter Script Examples]] page.

= --#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:<br/>
; '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:
: <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.

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

= --#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. 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:<br/>
; '<Analysis Parameter>'
: See [[QPR ProcessAnalyzer Analysis Parameters]] for a list of supported analysis parameters in QPR ProcessAnalyzer.
: The --#GetAnalysis command supports the following analysis types:
0.'''Flowchart Analysis'''

Draws the flowchart of model defined in parameter

1.'''Variation Analysis in the Chart Mode'''

Opens Variation analysis of the model defined

3.'''Path Analysis'''

Opens Path analysis of model defined

4.'''Event Type Analysis in the Chart Mode'''

Opens Event Type analysis of model defined

5.'''Case Analysis'''
Prints the detailed list of cases and attributes of defined model

6.'''Event Analysis'''

Prints the detailed list of Events from defined model

7.'''Event Type Analysis in the Table Mode'''

Opens Event Type analysis of model defined

8.'''Variation Analysis in the Table Mode'''

Opens Variation analysis of the model defined

9.'''Duration Analysis'''

Opens Duration analysis of the model defined

10.'''Profiling Analysis'''

Opens Profiling analysis of the model defined

11.'''User Report'''

Opens a detailed list of users in server

12.'''Operation Log Analysis'''

Opens the operation log of ProcessAnalyzer

13.'''Flow Analysis'''

Opens Flow analysis of the model defined

14.'''Influence Analysis'''

Open Influence analysis of model defined, with defined parameters

18.'''Data Table Analysis'''

Reads a data table from SQL server and stores it in temporary table

21.'''Model Report'''

Opens a detailed list of models in server

22.'''Project Report'''

Opens a detailed list of projects in server

23.'''Data Table Report'''

Opens a detailed list of data tables in server

24.'''Script Report'''

Opens a detailed list of scripts in server

25.'''RunScript'''

Starts a script (used in UI)

26.'''Event Type Analysis in the Trends Mode'''

Opens Event Type analysis of model defined

28.'''Profiling Analysis in the Trends Mode'''

Opens Profiling analysis of the model defined

29.'''Profiling Analysis in the Trends Mode'''

Opens duration influence analysis of model defined

30.'''Filter Report'''

Opens a detailed list of filters in a model defined

31.'''Filter Rule Report'''
Contains information about the filter rule in filter defined

32.'''Script Log Report'''

33.'''[[QPR_ProcessAnalyzer_Expression_Analysis|Expression Analysis]]'''

: 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 [[QPR ProcessAnalyzer 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.
; '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.
; 'Title'
: Optional. The title for the Excel sheet created when Show is TRUE or 1. Default value is the name of the analysis type.
; 'SheetName'
: Optional. The name of the Excel sheet created when Show is TRUE or 1. Default value is the name of the analysis type.

; 'PivotSheetName'
: Optional. The name of the Excel sheet to be created. The sheet will contain a pivot table that includes all columns and rows in the report. The pivot sheet doesn't support drill-down. The pivot sheet has the following additional parameters:
:; 'PivotFilters'
::A comma separated list of result sheet column names that should be used in pivot table filters dimension.
:; 'PivotRows'
:: A comma separated list of row names to be used in the pivot table rows dimension. To sort the results, add the following parameters separated by commas "(SortDirection=<Ascending or Descending>)" and/or "(SortBy=<Sort Field Name>)" to the row name. For example: "Region(SortDirection=Ascending, SortBy="Average of DurationDays"), Country(SortBy="Sum of Cost")"
:; 'PivotColumns'
:: A comma separated list of column names to be used in the pivot table columns dimension. To sort the results, add the following parameters separated by commas "(SortDirection=<Ascending or Descending>)" and/or "(SortBy=<Sort Field Name>)" to the column name. For example: "Region(SortDirection=Ascending, SortBy="Average of DurationDays"), Country(SortBy="Sum of Cost")"
:; 'PivotValues'
:: A comma separated list of column names to be used as the pivot table values. The summarize value field can be defined by adding a summarize value parameter to the end of each value name as follows: "(SummarizeBy=<Summarize value tag)". If the parameter is not defined, the Excel default value for summarize is used: "Sum" for numbers and "Count" for other types. The supported summarize value tags are: Sum, Count, Average, Max, Min, Product, CountNumbers, StdDev, StdDevp, Var, Varp. For example: "Duration Days(SummarizeBy="Average"),Cost(SummarizeBy="Sum")"
:; 'PivotTitle'
:: The title of the pivot sheet to be created. If undefined, the name defined in PivotSheetName will 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:
:<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.
; 'ScriptId'
: Mandatory with the RunScript analysis type. Defines the script that should be run.
; '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 the Script Log Report and Operation Log Analysis analysis types. A date time parameter which specifies the earliest start time in the log entries. Format is ISO8601: yyyy-mm-ddThh:mm:ss.fff. The maximum year is 2030 and the minimum year is 1970. 'fff' stands for fractions of seconds and it is given in 3ms accuracy and the last digit must be 0, 3 or 7.
:* For Script Log Report analysis type: Mandatory if ScriptIds parameter is not defined.
:* For Operation Log Analysis analysis type: Optional. Default value is no earliest start time limit.
; 'MaxStartTime'
: Used with Script Log Report and Operation Log Analysis analysis types. A date time parameter which specifies the latest start time in the log entries. Format is ISO8601: yyyy-mm-ddThh:mm:ss.fff. The maximum year is 2030 and the minimum year is 1970. 'fff' stands for fractions of seconds and it is given in 3ms accuracy and the last digit must be 0, 3 or 7. Optional. Default value is no latest start time limit.
; 'IncludeCaseVariationRelations'
: Used with Event Analysis analysis type. Boolean value (default value = FALSE). If set to TRUE, the result of the event analysis will include a "CaseIdToVariationIdMap" property which is an array. Every item in the array describes the mapping between a case and a variation by ids formatted as simple array of length 2 (first item being case id, the second being variation id of that case).
; 'IncludeEventTypeNames'
: Used with Event Analysis analysis type. Boolean value (default value = FALSE). If set to TRUE, the result of the event analysis will include an "EventTypeNames" property which is an array of objects. Every item in the array maps event type id ("Key" property) into the name of that event type ("Value" property).
; 'UseMillisecondsSince1970DateTimeFormatting'
: Used with Event Analysis analysis type. Boolean value (default value = FALSE). If set to TRUE, the start time of every event is actually an integer number of milliseconds after 1.1.1970.
; 'UseIdsInsteadOfNames'
: Used with Event Analysis analysis type. Boolean value (default = FALSE). If set to TRUE, instead of returning case and event type names, the event analysis returns case and event type identifiers.
; 'IncludeCaseAttributeValues'
: Used with Event Analysis analysis type. Boolean value (default = FALSE). If set to TRUE, the result of the event analysis will include a "CaseAttributeValues" array which is an array of arrays. The first item in each inner array is the id of the case. All the items following that are the attribute values of case attributes sorted by case attribute name.
; 'MaxTextLength'
: Used with Operation Log Analysis analysis type. Integer. The maximum number of characters to return from the 'Name', 'Session Id', 'User Name', 'Model Name', 'Message', and 'Additional Data' fields. If 0 (default), all characters are returned.
; 'MaximumCount'
: Used with Operation Log Analysis analysis type. Integer. The maximum amount of rows returned. Optional. Default value is 1000.
; 'ShowOpenOnly'
: Used with Operation Log Analysis analysis type. Boolean. When TRUE, the Operation Log Analysis returns only operations that don't have end time. Optional. Default value is FALSE.

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

= --#ImportCaseAttributes =
Loads Case Attributes from the data which the preceding SQL statements given as parameters provide into the specified model. This command takes two SELECT queries as parameters. Models with external data source ([[QPR_ProcessAnalyzer_Model_JSON_Settings#Loading_Data_from_ODBC_Datasources|ODBC_Datasource]]) not support this command.

== 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 an existing target model case attributes. TRUE or any other Integer than "0" = the existing case attributes in the target model are not deleted before import, FALSE or "0" = the existing case attributes of the target model are deleted before the import. If the target model is set to use another model as the Case Attribute Model, those case attributes are not deleted. Not used when creating a new model. Default value is TRUE.
; 'CatchOperationExceptions'
: Optional. Defines whether to stop the script execution or to continue to run the script from the next statement if an exception occurs when running the script:
: 1 = don't stop execution of the script, continue running the script from the next statement.
: 0 = stop execution of the current script and show the exception.
: The following script variables will be set and are shown in the script log:
: <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.

See examples at the [[ImportCaseAttributes Script Examples]] page.

= --#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.
; 'DataTableId' or 'DataTableName'
: The id or the name of the existing/new target data table.
; 'Append'
: Defines what to do with an existing target data table contents. TRUE or any other Integer than "0" = the existing contents in the target data table are not deleted before import, FALSE or "0" = the existing contents of the target data table are deleted before the import. Not used when creating a new data table.
; 'CatchOperationExceptions'
: Optional. Defines whether to stop the script execution or to continue to run the script from the next statement if an exception occurs when running the script:
: 1 = don't stop execution of the script, continue running the script from the next statement.
: 0 = stop execution of the current script and show the exception.
: The following script variables will be set and are shown in the script log:
:<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 if the query doesn't return any data, the data table is not created.

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

= --#ImportEvents =
Loads Events from the data which the preceding SQL statements given as parameters provide into the specified model. This command takes two SELECT queries as parameters. Models with external data source ([[QPR_ProcessAnalyzer_Model_JSON_Settings#Loading_Data_from_ODBC_Datasources|ODBC_Datasource]]) not support this command.
== 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 ==
; <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 ImportEvents command.

See examples at the [[ImportEvents Script Examples]] page.

= --#ImportEventsIncremental =
Synchronizes a model with event data in the specified event data table. May delete and/or add new events into the model. Events are matched between the model and the event data table as follows:

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

See examples in the [[ImportEventsIncremental Script Examples]] page.

= --#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.
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.
; 'DataTableId' or 'DataTableName'
: The id or the name of the existing/new target data table.
; 'Append'
: Defines what to do with an existing target data table 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:
:<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.

'''ODBC specific parameters'''
; 'OdbcConnectionString'
: 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]].
; '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.
; '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.

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

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

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.
; 'DataTableId' or 'DataTableName'
: The id or the name of the existing/new target data table.
; 'Append'
: Defines what to do with an existing target data table 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:
:<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.
'''OLE DB Query Parameters'''
; '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.
; '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.
; '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.

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

= --#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. 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/>
; '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.
; 'DataTableId' or 'DataTableName'
: The id or the name of the existing/new target data table.
; 'Append'
: Defines what to do with an existing target data table contents. TRUE or any other Integer than "0" = the existing contents in the target data table are not deleted before import, FALSE or "0" = the existing contents of the target data table are deleted before the import. Not used when creating a new data table.
; 'CatchOperationExceptions'
: Optional. Defines whether to stop the script execution or to continue to run the script from the next statement if an exception occurs when running the script:
: 1 = don't stop execution of the script, continue running the script from the next statement.
: 0 = stop execution of the current script and show the exception.
: The following script variables will be set and are shown in the script log:
:<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.
'''Salesforce Query Parameters'''
; 'SalesforceUser'
: Username for the Salesforce cloud.
; 'SalesforcePW'
: Password for the Salesforce cloud.
; 'SalesforceUrl'
: 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>.
; 'SalesforceQueryMode'
: 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()].
; 'SalesforceQuery'
: 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.
; '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. 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.

== Notes ==
If you get error in --#ImportSalesforceQuery PA Operation saying "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 lisence 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 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 Excel Client#Installing_SAP_Connector_for_Microsoft_.NET_Version_3.0_Dll_Files|some dlls]] not provided by QPR Software.

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'
: If this parameter is given, store the results into a temporary SQL table in ETL sandbox.
If the TargetTable parameter is not given, use the following destination parameters:
; 'ProjectId' or 'ProjectName'
: The id or the name of the project in which the target data table exists.
; 'DataTableId' or 'DataTableName'
: The id or the name of the existing/new target data table.
; 'Append'
: Defines what to do with an existing target data table 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:
:<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.

'''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.
; '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.
; '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.
; '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.
; '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.
; '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.
; '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.
; '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.

'''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.
; '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.
; 'SapPeakConnectionsLimit'
: 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'
: 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'
: 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.
; '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.
; '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.
; '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.
; '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.
; '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.
; '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.
; '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 [[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'
: 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'
: 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.

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

= --#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.
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.
; 'DataTableId' or 'DataTableName'
: The id or the name of the existing/new target data table.
; 'Append'
: Defines what to do with an existing target data table 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:
:<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.
'''SQL Query Parameters'''
; '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.
; '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.
; '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.

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

= --#RemoveCases =
Removes all or specified cases in the target model. This command takes two SELECT queries as parameters.
== First Query ==
Configures the command using a SELECT statement returning two columns: the first column is for a key and the second one is for a value of that key. The values in both the key column and in the value column are of type NVARCHAR. The supported keys for this command are:<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.

See examples at the [[RemoveCases Script Examples]] page.

= --#RemoveEvents =
Removes all or specified events in the target model, but retains Cases, Event Types, and Variations. This command takes two SELECT queries as parameters.
== First Query ==
Configures the command using a SELECT statement returning two columns: the first column is for a key and the second one is for a value of that key. The values in both the key column and in the value column are of type NVARCHAR. The supported keys for this command are:<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 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.

See examples at the [[RemoveEvents Script Examples]] page.

= --#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 ==
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.
The possible arguments are as follows:
:* @_Argv - type INT: the number of provided parameters (from 0 to 10)
:* #_Arg1, ... #_Arg10: arguments passed to that script

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

See examples at the [[Run Script Examples]] page.

= --#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:<br/>
; '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.
'''E-mail Parameters'''
; 'EmailFrom'
: Defines the from address for this e-mail message. Mandatory.
; 'EmailTo'
: Defines the recipient(s) for this e-mail message given in a list separated by comma. Mandatory.
; 'EmailSubject'
: Defines the subject of the email. Default value is empty. Optional.
; 'EmailBody'
: Defines the message body. Default value is empty. Optional.
; 'EmailCc'
: Defines the carbon copy recipient(s) for this e-mail message given in a list separated by comma. Optional.
; 'EmailBcc'
: Defines the blind carbon copy recipient(s) for this e-mail message given in a list separated by comma. Optional.
; 'EmailIsBodyHtml'
: Defines whether the e-mail message body is in HTML. TRUE or any other Integer than "0" = body is in HTML, FALSE or "0" = body is not in HTML. Default value is FALSE. Optional.
; 'EmailSender'
: Defines the sender's address for this e-mail message. Default value is empty. Optional.
; 'EmailReplyTo'
: Defines the ReplyTo address(es) for the mail message given in a list separated by comma. Optional.
; 'EmailPriority',
: Defines the priority of this e-mail message. Possible values are "High", "Normal", and "Low". Default value is "Normal". Optional.
; 'EmailDeliveryNotification'
: Defines the delivery notifications for this e-mail message. Possible values are "Delay", "Never", "None", "OnFailure", and "OnSuccess". Default value is "None". Optional.
; 'EmailBodyEncoding'
: Defines the encoding used to encode the message body. Supported encodings are listed in the "Remarks" section at http://msdn.microsoft.com/en-us/library/System.Text.Encoding.aspx. Optional.
; 'EmailSubjectEncoding'
: Defines the encoding used for the subject content for this e-mail message. Supported encodings are listed in the "Remarks" section at http://msdn.microsoft.com/en-us/library/System.Text.Encoding.aspx. Optional.
; '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.

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

= --#ShowReport =
Creates a new Excel sheet containing a table that contains the results of the user specified SQL query. The result column names are the field names of the SQL query and the rows are the actual data rows of the SQL query. The report can be used to see, for example, the events that would be loaded into QPR ProcessAnalyzer before actually loading them. If the events have problems that cause errors when loaded it is useful to be able to see the row data in a report.
'''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 ==
A user specified SQL query to be shown in the configured Excel sheet.
; <nowiki>'<data>'</nowiki>
: 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:<br/>
; '<Analysis Parameter>'
: Optional. The [[QPR ProcessAnalyzer Analysis Parameters]] given for the operation. Some suggested parameters to be used:
:; 'Title'
:: The title of the created report. If not given, "Report" will be used as a default.
:; 'SheetName'
:: The name of the Excel sheet to be created.
:; 'MaximumCount'
:: The maximum number of rows to show (0 = all, default = 1000).

; 'PivotSheetName'
: Optional. The name of the Excel sheet to be created. The sheet will contain a pivot table that includes all columns and rows in the report. The pivot sheet doesn't support drill-down. The pivot sheet has the following additional parameters:
:; 'PivotFilters'
::A comma separated list of result sheet column names that should be used in pivot table filters dimension.
:; 'PivotRows'
:: A comma separated list of row names to be used in the pivot table rows dimension. To sort the results, add the following parameters separated by commas "(SortDirection=<Ascending or Descending>)" and/or "(SortBy=<Sort Field Name>)" to the row name. For example: "Region(SortDirection=Ascending, SortBy="Average of DurationDays"), Country(SortBy="Sum of Cost")"
:; 'PivotColumns'
:: A comma separated list of column names to be used in the pivot table columns dimension. To sort the results, add the following parameters separated by commas "(SortDirection=<Ascending or Descending>)" and/or "(SortBy=<Sort Field Name>)" to the column name. For example: "Region(SortDirection=Ascending, SortBy="Average of DurationDays"), Country(SortBy="Sum of Cost")"
:; 'PivotValues'
:: A comma separated list of column names to be used as the pivot table values. The summarize value field can be defined by adding a summarize value parameter to the end of each value name as follows: "(SummarizeBy=<Summarize value tag)". If the parameter is not defined, the Excel default value for summarize is used: "Sum" for numbers and "Count" for other types. The supported summarize value tags are: Sum, Count, Average, Max, Min, Product, CountNumbers, StdDev, StdDevp, Var, Varp. For example: "Duration Days(SummarizeBy="Average"),Cost(SummarizeBy="Sum")"
:; 'PivotTitle'
:: The title of the pivot sheet to be created. If undefined, the name defined in PivotSheetName will 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:
:<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.

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

= --#StartBackground =
Makes the script run in background starting from this command, so that using QPR ProcessAnalyzer Excel client is possible while the script is running. 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 [[QPR_ProcessAnalyzer_Logs#Script_Log|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. 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.

This command is supported only for QPR ProcessAnalyzer Service based data source connections (i.e. not supported for Xpress or Database activations). 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 [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.

SQL Scripting Commands

2019-07-23T06:44:35Z

VesKivi: /* --#ImportCaseAttributes */

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.

= --#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 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 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.
; '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.
: 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.
: In QPR ProcessAnalyzer Xpress or QPR ProcessAnalyzer Database, it is always possible to use network credentials.
; '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.
;<nowiki><other parameters></nowiki>
: All the rest of the passed parameters not listed above are added as extra headers to the request. Optional.

== Result ==
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>@_ResponseStatusCode</code> The numeric status code received from the remote server. INT.
: <code>@_ResponseSuccess</code> True only if the request returned status code that represents a success. BIT.

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

= --#CreateFilter =
Creates a new filter with the specified parameters. Returns the id of the newly created filter in SQL dynamic variable @_CreatedFilterId.

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'
: Id of the filter/view for which the new filter is applied. Mandatory.
; 'FilterType'
: Type of the additional filter to apply. Supported values are:
:: 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.

See examples at the [[CreateFilter Script Examples]] page.

= --#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:<br/>
; '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:
: <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.

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

= --#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. 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:<br/>
; '<Analysis Parameter>'
: See [[QPR ProcessAnalyzer Analysis Parameters]] for a list of supported analysis parameters in QPR ProcessAnalyzer.
: The --#GetAnalysis command supports the following analysis types:
0.'''Flowchart Analysis'''

Draws the flowchart of model defined in parameter

1.'''Variation Analysis in the Chart Mode'''

Opens Variation analysis of the model defined

3.'''Path Analysis'''

Opens Path analysis of model defined

4.'''Event Type Analysis in the Chart Mode'''

Opens Event Type analysis of model defined

5.'''Case Analysis'''
Prints the detailed list of cases and attributes of defined model

6.'''Event Analysis'''

Prints the detailed list of Events from defined model

7.'''Event Type Analysis in the Table Mode'''

Opens Event Type analysis of model defined

8.'''Variation Analysis in the Table Mode'''

Opens Variation analysis of the model defined

9.'''Duration Analysis'''

Opens Duration analysis of the model defined

10.'''Profiling Analysis'''

Opens Profiling analysis of the model defined

11.'''User Report'''

Opens a detailed list of users in server

12.'''Operation Log Analysis'''

Opens the operation log of ProcessAnalyzer

13.'''Flow Analysis'''

Opens Flow analysis of the model defined

14.'''Influence Analysis'''

Open Influence analysis of model defined, with defined parameters

18.'''Data Table Analysis'''

Reads a data table from SQL server and stores it in temporary table

21.'''Model Report'''

Opens a detailed list of models in server

22.'''Project Report'''

Opens a detailed list of projects in server

23.'''Data Table Report'''

Opens a detailed list of data tables in server

24.'''Script Report'''

Opens a detailed list of scripts in server

25.'''RunScript'''

Starts a script (used in UI)

26.'''Event Type Analysis in the Trends Mode'''

Opens Event Type analysis of model defined

28.'''Profiling Analysis in the Trends Mode'''

Opens Profiling analysis of the model defined

29.'''Profiling Analysis in the Trends Mode'''

Opens duration influence analysis of model defined

30.'''Filter Report'''

Opens a detailed list of filters in a model defined

31.'''Filter Rule Report'''
Contains information about the filter rule in filter defined

32.'''Script Log Report'''

33.'''[[QPR_ProcessAnalyzer_Expression_Analysis|Expression Analysis]]'''

: 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 [[QPR ProcessAnalyzer 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.
; '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.
; 'Title'
: Optional. The title for the Excel sheet created when Show is TRUE or 1. Default value is the name of the analysis type.
; 'SheetName'
: Optional. The name of the Excel sheet created when Show is TRUE or 1. Default value is the name of the analysis type.

; 'PivotSheetName'
: Optional. The name of the Excel sheet to be created. The sheet will contain a pivot table that includes all columns and rows in the report. The pivot sheet doesn't support drill-down. The pivot sheet has the following additional parameters:
:; 'PivotFilters'
::A comma separated list of result sheet column names that should be used in pivot table filters dimension.
:; 'PivotRows'
:: A comma separated list of row names to be used in the pivot table rows dimension. To sort the results, add the following parameters separated by commas "(SortDirection=<Ascending or Descending>)" and/or "(SortBy=<Sort Field Name>)" to the row name. For example: "Region(SortDirection=Ascending, SortBy="Average of DurationDays"), Country(SortBy="Sum of Cost")"
:; 'PivotColumns'
:: A comma separated list of column names to be used in the pivot table columns dimension. To sort the results, add the following parameters separated by commas "(SortDirection=<Ascending or Descending>)" and/or "(SortBy=<Sort Field Name>)" to the column name. For example: "Region(SortDirection=Ascending, SortBy="Average of DurationDays"), Country(SortBy="Sum of Cost")"
:; 'PivotValues'
:: A comma separated list of column names to be used as the pivot table values. The summarize value field can be defined by adding a summarize value parameter to the end of each value name as follows: "(SummarizeBy=<Summarize value tag)". If the parameter is not defined, the Excel default value for summarize is used: "Sum" for numbers and "Count" for other types. The supported summarize value tags are: Sum, Count, Average, Max, Min, Product, CountNumbers, StdDev, StdDevp, Var, Varp. For example: "Duration Days(SummarizeBy="Average"),Cost(SummarizeBy="Sum")"
:; 'PivotTitle'
:: The title of the pivot sheet to be created. If undefined, the name defined in PivotSheetName will 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:
:<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.
; 'ScriptId'
: Mandatory with the RunScript analysis type. Defines the script that should be run.
; '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 the Script Log Report and Operation Log Analysis analysis types. A date time parameter which specifies the earliest start time in the log entries. Format is ISO8601: yyyy-mm-ddThh:mm:ss.fff. The maximum year is 2030 and the minimum year is 1970. 'fff' stands for fractions of seconds and it is given in 3ms accuracy and the last digit must be 0, 3 or 7.
:* For Script Log Report analysis type: Mandatory if ScriptIds parameter is not defined.
:* For Operation Log Analysis analysis type: Optional. Default value is no earliest start time limit.
; 'MaxStartTime'
: Used with Script Log Report and Operation Log Analysis analysis types. A date time parameter which specifies the latest start time in the log entries. Format is ISO8601: yyyy-mm-ddThh:mm:ss.fff. The maximum year is 2030 and the minimum year is 1970. 'fff' stands for fractions of seconds and it is given in 3ms accuracy and the last digit must be 0, 3 or 7. Optional. Default value is no latest start time limit.
; 'IncludeCaseVariationRelations'
: Used with Event Analysis analysis type. Boolean value (default value = FALSE). If set to TRUE, the result of the event analysis will include a "CaseIdToVariationIdMap" property which is an array. Every item in the array describes the mapping between a case and a variation by ids formatted as simple array of length 2 (first item being case id, the second being variation id of that case).
; 'IncludeEventTypeNames'
: Used with Event Analysis analysis type. Boolean value (default value = FALSE). If set to TRUE, the result of the event analysis will include an "EventTypeNames" property which is an array of objects. Every item in the array maps event type id ("Key" property) into the name of that event type ("Value" property).
; 'UseMillisecondsSince1970DateTimeFormatting'
: Used with Event Analysis analysis type. Boolean value (default value = FALSE). If set to TRUE, the start time of every event is actually an integer number of milliseconds after 1.1.1970.
; 'UseIdsInsteadOfNames'
: Used with Event Analysis analysis type. Boolean value (default = FALSE). If set to TRUE, instead of returning case and event type names, the event analysis returns case and event type identifiers.
; 'IncludeCaseAttributeValues'
: Used with Event Analysis analysis type. Boolean value (default = FALSE). If set to TRUE, the result of the event analysis will include a "CaseAttributeValues" array which is an array of arrays. The first item in each inner array is the id of the case. All the items following that are the attribute values of case attributes sorted by case attribute name.
; 'MaxTextLength'
: Used with Operation Log Analysis analysis type. Integer. The maximum number of characters to return from the 'Name', 'Session Id', 'User Name', 'Model Name', 'Message', and 'Additional Data' fields. If 0 (default), all characters are returned.
; 'MaximumCount'
: Used with Operation Log Analysis analysis type. Integer. The maximum amount of rows returned. Optional. Default value is 1000.
; 'ShowOpenOnly'
: Used with Operation Log Analysis analysis type. Boolean. When TRUE, the Operation Log Analysis returns only operations that don't have end time. Optional. Default value is FALSE.

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

= --#ImportCaseAttributes =
Loads Case Attributes from the data which the preceding SQL statements given as parameters provide into the specified model. This command takes two SELECT queries as parameters. Models with external data source ([[QPR_ProcessAnalyzer_Model_JSON_Settings#Loading_Data_from_ODBC_Datasources|ODBC_Datasource]]) not support this command.

== 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 an existing target model case attributes. TRUE or any other Integer than "0" = the existing case attributes in the target model are not deleted before import, FALSE or "0" = the existing case attributes of the target model are deleted before the import. If the target model is set to use another model as the Case Attribute Model, those case attributes are not deleted. Not used when creating a new model. Default value is TRUE.
; 'CatchOperationExceptions'
: Optional. Defines whether to stop the script execution or to continue to run the script from the next statement if an exception occurs when running the script:
: 1 = don't stop execution of the script, continue running the script from the next statement.
: 0 = stop execution of the current script and show the exception.
: The following script variables will be set and are shown in the script log:
: <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.

See examples at the [[ImportCaseAttributes Script Examples]] page.

= --#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.
; 'DataTableId' or 'DataTableName'
: The id or the name of the existing/new target data table.
; 'Append'
: Defines what to do with an existing target data table contents. TRUE or any other Integer than "0" = the existing contents in the target data table are not deleted before import, FALSE or "0" = the existing contents of the target data table are deleted before the import. Not used when creating a new data table.
; 'CatchOperationExceptions'
: Optional. Defines whether to stop the script execution or to continue to run the script from the next statement if an exception occurs when running the script:
: 1 = don't stop execution of the script, continue running the script from the next statement.
: 0 = stop execution of the current script and show the exception.
: The following script variables will be set and are shown in the script log:
:<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 if the query doesn't return any data, the data table is not created.

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

= --#ImportEvents =
Loads Events from the data which the preceding SQL statements given as parameters provide into the specified model. This command takes two SELECT queries as parameters.
== First Query ==
Configures the command using a SELECT statement returning two columns: the first column is for a key and the second one is for a value of that key. The values in both the key column and in the value column are of type NVARCHAR. The supported keys for this command are:<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 ==
; <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 ImportEvents command.

See examples at the [[ImportEvents Script Examples]] page.

= --#ImportEventsIncremental =
Synchronizes a model with event data in the specified event data table. May delete and/or add new events into the model. Events are matched between the model and the event data table as follows:

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

See examples in the [[ImportEventsIncremental Script Examples]] page.

= --#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.
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.
; 'DataTableId' or 'DataTableName'
: The id or the name of the existing/new target data table.
; 'Append'
: Defines what to do with an existing target data table 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:
:<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.

'''ODBC specific parameters'''
; 'OdbcConnectionString'
: 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]].
; '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.
; '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.

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

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

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.
; 'DataTableId' or 'DataTableName'
: The id or the name of the existing/new target data table.
; 'Append'
: Defines what to do with an existing target data table 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:
:<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.
'''OLE DB Query Parameters'''
; '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.
; '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.
; '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.

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

= --#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. 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/>
; '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.
; 'DataTableId' or 'DataTableName'
: The id or the name of the existing/new target data table.
; 'Append'
: Defines what to do with an existing target data table contents. TRUE or any other Integer than "0" = the existing contents in the target data table are not deleted before import, FALSE or "0" = the existing contents of the target data table are deleted before the import. Not used when creating a new data table.
; 'CatchOperationExceptions'
: Optional. Defines whether to stop the script execution or to continue to run the script from the next statement if an exception occurs when running the script:
: 1 = don't stop execution of the script, continue running the script from the next statement.
: 0 = stop execution of the current script and show the exception.
: The following script variables will be set and are shown in the script log:
:<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.
'''Salesforce Query Parameters'''
; 'SalesforceUser'
: Username for the Salesforce cloud.
; 'SalesforcePW'
: Password for the Salesforce cloud.
; 'SalesforceUrl'
: 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>.
; 'SalesforceQueryMode'
: 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()].
; 'SalesforceQuery'
: 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.
; '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. 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.

== Notes ==
If you get error in --#ImportSalesforceQuery PA Operation saying "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 lisence 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 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 Excel Client#Installing_SAP_Connector_for_Microsoft_.NET_Version_3.0_Dll_Files|some dlls]] not provided by QPR Software.

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'
: If this parameter is given, store the results into a temporary SQL table in ETL sandbox.
If the TargetTable parameter is not given, use the following destination parameters:
; 'ProjectId' or 'ProjectName'
: The id or the name of the project in which the target data table exists.
; 'DataTableId' or 'DataTableName'
: The id or the name of the existing/new target data table.
; 'Append'
: Defines what to do with an existing target data table 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:
:<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.

'''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.
; '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.
; '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.
; '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.
; '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.
; '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.
; '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.
; '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.

'''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.
; '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.
; 'SapPeakConnectionsLimit'
: 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'
: 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'
: 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.
; '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.
; '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.
; '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.
; '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.
; '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.
; '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.
; '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 [[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'
: 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'
: 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.

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

= --#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.
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.
; 'DataTableId' or 'DataTableName'
: The id or the name of the existing/new target data table.
; 'Append'
: Defines what to do with an existing target data table 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:
:<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.
'''SQL Query Parameters'''
; '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.
; '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.
; '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.

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

= --#RemoveCases =
Removes all or specified cases in the target model. This command takes two SELECT queries as parameters.
== First Query ==
Configures the command using a SELECT statement returning two columns: the first column is for a key and the second one is for a value of that key. The values in both the key column and in the value column are of type NVARCHAR. The supported keys for this command are:<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.

See examples at the [[RemoveCases Script Examples]] page.

= --#RemoveEvents =
Removes all or specified events in the target model, but retains Cases, Event Types, and Variations. This command takes two SELECT queries as parameters.
== First Query ==
Configures the command using a SELECT statement returning two columns: the first column is for a key and the second one is for a value of that key. The values in both the key column and in the value column are of type NVARCHAR. The supported keys for this command are:<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 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.

See examples at the [[RemoveEvents Script Examples]] page.

= --#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 ==
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.
The possible arguments are as follows:
:* @_Argv - type INT: the number of provided parameters (from 0 to 10)
:* #_Arg1, ... #_Arg10: arguments passed to that script

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

See examples at the [[Run Script Examples]] page.

= --#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:<br/>
; '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.
'''E-mail Parameters'''
; 'EmailFrom'
: Defines the from address for this e-mail message. Mandatory.
; 'EmailTo'
: Defines the recipient(s) for this e-mail message given in a list separated by comma. Mandatory.
; 'EmailSubject'
: Defines the subject of the email. Default value is empty. Optional.
; 'EmailBody'
: Defines the message body. Default value is empty. Optional.
; 'EmailCc'
: Defines the carbon copy recipient(s) for this e-mail message given in a list separated by comma. Optional.
; 'EmailBcc'
: Defines the blind carbon copy recipient(s) for this e-mail message given in a list separated by comma. Optional.
; 'EmailIsBodyHtml'
: Defines whether the e-mail message body is in HTML. TRUE or any other Integer than "0" = body is in HTML, FALSE or "0" = body is not in HTML. Default value is FALSE. Optional.
; 'EmailSender'
: Defines the sender's address for this e-mail message. Default value is empty. Optional.
; 'EmailReplyTo'
: Defines the ReplyTo address(es) for the mail message given in a list separated by comma. Optional.
; 'EmailPriority',
: Defines the priority of this e-mail message. Possible values are "High", "Normal", and "Low". Default value is "Normal". Optional.
; 'EmailDeliveryNotification'
: Defines the delivery notifications for this e-mail message. Possible values are "Delay", "Never", "None", "OnFailure", and "OnSuccess". Default value is "None". Optional.
; 'EmailBodyEncoding'
: Defines the encoding used to encode the message body. Supported encodings are listed in the "Remarks" section at http://msdn.microsoft.com/en-us/library/System.Text.Encoding.aspx. Optional.
; 'EmailSubjectEncoding'
: Defines the encoding used for the subject content for this e-mail message. Supported encodings are listed in the "Remarks" section at http://msdn.microsoft.com/en-us/library/System.Text.Encoding.aspx. Optional.
; '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.

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

= --#ShowReport =
Creates a new Excel sheet containing a table that contains the results of the user specified SQL query. The result column names are the field names of the SQL query and the rows are the actual data rows of the SQL query. The report can be used to see, for example, the events that would be loaded into QPR ProcessAnalyzer before actually loading them. If the events have problems that cause errors when loaded it is useful to be able to see the row data in a report.
'''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 ==
A user specified SQL query to be shown in the configured Excel sheet.
; <nowiki>'<data>'</nowiki>
: 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:<br/>
; '<Analysis Parameter>'
: Optional. The [[QPR ProcessAnalyzer Analysis Parameters]] given for the operation. Some suggested parameters to be used:
:; 'Title'
:: The title of the created report. If not given, "Report" will be used as a default.
:; 'SheetName'
:: The name of the Excel sheet to be created.
:; 'MaximumCount'
:: The maximum number of rows to show (0 = all, default = 1000).

; 'PivotSheetName'
: Optional. The name of the Excel sheet to be created. The sheet will contain a pivot table that includes all columns and rows in the report. The pivot sheet doesn't support drill-down. The pivot sheet has the following additional parameters:
:; 'PivotFilters'
::A comma separated list of result sheet column names that should be used in pivot table filters dimension.
:; 'PivotRows'
:: A comma separated list of row names to be used in the pivot table rows dimension. To sort the results, add the following parameters separated by commas "(SortDirection=<Ascending or Descending>)" and/or "(SortBy=<Sort Field Name>)" to the row name. For example: "Region(SortDirection=Ascending, SortBy="Average of DurationDays"), Country(SortBy="Sum of Cost")"
:; 'PivotColumns'
:: A comma separated list of column names to be used in the pivot table columns dimension. To sort the results, add the following parameters separated by commas "(SortDirection=<Ascending or Descending>)" and/or "(SortBy=<Sort Field Name>)" to the column name. For example: "Region(SortDirection=Ascending, SortBy="Average of DurationDays"), Country(SortBy="Sum of Cost")"
:; 'PivotValues'
:: A comma separated list of column names to be used as the pivot table values. The summarize value field can be defined by adding a summarize value parameter to the end of each value name as follows: "(SummarizeBy=<Summarize value tag)". If the parameter is not defined, the Excel default value for summarize is used: "Sum" for numbers and "Count" for other types. The supported summarize value tags are: Sum, Count, Average, Max, Min, Product, CountNumbers, StdDev, StdDevp, Var, Varp. For example: "Duration Days(SummarizeBy="Average"),Cost(SummarizeBy="Sum")"
:; 'PivotTitle'
:: The title of the pivot sheet to be created. If undefined, the name defined in PivotSheetName will 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:
:<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.

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

= --#StartBackground =
Makes the script run in background starting from this command, so that using QPR ProcessAnalyzer Excel client is possible while the script is running. 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 [[QPR_ProcessAnalyzer_Logs#Script_Log|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. 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.

This command is supported only for QPR ProcessAnalyzer Service based data source connections (i.e. not supported for Xpress or Database activations). 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 [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.

SQL Scripting Commands

2019-07-23T06:43:47Z

VesKivi: /* --#ImportCaseAttributes */

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.

= --#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 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 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.
; '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.
: 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.
: In QPR ProcessAnalyzer Xpress or QPR ProcessAnalyzer Database, it is always possible to use network credentials.
; '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.
;<nowiki><other parameters></nowiki>
: All the rest of the passed parameters not listed above are added as extra headers to the request. Optional.

== Result ==
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>@_ResponseStatusCode</code> The numeric status code received from the remote server. INT.
: <code>@_ResponseSuccess</code> True only if the request returned status code that represents a success. BIT.

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

= --#CreateFilter =
Creates a new filter with the specified parameters. Returns the id of the newly created filter in SQL dynamic variable @_CreatedFilterId.

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'
: Id of the filter/view for which the new filter is applied. Mandatory.
; 'FilterType'
: Type of the additional filter to apply. Supported values are:
:: 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.

See examples at the [[CreateFilter Script Examples]] page.

= --#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:<br/>
; '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:
: <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.

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

= --#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. 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:<br/>
; '<Analysis Parameter>'
: See [[QPR ProcessAnalyzer Analysis Parameters]] for a list of supported analysis parameters in QPR ProcessAnalyzer.
: The --#GetAnalysis command supports the following analysis types:
0.'''Flowchart Analysis'''

Draws the flowchart of model defined in parameter

1.'''Variation Analysis in the Chart Mode'''

Opens Variation analysis of the model defined

3.'''Path Analysis'''

Opens Path analysis of model defined

4.'''Event Type Analysis in the Chart Mode'''

Opens Event Type analysis of model defined

5.'''Case Analysis'''
Prints the detailed list of cases and attributes of defined model

6.'''Event Analysis'''

Prints the detailed list of Events from defined model

7.'''Event Type Analysis in the Table Mode'''

Opens Event Type analysis of model defined

8.'''Variation Analysis in the Table Mode'''

Opens Variation analysis of the model defined

9.'''Duration Analysis'''

Opens Duration analysis of the model defined

10.'''Profiling Analysis'''

Opens Profiling analysis of the model defined

11.'''User Report'''

Opens a detailed list of users in server

12.'''Operation Log Analysis'''

Opens the operation log of ProcessAnalyzer

13.'''Flow Analysis'''

Opens Flow analysis of the model defined

14.'''Influence Analysis'''

Open Influence analysis of model defined, with defined parameters

18.'''Data Table Analysis'''

Reads a data table from SQL server and stores it in temporary table

21.'''Model Report'''

Opens a detailed list of models in server

22.'''Project Report'''

Opens a detailed list of projects in server

23.'''Data Table Report'''

Opens a detailed list of data tables in server

24.'''Script Report'''

Opens a detailed list of scripts in server

25.'''RunScript'''

Starts a script (used in UI)

26.'''Event Type Analysis in the Trends Mode'''

Opens Event Type analysis of model defined

28.'''Profiling Analysis in the Trends Mode'''

Opens Profiling analysis of the model defined

29.'''Profiling Analysis in the Trends Mode'''

Opens duration influence analysis of model defined

30.'''Filter Report'''

Opens a detailed list of filters in a model defined

31.'''Filter Rule Report'''
Contains information about the filter rule in filter defined

32.'''Script Log Report'''

33.'''[[QPR_ProcessAnalyzer_Expression_Analysis|Expression Analysis]]'''

: 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 [[QPR ProcessAnalyzer 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.
; '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.
; 'Title'
: Optional. The title for the Excel sheet created when Show is TRUE or 1. Default value is the name of the analysis type.
; 'SheetName'
: Optional. The name of the Excel sheet created when Show is TRUE or 1. Default value is the name of the analysis type.

; 'PivotSheetName'
: Optional. The name of the Excel sheet to be created. The sheet will contain a pivot table that includes all columns and rows in the report. The pivot sheet doesn't support drill-down. The pivot sheet has the following additional parameters:
:; 'PivotFilters'
::A comma separated list of result sheet column names that should be used in pivot table filters dimension.
:; 'PivotRows'
:: A comma separated list of row names to be used in the pivot table rows dimension. To sort the results, add the following parameters separated by commas "(SortDirection=<Ascending or Descending>)" and/or "(SortBy=<Sort Field Name>)" to the row name. For example: "Region(SortDirection=Ascending, SortBy="Average of DurationDays"), Country(SortBy="Sum of Cost")"
:; 'PivotColumns'
:: A comma separated list of column names to be used in the pivot table columns dimension. To sort the results, add the following parameters separated by commas "(SortDirection=<Ascending or Descending>)" and/or "(SortBy=<Sort Field Name>)" to the column name. For example: "Region(SortDirection=Ascending, SortBy="Average of DurationDays"), Country(SortBy="Sum of Cost")"
:; 'PivotValues'
:: A comma separated list of column names to be used as the pivot table values. The summarize value field can be defined by adding a summarize value parameter to the end of each value name as follows: "(SummarizeBy=<Summarize value tag)". If the parameter is not defined, the Excel default value for summarize is used: "Sum" for numbers and "Count" for other types. The supported summarize value tags are: Sum, Count, Average, Max, Min, Product, CountNumbers, StdDev, StdDevp, Var, Varp. For example: "Duration Days(SummarizeBy="Average"),Cost(SummarizeBy="Sum")"
:; 'PivotTitle'
:: The title of the pivot sheet to be created. If undefined, the name defined in PivotSheetName will 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:
:<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.
; 'ScriptId'
: Mandatory with the RunScript analysis type. Defines the script that should be run.
; '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 the Script Log Report and Operation Log Analysis analysis types. A date time parameter which specifies the earliest start time in the log entries. Format is ISO8601: yyyy-mm-ddThh:mm:ss.fff. The maximum year is 2030 and the minimum year is 1970. 'fff' stands for fractions of seconds and it is given in 3ms accuracy and the last digit must be 0, 3 or 7.
:* For Script Log Report analysis type: Mandatory if ScriptIds parameter is not defined.
:* For Operation Log Analysis analysis type: Optional. Default value is no earliest start time limit.
; 'MaxStartTime'
: Used with Script Log Report and Operation Log Analysis analysis types. A date time parameter which specifies the latest start time in the log entries. Format is ISO8601: yyyy-mm-ddThh:mm:ss.fff. The maximum year is 2030 and the minimum year is 1970. 'fff' stands for fractions of seconds and it is given in 3ms accuracy and the last digit must be 0, 3 or 7. Optional. Default value is no latest start time limit.
; 'IncludeCaseVariationRelations'
: Used with Event Analysis analysis type. Boolean value (default value = FALSE). If set to TRUE, the result of the event analysis will include a "CaseIdToVariationIdMap" property which is an array. Every item in the array describes the mapping between a case and a variation by ids formatted as simple array of length 2 (first item being case id, the second being variation id of that case).
; 'IncludeEventTypeNames'
: Used with Event Analysis analysis type. Boolean value (default value = FALSE). If set to TRUE, the result of the event analysis will include an "EventTypeNames" property which is an array of objects. Every item in the array maps event type id ("Key" property) into the name of that event type ("Value" property).
; 'UseMillisecondsSince1970DateTimeFormatting'
: Used with Event Analysis analysis type. Boolean value (default value = FALSE). If set to TRUE, the start time of every event is actually an integer number of milliseconds after 1.1.1970.
; 'UseIdsInsteadOfNames'
: Used with Event Analysis analysis type. Boolean value (default = FALSE). If set to TRUE, instead of returning case and event type names, the event analysis returns case and event type identifiers.
; 'IncludeCaseAttributeValues'
: Used with Event Analysis analysis type. Boolean value (default = FALSE). If set to TRUE, the result of the event analysis will include a "CaseAttributeValues" array which is an array of arrays. The first item in each inner array is the id of the case. All the items following that are the attribute values of case attributes sorted by case attribute name.
; 'MaxTextLength'
: Used with Operation Log Analysis analysis type. Integer. The maximum number of characters to return from the 'Name', 'Session Id', 'User Name', 'Model Name', 'Message', and 'Additional Data' fields. If 0 (default), all characters are returned.
; 'MaximumCount'
: Used with Operation Log Analysis analysis type. Integer. The maximum amount of rows returned. Optional. Default value is 1000.
; 'ShowOpenOnly'
: Used with Operation Log Analysis analysis type. Boolean. When TRUE, the Operation Log Analysis returns only operations that don't have end time. Optional. Default value is FALSE.

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

= --#ImportCaseAttributes =
Loads Case Attributes from the data which the preceding SQL statements given as parameters provide into the specified model. This command takes two SELECT queries as parameters. Models with external data source not support this command [[QPR_ProcessAnalyzer_Model_JSON_Settings#Loading_Data_from_ODBC_Datasources|ODBC_Datasource]].

== 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 an existing target model case attributes. TRUE or any other Integer than "0" = the existing case attributes in the target model are not deleted before import, FALSE or "0" = the existing case attributes of the target model are deleted before the import. If the target model is set to use another model as the Case Attribute Model, those case attributes are not deleted. Not used when creating a new model. Default value is TRUE.
; 'CatchOperationExceptions'
: Optional. Defines whether to stop the script execution or to continue to run the script from the next statement if an exception occurs when running the script:
: 1 = don't stop execution of the script, continue running the script from the next statement.
: 0 = stop execution of the current script and show the exception.
: The following script variables will be set and are shown in the script log:
: <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.

See examples at the [[ImportCaseAttributes Script Examples]] page.

= --#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.
; 'DataTableId' or 'DataTableName'
: The id or the name of the existing/new target data table.
; 'Append'
: Defines what to do with an existing target data table contents. TRUE or any other Integer than "0" = the existing contents in the target data table are not deleted before import, FALSE or "0" = the existing contents of the target data table are deleted before the import. Not used when creating a new data table.
; 'CatchOperationExceptions'
: Optional. Defines whether to stop the script execution or to continue to run the script from the next statement if an exception occurs when running the script:
: 1 = don't stop execution of the script, continue running the script from the next statement.
: 0 = stop execution of the current script and show the exception.
: The following script variables will be set and are shown in the script log:
:<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 if the query doesn't return any data, the data table is not created.

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

= --#ImportEvents =
Loads Events from the data which the preceding SQL statements given as parameters provide into the specified model. This command takes two SELECT queries as parameters.
== First Query ==
Configures the command using a SELECT statement returning two columns: the first column is for a key and the second one is for a value of that key. The values in both the key column and in the value column are of type NVARCHAR. The supported keys for this command are:<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 ==
; <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 ImportEvents command.

See examples at the [[ImportEvents Script Examples]] page.

= --#ImportEventsIncremental =
Synchronizes a model with event data in the specified event data table. May delete and/or add new events into the model. Events are matched between the model and the event data table as follows:

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

See examples in the [[ImportEventsIncremental Script Examples]] page.

= --#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.
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.
; 'DataTableId' or 'DataTableName'
: The id or the name of the existing/new target data table.
; 'Append'
: Defines what to do with an existing target data table 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:
:<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.

'''ODBC specific parameters'''
; 'OdbcConnectionString'
: 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]].
; '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.
; '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.

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

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

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.
; 'DataTableId' or 'DataTableName'
: The id or the name of the existing/new target data table.
; 'Append'
: Defines what to do with an existing target data table 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:
:<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.
'''OLE DB Query Parameters'''
; '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.
; '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.
; '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.

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

= --#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. 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/>
; '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.
; 'DataTableId' or 'DataTableName'
: The id or the name of the existing/new target data table.
; 'Append'
: Defines what to do with an existing target data table contents. TRUE or any other Integer than "0" = the existing contents in the target data table are not deleted before import, FALSE or "0" = the existing contents of the target data table are deleted before the import. Not used when creating a new data table.
; 'CatchOperationExceptions'
: Optional. Defines whether to stop the script execution or to continue to run the script from the next statement if an exception occurs when running the script:
: 1 = don't stop execution of the script, continue running the script from the next statement.
: 0 = stop execution of the current script and show the exception.
: The following script variables will be set and are shown in the script log:
:<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.
'''Salesforce Query Parameters'''
; 'SalesforceUser'
: Username for the Salesforce cloud.
; 'SalesforcePW'
: Password for the Salesforce cloud.
; 'SalesforceUrl'
: 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>.
; 'SalesforceQueryMode'
: 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()].
; 'SalesforceQuery'
: 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.
; '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. 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.

== Notes ==
If you get error in --#ImportSalesforceQuery PA Operation saying "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 lisence 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 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 Excel Client#Installing_SAP_Connector_for_Microsoft_.NET_Version_3.0_Dll_Files|some dlls]] not provided by QPR Software.

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'
: If this parameter is given, store the results into a temporary SQL table in ETL sandbox.
If the TargetTable parameter is not given, use the following destination parameters:
; 'ProjectId' or 'ProjectName'
: The id or the name of the project in which the target data table exists.
; 'DataTableId' or 'DataTableName'
: The id or the name of the existing/new target data table.
; 'Append'
: Defines what to do with an existing target data table 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:
:<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.

'''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.
; '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.
; '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.
; '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.
; '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.
; '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.
; '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.
; '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.

'''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.
; '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.
; 'SapPeakConnectionsLimit'
: 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'
: 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'
: 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.
; '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.
; '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.
; '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.
; '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.
; '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.
; '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.
; '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 [[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'
: 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'
: 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.

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

= --#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.
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.
; 'DataTableId' or 'DataTableName'
: The id or the name of the existing/new target data table.
; 'Append'
: Defines what to do with an existing target data table 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:
:<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.
'''SQL Query Parameters'''
; '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.
; '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.
; '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.

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

= --#RemoveCases =
Removes all or specified cases in the target model. This command takes two SELECT queries as parameters.
== First Query ==
Configures the command using a SELECT statement returning two columns: the first column is for a key and the second one is for a value of that key. The values in both the key column and in the value column are of type NVARCHAR. The supported keys for this command are:<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.

See examples at the [[RemoveCases Script Examples]] page.

= --#RemoveEvents =
Removes all or specified events in the target model, but retains Cases, Event Types, and Variations. This command takes two SELECT queries as parameters.
== First Query ==
Configures the command using a SELECT statement returning two columns: the first column is for a key and the second one is for a value of that key. The values in both the key column and in the value column are of type NVARCHAR. The supported keys for this command are:<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 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.

See examples at the [[RemoveEvents Script Examples]] page.

= --#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 ==
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.
The possible arguments are as follows:
:* @_Argv - type INT: the number of provided parameters (from 0 to 10)
:* #_Arg1, ... #_Arg10: arguments passed to that script

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

See examples at the [[Run Script Examples]] page.

= --#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:<br/>
; '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.
'''E-mail Parameters'''
; 'EmailFrom'
: Defines the from address for this e-mail message. Mandatory.
; 'EmailTo'
: Defines the recipient(s) for this e-mail message given in a list separated by comma. Mandatory.
; 'EmailSubject'
: Defines the subject of the email. Default value is empty. Optional.
; 'EmailBody'
: Defines the message body. Default value is empty. Optional.
; 'EmailCc'
: Defines the carbon copy recipient(s) for this e-mail message given in a list separated by comma. Optional.
; 'EmailBcc'
: Defines the blind carbon copy recipient(s) for this e-mail message given in a list separated by comma. Optional.
; 'EmailIsBodyHtml'
: Defines whether the e-mail message body is in HTML. TRUE or any other Integer than "0" = body is in HTML, FALSE or "0" = body is not in HTML. Default value is FALSE. Optional.
; 'EmailSender'
: Defines the sender's address for this e-mail message. Default value is empty. Optional.
; 'EmailReplyTo'
: Defines the ReplyTo address(es) for the mail message given in a list separated by comma. Optional.
; 'EmailPriority',
: Defines the priority of this e-mail message. Possible values are "High", "Normal", and "Low". Default value is "Normal". Optional.
; 'EmailDeliveryNotification'
: Defines the delivery notifications for this e-mail message. Possible values are "Delay", "Never", "None", "OnFailure", and "OnSuccess". Default value is "None". Optional.
; 'EmailBodyEncoding'
: Defines the encoding used to encode the message body. Supported encodings are listed in the "Remarks" section at http://msdn.microsoft.com/en-us/library/System.Text.Encoding.aspx. Optional.
; 'EmailSubjectEncoding'
: Defines the encoding used for the subject content for this e-mail message. Supported encodings are listed in the "Remarks" section at http://msdn.microsoft.com/en-us/library/System.Text.Encoding.aspx. Optional.
; '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.

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

= --#ShowReport =
Creates a new Excel sheet containing a table that contains the results of the user specified SQL query. The result column names are the field names of the SQL query and the rows are the actual data rows of the SQL query. The report can be used to see, for example, the events that would be loaded into QPR ProcessAnalyzer before actually loading them. If the events have problems that cause errors when loaded it is useful to be able to see the row data in a report.
'''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 ==
A user specified SQL query to be shown in the configured Excel sheet.
; <nowiki>'<data>'</nowiki>
: 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:<br/>
; '<Analysis Parameter>'
: Optional. The [[QPR ProcessAnalyzer Analysis Parameters]] given for the operation. Some suggested parameters to be used:
:; 'Title'
:: The title of the created report. If not given, "Report" will be used as a default.
:; 'SheetName'
:: The name of the Excel sheet to be created.
:; 'MaximumCount'
:: The maximum number of rows to show (0 = all, default = 1000).

; 'PivotSheetName'
: Optional. The name of the Excel sheet to be created. The sheet will contain a pivot table that includes all columns and rows in the report. The pivot sheet doesn't support drill-down. The pivot sheet has the following additional parameters:
:; 'PivotFilters'
::A comma separated list of result sheet column names that should be used in pivot table filters dimension.
:; 'PivotRows'
:: A comma separated list of row names to be used in the pivot table rows dimension. To sort the results, add the following parameters separated by commas "(SortDirection=<Ascending or Descending>)" and/or "(SortBy=<Sort Field Name>)" to the row name. For example: "Region(SortDirection=Ascending, SortBy="Average of DurationDays"), Country(SortBy="Sum of Cost")"
:; 'PivotColumns'
:: A comma separated list of column names to be used in the pivot table columns dimension. To sort the results, add the following parameters separated by commas "(SortDirection=<Ascending or Descending>)" and/or "(SortBy=<Sort Field Name>)" to the column name. For example: "Region(SortDirection=Ascending, SortBy="Average of DurationDays"), Country(SortBy="Sum of Cost")"
:; 'PivotValues'
:: A comma separated list of column names to be used as the pivot table values. The summarize value field can be defined by adding a summarize value parameter to the end of each value name as follows: "(SummarizeBy=<Summarize value tag)". If the parameter is not defined, the Excel default value for summarize is used: "Sum" for numbers and "Count" for other types. The supported summarize value tags are: Sum, Count, Average, Max, Min, Product, CountNumbers, StdDev, StdDevp, Var, Varp. For example: "Duration Days(SummarizeBy="Average"),Cost(SummarizeBy="Sum")"
:; 'PivotTitle'
:: The title of the pivot sheet to be created. If undefined, the name defined in PivotSheetName will 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:
:<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.

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

= --#StartBackground =
Makes the script run in background starting from this command, so that using QPR ProcessAnalyzer Excel client is possible while the script is running. 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 [[QPR_ProcessAnalyzer_Logs#Script_Log|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. 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.

This command is supported only for QPR ProcessAnalyzer Service based data source connections (i.e. not supported for Xpress or Database activations). 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 [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.

QPR ProcessAnalyzer System Requirements

2019-07-16T11:47:30Z

VesKivi: /* System Requirements for QPR ProcessAnalyzer ScriptLauncher */

__TOC__

== System Requirements for QPR ProcessAnalyzer Excel Client ==
System requirements for QPR ProcessAnalyzer Excel Client:
* Microsoft Windows 10 operating system (64 bit version)
** Mac users need to use Windows in a pure virtual machine, created on e.g. [http://www.parallels.com/products/desktop/ Parallels Desktop], [http://www.vmware.com/products/fusion/overview.html VMware Fusion], or as a virtualized Boot Camp partition created by either one.
* Microsoft Office 2013, 2016 (32 bit and 64 bit versions) or 2019.
* Internet connection for connecting to QPR ProcessAnalyzer Service

The following components are also required and they will be installed if not found on your computer:
* Microsoft .NET Framework 4.7.2
* Microsoft Visual Studio Tools for Office Runtime

Additional requirement for using [[Data_Extraction,_Transformation,_and_Loading#--.23ImportSapQuery|ImportSapQuery]] script command: [[Installing QPR ProcessAnalyzer Excel Client#Installing_SAP_Connector_for_Microsoft_.NET_Version_3.0_Dll_Files|install the SAP Connector for Microsoft .NET Dll files]].

== Additional System Requirements for QPR ProcessAnalyzer Xpress ==
In addition to the requirements for QPR ProcessAnalyzer Excel Client, there are the following additional requirements for QPR ProcessAnalyzer Xpress:
* 64-bit Microsoft Windows 10 operating system
* SQL Server LocalDB 2016 database
* Internet connection in order to [[Activating QPR ProcessAnalyzer|activate]] the product

== System Requirements for QPR ProcessAnalyzer Server ==
QPR ProcessAnalyzer Server is needed for QPR ProcessAnalyzer Pro. System requirements for QPR ProcessAnalyzer Server:
* Microsoft Windows Server 2008 R2, 2012 or 2016 operating system
* Microsoft SQL Server 2012, 2014, 2016 or 2017 database with Database Engine Services installed
* Sufficiently powerful enough hardware to run the operating system
* '''Microsoft .NET Framework 4.7.1''' is installed
* [[Installing_QPR_ProcessAnalyzer_Server#Install_Server_Roles_and_Features_for_IIS | Install Server Roles and Features for Microsoft Internet Information Services (IIS)]]

== System Requirements for QPR ProcessAnalyzer ScriptLauncher ==
* Microsoft Windows 10 or Windows Server 2012 R2 operating system. Mac users need to use Windows as a pure virtual machine, created on e.g. [http://www.parallels.com/products/desktop/ Parallels Desktop] or [http://www.vmware.com/products/fusion/overview.html VMware Fusion], or as a virtualized Boot Camp partition created by either one.
* Internet connection
* The sapnco.dll and sapnco_utils.dll files distributed in the [http://service.sap.com/connectors SAP Connector for Microsoft .NET Version 3.0 (requires SAP Service Marketplace credentials)] package are needed in order to use the [[Data_Extraction,_Transformation,_and_Loading#--.23ImportSapQuery|ImportSapQuery]] script command. See the [[Installing QPR ProcessAnalyzer Excel Client#Installing_QPR_ProcessAnalyzer_ScriptLauncher|instructions]] for installing them.
* Microsoft .NET Framework 4.7.1 or newer

== Recommended Hardware for QPR ProcessAnalyzer Pro Server ==

* '''Small''' datasets (up to 5 million events per model) with simultaneous users
** 32GB memory
** 4 processor cores
** 50GB disk
* '''Medium''' datasets (10-20 million events per model) with simultaneous users
** 64GB memory
** 8 processor cores
** 100GB disk
* '''Large''' datasets (20-80 million events per model) with simultaneous users
** 256GB memory
** 16 processor cores
** 150GB disk
* '''Very large''' datasets (more than 80 million events per model) with simultaneous users
** 512GB memory
** 32 processor cores
** 200GB disk

== Recommended Hardware for QPR ProcessAnalyzer Pro Database Server ==
Recommended hardware configuration for the server computer running Microsoft SQL Server database:
* 16GB memory
* 4 processor cores
* 300GB - 1TB available SSD disk for SQL Server temp database
* 500GB - 10TB available SSD disk for data storage on a disk dedicated to QPR ProcessAnalyzer

== Recommended Hardware for QPR ProcessAnalyzer Xpress Excel Client==
* 8GB memory
* 4 core processor
* 32GB disk

[[Category: QPR ProcessAnalyzer]]

QPR ProcessAnalyzer System Requirements

2019-07-16T11:47:17Z

VesKivi: /* System Requirements for QPR ProcessAnalyzer Server */

__TOC__

== System Requirements for QPR ProcessAnalyzer Excel Client ==
System requirements for QPR ProcessAnalyzer Excel Client:
* Microsoft Windows 10 operating system (64 bit version)
** Mac users need to use Windows in a pure virtual machine, created on e.g. [http://www.parallels.com/products/desktop/ Parallels Desktop], [http://www.vmware.com/products/fusion/overview.html VMware Fusion], or as a virtualized Boot Camp partition created by either one.
* Microsoft Office 2013, 2016 (32 bit and 64 bit versions) or 2019.
* Internet connection for connecting to QPR ProcessAnalyzer Service

The following components are also required and they will be installed if not found on your computer:
* Microsoft .NET Framework 4.7.2
* Microsoft Visual Studio Tools for Office Runtime

Additional requirement for using [[Data_Extraction,_Transformation,_and_Loading#--.23ImportSapQuery|ImportSapQuery]] script command: [[Installing QPR ProcessAnalyzer Excel Client#Installing_SAP_Connector_for_Microsoft_.NET_Version_3.0_Dll_Files|install the SAP Connector for Microsoft .NET Dll files]].

== Additional System Requirements for QPR ProcessAnalyzer Xpress ==
In addition to the requirements for QPR ProcessAnalyzer Excel Client, there are the following additional requirements for QPR ProcessAnalyzer Xpress:
* 64-bit Microsoft Windows 10 operating system
* SQL Server LocalDB 2016 database
* Internet connection in order to [[Activating QPR ProcessAnalyzer|activate]] the product

== System Requirements for QPR ProcessAnalyzer Server ==
QPR ProcessAnalyzer Server is needed for QPR ProcessAnalyzer Pro. System requirements for QPR ProcessAnalyzer Server:
* Microsoft Windows Server 2008 R2, 2012 or 2016 operating system
* Microsoft SQL Server 2012, 2014, 2016 or 2017 database with Database Engine Services installed
* Sufficiently powerful enough hardware to run the operating system
* '''Microsoft .NET Framework 4.7.1''' is installed
* [[Installing_QPR_ProcessAnalyzer_Server#Install_Server_Roles_and_Features_for_IIS | Install Server Roles and Features for Microsoft Internet Information Services (IIS)]]

== System Requirements for QPR ProcessAnalyzer ScriptLauncher ==
* Microsoft Windows 10 or Windows Server 2012 R2 operating system. Mac users need to use Windows as a pure virtual machine, created on e.g. [http://www.parallels.com/products/desktop/ Parallels Desktop] or [http://www.vmware.com/products/fusion/overview.html VMware Fusion], or as a virtualized Boot Camp partition created by either one.
* Internet connection
* The sapnco.dll and sapnco_utils.dll files distributed in the [http://service.sap.com/connectors SAP Connector for Microsoft .NET Version 3.0 (requires SAP Service Marketplace credentials)] package are needed in order to use the [[Data_Extraction,_Transformation,_and_Loading#--.23ImportSapQuery|ImportSapQuery]] script command. See the [[Installing QPR ProcessAnalyzer Excel Client#Installing_QPR_ProcessAnalyzer_ScriptLauncher|instructions]] for installing them.
* Microsoft .NET Framework 4.6.1 or newer

== Recommended Hardware for QPR ProcessAnalyzer Pro Server ==

* '''Small''' datasets (up to 5 million events per model) with simultaneous users
** 32GB memory
** 4 processor cores
** 50GB disk
* '''Medium''' datasets (10-20 million events per model) with simultaneous users
** 64GB memory
** 8 processor cores
** 100GB disk
* '''Large''' datasets (20-80 million events per model) with simultaneous users
** 256GB memory
** 16 processor cores
** 150GB disk
* '''Very large''' datasets (more than 80 million events per model) with simultaneous users
** 512GB memory
** 32 processor cores
** 200GB disk

== Recommended Hardware for QPR ProcessAnalyzer Pro Database Server ==
Recommended hardware configuration for the server computer running Microsoft SQL Server database:
* 16GB memory
* 4 processor cores
* 300GB - 1TB available SSD disk for SQL Server temp database
* 500GB - 10TB available SSD disk for data storage on a disk dedicated to QPR ProcessAnalyzer

== Recommended Hardware for QPR ProcessAnalyzer Xpress Excel Client==
* 8GB memory
* 4 core processor
* 32GB disk

[[Category: QPR ProcessAnalyzer]]

QPR ProcessAnalyzer System Requirements

2019-07-16T11:47:05Z

VesKivi: /* System Requirements for QPR ProcessAnalyzer Excel Client */

__TOC__

== System Requirements for QPR ProcessAnalyzer Excel Client ==
System requirements for QPR ProcessAnalyzer Excel Client:
* Microsoft Windows 10 operating system (64 bit version)
** Mac users need to use Windows in a pure virtual machine, created on e.g. [http://www.parallels.com/products/desktop/ Parallels Desktop], [http://www.vmware.com/products/fusion/overview.html VMware Fusion], or as a virtualized Boot Camp partition created by either one.
* Microsoft Office 2013, 2016 (32 bit and 64 bit versions) or 2019.
* Internet connection for connecting to QPR ProcessAnalyzer Service

The following components are also required and they will be installed if not found on your computer:
* Microsoft .NET Framework 4.7.2
* Microsoft Visual Studio Tools for Office Runtime

Additional requirement for using [[Data_Extraction,_Transformation,_and_Loading#--.23ImportSapQuery|ImportSapQuery]] script command: [[Installing QPR ProcessAnalyzer Excel Client#Installing_SAP_Connector_for_Microsoft_.NET_Version_3.0_Dll_Files|install the SAP Connector for Microsoft .NET Dll files]].

== Additional System Requirements for QPR ProcessAnalyzer Xpress ==
In addition to the requirements for QPR ProcessAnalyzer Excel Client, there are the following additional requirements for QPR ProcessAnalyzer Xpress:
* 64-bit Microsoft Windows 10 operating system
* SQL Server LocalDB 2016 database
* Internet connection in order to [[Activating QPR ProcessAnalyzer|activate]] the product

== System Requirements for QPR ProcessAnalyzer Server ==
QPR ProcessAnalyzer Server is needed for QPR ProcessAnalyzer Pro. System requirements for QPR ProcessAnalyzer Server:
* Microsoft Windows Server 2008 R2, 2012 or 2016 operating system
* Microsoft SQL Server 2012, 2014, 2016 or 2017 database with Database Engine Services installed
* Sufficiently powerful enough hardware to run the operating system
* '''Microsoft .NET Framework 4.6.1''' is installed
* [[Installing_QPR_ProcessAnalyzer_Server#Install_Server_Roles_and_Features_for_IIS | Install Server Roles and Features for Microsoft Internet Information Services (IIS)]]

== System Requirements for QPR ProcessAnalyzer ScriptLauncher ==
* Microsoft Windows 10 or Windows Server 2012 R2 operating system. Mac users need to use Windows as a pure virtual machine, created on e.g. [http://www.parallels.com/products/desktop/ Parallels Desktop] or [http://www.vmware.com/products/fusion/overview.html VMware Fusion], or as a virtualized Boot Camp partition created by either one.
* Internet connection
* The sapnco.dll and sapnco_utils.dll files distributed in the [http://service.sap.com/connectors SAP Connector for Microsoft .NET Version 3.0 (requires SAP Service Marketplace credentials)] package are needed in order to use the [[Data_Extraction,_Transformation,_and_Loading#--.23ImportSapQuery|ImportSapQuery]] script command. See the [[Installing QPR ProcessAnalyzer Excel Client#Installing_QPR_ProcessAnalyzer_ScriptLauncher|instructions]] for installing them.
* Microsoft .NET Framework 4.6.1 or newer

== Recommended Hardware for QPR ProcessAnalyzer Pro Server ==

* '''Small''' datasets (up to 5 million events per model) with simultaneous users
** 32GB memory
** 4 processor cores
** 50GB disk
* '''Medium''' datasets (10-20 million events per model) with simultaneous users
** 64GB memory
** 8 processor cores
** 100GB disk
* '''Large''' datasets (20-80 million events per model) with simultaneous users
** 256GB memory
** 16 processor cores
** 150GB disk
* '''Very large''' datasets (more than 80 million events per model) with simultaneous users
** 512GB memory
** 32 processor cores
** 200GB disk

== Recommended Hardware for QPR ProcessAnalyzer Pro Database Server ==
Recommended hardware configuration for the server computer running Microsoft SQL Server database:
* 16GB memory
* 4 processor cores
* 300GB - 1TB available SSD disk for SQL Server temp database
* 500GB - 10TB available SSD disk for data storage on a disk dedicated to QPR ProcessAnalyzer

== Recommended Hardware for QPR ProcessAnalyzer Xpress Excel Client==
* 8GB memory
* 4 core processor
* 32GB disk

[[Category: QPR ProcessAnalyzer]]

QPR ProcessAnalyzer Wiki

2019-07-15T11:01:22Z

VesKivi: /* Configuring */

<div class="downloadButton" style="width:240px;float:right;margin: 3px 12px 0px 15px;">[[QPR_Product_Downloads|Download<br />QPR ProcessAnalyzer]]</div>

Welcome to QPR ProcessAnalyzer Wiki! QPR ProcessAnalyzer is the tool for turning event and transactional data into visual process intelligence. Read [[Introduction to QPR ProcessAnalyzer]] for an introduction of the software. Topics in this documentation are divided into users roles: process analysts, developers and administrators.

<div style="height:5px;"></div>
== For Process Analysts ==
QPR ProcessAnalyzer is used via web browser. In QPR ProcessAnalyzer application you can perform various analyses on your process model. If you prefer standalone installation, you can use excel client for analyses.

<div style="display: flex;flex-wrap: wrap;">
<div style="flex: 1 0 270px;border:1px solid #dfdfdf;padding:0 1em 1em 1.5em;background-color:#F7FAFC;margin:10px 0px 0px 10px;">
=== Using QPR ProcessAnalyzer ===
* [[Introduction to QPR ProcessAnalyzer]]
* [[Process_Mining_Concept|Process Mining Concepts and Terms]]
* [[QPR ProcessAnalyzer UI|QPR ProcessAnalyzer UI]]
* [[QPR ProcessAnalyzer Presentation Object (PAPO)|QPR ProcessAnalyzer Dashboards]]
* [[QPR ProcessAnalyzer Presentation Object Variables|QPR ProcessAnalyzer Variables]]
* [[QPR ProcessAnalyzer Use Cases|Customer Use Cases]]
* [[QPR ProcessAnalyzer Certification]]
</div>

<div style="flex: 1 0 370px;border:1px solid #dfdfdf;padding:0 1em 1em 1.5em;background-color:#F7FAFC;margin:10px 0px 0px 10px;">

=== Process Mining Analyses and Visualizations ===
<div style="float:left; width:50%;">
* [[Case_Analysis (PAPO)|Case Analysis]]
* [[QPR_ProcessAnalyzer_-_ChartView|ChartView]]
* [[QPR_ProcessAnalyzer_-_Clustering_Analysis_View|Clustering Analysis]]
* [[QPR_ProcessAnalyzer_-_Conformance_Analysis_View|Conformance Analysis]]
* [[Duration_Analysis (PAPO)|Duration Analysis]]
* [[Event_Analysis (PAPO)|Event Analysis]]
* [[Event_Type_Analysis (PAPO)|Event Type Analysis]]
</div>
<div style="float:left; width:50%;">
* [[Flowchart_Analysis (PAPO)|Flowchart Analysis]]
* [[Flowchart_Influence_Analysis (PAPO)|Flowchart Influence Analysis]]
* [[Influence_Analysis_for_Case_Attributes (PAPO)|Influence Analysis for Case Attributes]]
* [[KPI Analysis (PAPO)|KPI Analysis]]
* [[Profiling_Case_Analysis (PAPO)|Profiling Case Analysis]]
* [[Profiling_Event_Analysis (PAPO)|Profiling Event Analysis]]
* [[Variation_Analysis (PAPO)|Variation Analysis]]
</div>
</div>

<div style="flex: 1 0 240px;border:1px solid #dfdfdf;padding:0 1em 1em 1.5em;background-color:#F7FAFC;margin:10px 0px 0px 10px;">

=== QPR ProcessAnalyzer Excel Client ===
* [[Get Started with QPR ProcessAnalyzer Excel Client|Get Started with Excel Client]]
* [[QPR ProcessAnalyzer Excel Client|Using Excel Client]]
* [[Installing_QPR_ProcessAnalyzer_Excel_Client|Installing Excel Client]]
</div>
</div>

== For Developers ==
To create QPR ProcessAnalyzer models, you need to Extract data from source system(s), transform data to a format compatible with QPR ProcessAnalyzer and finally load data as process model(s). To perform these tasks, you can use T-SQL and QPR ProcessAnalyzer scripting commands. When you have created a model, end-users can analyze it easily by using QPR UI’s ProcessAnalyzer application. If needed, there are plenty of tools to customize the end-user experience in QPR UI.

<div style="display: flex;flex-wrap: wrap;">
<div style="flex: 1 0 370px;border:1px solid #dfdfdf;padding:0 1em 1em 1.5em;background-color:#F7FAFC;margin:10px 0px 0px 10px;">
=== Expression Language ===
* [[QPR ProcessAnalyzer Expression Analysis|QPR ProcessAnalyzer Expressions]]
* [[QPR_ProcessAnalyzer_Expressions|Introduction to Expression Language]]
* [[QPR_ProcessAnalyzer_Objects_in_Expression_Language|QPR ProcessAnalyzer Objects]] ([[QPR_ProcessAnalyzer_Objects_in_Expression_Language#AttributeType|AttributeType]], [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#Case|Case]], [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#Event|Event]], [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#EventLog|EventLog]], [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#EventType|EventType]], [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#Flow|Flow]], [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#FlowOccurrence|FlowOccurrence]], [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#Model|Model]], [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#Project|Project]], [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#User.2FGroup|User/Group]], [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#Variation|Variation]])
* [[Generic_Objects_in_Expression_Language|Generic Objects]] ([[Generic_Objects_in_Expression_Language#Array|Array]], [[Generic_Objects_in_Expression_Language#DateTime|DateTime]], [[Generic_Objects_in_Expression_Language#Dictionary|Dictionary]], [[Generic_Objects_in_Expression_Language#String|String]], [[Generic_Objects_in_Expression_Language#TimeSpan|TimeSpan]])
* [[Generic Properties and Functions in QPR ProcessAnalyzer Expressions|Function and Properties]]
* [[Machine_Learning_Functions_in_Expression_Language|Machine Learning Functions]]
* [[Conformance_Checking_in_QPR_ProcessAnalyzer|Conformance Checking using BPMN]]
* [[Filtering_in_QPR_ProcessAnalyzer_Queries|Filtering Queries]]
* [[QPR ProcessAnalyzer Datasource|QPR ProcessAnalyzer Queries]]
</div>

<div style="flex: 1 0 250px;border:1px solid #dfdfdf;padding:0 1em 1em 1.5em;background-color:#F7FAFC;margin:10px 0px 0px 10px;">

=== Manage Models and Content ===
* [[Project Workspace in QPR ProcessAnalyzer Excel Client|Manage Projects and Models]]
* [[Calculated Attributes in QPR ProcessAnalyzer|Calculated Attributes]]
* [[QPR ProcessAnalyzer Model JSON Settings|Model Settings]]
* [[Filtering_in_QPR_ProcessAnalyzer_Excel_Client|Administrate Filters]]
* [[Manage Users in QPR ProcessAnalyzer Excel Client|Manage Users and Groups]]
* [[User Roles and Permissions in QPR ProcessAnalyzer|Permissions and Security Roles]]
* [[Exporting and Importing Models in QPR ProcessAnalyzer|Exporting and Importing Models]]
* [[QPR ProcessAnalyzer Logs|Logs in QPR ProcessAnalyzer]]
</div>

<div style="flex: 1 0 250px;border:1px solid #dfdfdf;padding:0 1em 1em 1.5em;background-color:#F7FAFC;margin:10px 0px 0px 10px;">
=== Data Integrations and API's ===
* [[Data Tables in QPR ProcessAnalyzer|Manage Data Tables]]
* [[Manage Scripts in QPR ProcessAnalyzer Excel Client|Scripting Manager]]
* [[Data Extraction, Transformation, and Loading|Introduction to ETL Scripting]]
* [[QPR ProcessAnalyzer Scripting Commands|Scripting Commands Reference]]
* [[QPR ProcessAnalyzer ScriptLauncher| ScriptLauncher]]
* [[QPR_ProcessAnalyzer_Model_JSON_Settings#Loading_Process_Mining_Data_from_ODBC_Datasource|Loading Models from ODBC Datasource]]
* [[QPR ProcessAnalyzer Web Service API|QPR ProcessAnalyzer Web Service API]]
* [[QPR ProcessAnalyzer ETL Tutorial | ETL Scripting Tutorial]]
* [[Sample Files for QPR ProcessAnalyzer]]
</div>
</div>

== For Administrators ==
QPR ProcessAnalyzer installation requires installing the QPR ProcessAnalyzer Server to IIS and two databases. It is recommended to install also QPR UI server to fully utilize the power of QPR ProcessAnalyzer. With QPR UI installed, QPR ProcessAnalyzer can be used via web browser for analyzing process models and analyzer users do not need any additional software installed on their workstations. Developer users need also to have QPR ProcessAnalyzer Excel client installed.

<div style="display: flex;flex-wrap: wrap;">
<div style="flex: 1 0 290px;border:1px solid #dfdfdf;padding:0 1em 1em 1.5em;background-color:#F7FAFC;margin:10px 0px 0px 10px;">
=== Planning Installation ===
* [[QPR ProcessAnalyzer System Requirements|System Requirements for QPR ProcessAnalyzer]]
* [[QPR ProcessAnalyzer Release Notes]]
* [[QPR_ProcessAnalyzer_Version_Compatibility|QPR ProcessAnalyzer Version Compatibility]]
* [[QPR Software Products Architecture|QPR Software Products Architecture]]
</div>

<div style="flex: 1 0 290px;border:1px solid #dfdfdf;padding:0 1em 1em 1.5em;background-color:#F7FAFC;margin:10px 0px 0px 10px;">
=== Installing ===
* [[Installing QPR ProcessAnalyzer Server|New Installation for QPR ProcessAnalyzer Server]]
* [[Installing_QPR_ProcessAnalyzer_Server#Setting_Up_Scripting_Sandbox|Setting Up Scripting Environment]]
* [[Installing_QPR_ProcessAnalyzer_Server#Updating_QPR_ProcessAnalyzer_Server_to_Newer_Version|Upgrading Existing QPR ProcessAnalyzer Server]]
* [[Installing_QPR_ProcessAnalyzer_Excel_Client|Installing QPR ProcessAnalyzer Excel Client]]
* [[Installing_SAP_Connector|Installing SAP Connector]]
* [[Installing_QPR_ProcessAnalyzer_ScriptLauncher|Installing QPR ProcessAnalyzer ScriptLauncher]]
* To install QPR UI, follow the [[QPR_UI_Wiki#Installation and Administration|QPR UI installation documentation]]
</div>

<div style="flex: 1 0 290px;border:1px solid #dfdfdf;padding:0 1em 1em 1.5em;background-color:#F7FAFC;margin:10px 0px 0px 10px;">

=== Configuring ===
* [[Web.config_file_in_QPR_ProcessAnalyzer|Web.config File Settings]]
* [[PA_Configuration_database_table_in_QPR_ProcessAnalyzer|PA_Configuration Database Table Settings]]
* [[Installing_QPR_ProcessAnalyzer_Server#IIS_Configuration|IIS Configuration]]
* [[LDAP/AD_Authentication_in_QPR_ProcessAnalyzer_Server|AD/LDAP Authentication]]
* [[QPR ProcessAnalyzer Model JSON Settings|Model Settings]]
* [[QPR_ProcessAnalyzer_Client_Configuration|Client (Excel/ScriptLauncher) Settings]]
</div>
</div>

== Agreements ==
See the [[QPR End User Software License Agreement]] and [[QPR Software as a Service Agreement]].

__NOTOC__

QPR ProcessAnalyzer Wiki

2019-07-15T10:45:29Z

VesKivi: /* Installing */

<div class="downloadButton" style="width:240px;float:right;margin: 3px 12px 0px 15px;">[[QPR_Product_Downloads|Download<br />QPR ProcessAnalyzer]]</div>

Welcome to QPR ProcessAnalyzer Wiki! QPR ProcessAnalyzer is the tool for turning event and transactional data into visual process intelligence. Read [[Introduction to QPR ProcessAnalyzer]] for an introduction of the software. Topics in this documentation are divided into users roles: process analysts, developers and administrators.

<div style="height:5px;"></div>
== For Process Analysts ==
QPR ProcessAnalyzer is used via web browser. In QPR ProcessAnalyzer application you can perform various analyses on your process model. If you prefer standalone installation, you can use excel client for analyses.

<div style="display: flex;flex-wrap: wrap;">
<div style="flex: 1 0 270px;border:1px solid #dfdfdf;padding:0 1em 1em 1.5em;background-color:#F7FAFC;margin:10px 0px 0px 10px;">
=== Using QPR ProcessAnalyzer ===
* [[Introduction to QPR ProcessAnalyzer]]
* [[Process_Mining_Concept|Process Mining Concepts and Terms]]
* [[QPR ProcessAnalyzer UI|QPR ProcessAnalyzer UI]]
* [[QPR ProcessAnalyzer Presentation Object (PAPO)|QPR ProcessAnalyzer Dashboards]]
* [[QPR ProcessAnalyzer Presentation Object Variables|QPR ProcessAnalyzer Variables]]
* [[QPR ProcessAnalyzer Use Cases|Customer Use Cases]]
* [[QPR ProcessAnalyzer Certification]]
</div>

<div style="flex: 1 0 370px;border:1px solid #dfdfdf;padding:0 1em 1em 1.5em;background-color:#F7FAFC;margin:10px 0px 0px 10px;">

=== Process Mining Analyses and Visualizations ===
<div style="float:left; width:50%;">
* [[Case_Analysis (PAPO)|Case Analysis]]
* [[QPR_ProcessAnalyzer_-_ChartView|ChartView]]
* [[QPR_ProcessAnalyzer_-_Clustering_Analysis_View|Clustering Analysis]]
* [[QPR_ProcessAnalyzer_-_Conformance_Analysis_View|Conformance Analysis]]
* [[Duration_Analysis (PAPO)|Duration Analysis]]
* [[Event_Analysis (PAPO)|Event Analysis]]
* [[Event_Type_Analysis (PAPO)|Event Type Analysis]]
</div>
<div style="float:left; width:50%;">
* [[Flowchart_Analysis (PAPO)|Flowchart Analysis]]
* [[Flowchart_Influence_Analysis (PAPO)|Flowchart Influence Analysis]]
* [[Influence_Analysis_for_Case_Attributes (PAPO)|Influence Analysis for Case Attributes]]
* [[KPI Analysis (PAPO)|KPI Analysis]]
* [[Profiling_Case_Analysis (PAPO)|Profiling Case Analysis]]
* [[Profiling_Event_Analysis (PAPO)|Profiling Event Analysis]]
* [[Variation_Analysis (PAPO)|Variation Analysis]]
</div>
</div>

<div style="flex: 1 0 240px;border:1px solid #dfdfdf;padding:0 1em 1em 1.5em;background-color:#F7FAFC;margin:10px 0px 0px 10px;">

=== QPR ProcessAnalyzer Excel Client ===
* [[Get Started with QPR ProcessAnalyzer Excel Client|Get Started with Excel Client]]
* [[QPR ProcessAnalyzer Excel Client|Using Excel Client]]
* [[Installing_QPR_ProcessAnalyzer_Excel_Client|Installing Excel Client]]
</div>
</div>

== For Developers ==
To create QPR ProcessAnalyzer models, you need to Extract data from source system(s), transform data to a format compatible with QPR ProcessAnalyzer and finally load data as process model(s). To perform these tasks, you can use T-SQL and QPR ProcessAnalyzer scripting commands. When you have created a model, end-users can analyze it easily by using QPR UI’s ProcessAnalyzer application. If needed, there are plenty of tools to customize the end-user experience in QPR UI.

<div style="display: flex;flex-wrap: wrap;">
<div style="flex: 1 0 370px;border:1px solid #dfdfdf;padding:0 1em 1em 1.5em;background-color:#F7FAFC;margin:10px 0px 0px 10px;">
=== Expression Language ===
* [[QPR ProcessAnalyzer Expression Analysis|QPR ProcessAnalyzer Expressions]]
* [[QPR_ProcessAnalyzer_Expressions|Introduction to Expression Language]]
* [[QPR_ProcessAnalyzer_Objects_in_Expression_Language|QPR ProcessAnalyzer Objects]] ([[QPR_ProcessAnalyzer_Objects_in_Expression_Language#AttributeType|AttributeType]], [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#Case|Case]], [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#Event|Event]], [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#EventLog|EventLog]], [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#EventType|EventType]], [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#Flow|Flow]], [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#FlowOccurrence|FlowOccurrence]], [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#Model|Model]], [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#Project|Project]], [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#User.2FGroup|User/Group]], [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#Variation|Variation]])
* [[Generic_Objects_in_Expression_Language|Generic Objects]] ([[Generic_Objects_in_Expression_Language#Array|Array]], [[Generic_Objects_in_Expression_Language#DateTime|DateTime]], [[Generic_Objects_in_Expression_Language#Dictionary|Dictionary]], [[Generic_Objects_in_Expression_Language#String|String]], [[Generic_Objects_in_Expression_Language#TimeSpan|TimeSpan]])
* [[Generic Properties and Functions in QPR ProcessAnalyzer Expressions|Function and Properties]]
* [[Machine_Learning_Functions_in_Expression_Language|Machine Learning Functions]]
* [[Conformance_Checking_in_QPR_ProcessAnalyzer|Conformance Checking using BPMN]]
* [[Filtering_in_QPR_ProcessAnalyzer_Queries|Filtering Queries]]
* [[QPR ProcessAnalyzer Datasource|QPR ProcessAnalyzer Queries]]
</div>

<div style="flex: 1 0 250px;border:1px solid #dfdfdf;padding:0 1em 1em 1.5em;background-color:#F7FAFC;margin:10px 0px 0px 10px;">

=== Manage Models and Content ===
* [[Project Workspace in QPR ProcessAnalyzer Excel Client|Manage Projects and Models]]
* [[Calculated Attributes in QPR ProcessAnalyzer|Calculated Attributes]]
* [[QPR ProcessAnalyzer Model JSON Settings|Model Settings]]
* [[Filtering_in_QPR_ProcessAnalyzer_Excel_Client|Administrate Filters]]
* [[Manage Users in QPR ProcessAnalyzer Excel Client|Manage Users and Groups]]
* [[User Roles and Permissions in QPR ProcessAnalyzer|Permissions and Security Roles]]
* [[Exporting and Importing Models in QPR ProcessAnalyzer|Exporting and Importing Models]]
* [[QPR ProcessAnalyzer Logs|Logs in QPR ProcessAnalyzer]]
</div>

<div style="flex: 1 0 250px;border:1px solid #dfdfdf;padding:0 1em 1em 1.5em;background-color:#F7FAFC;margin:10px 0px 0px 10px;">
=== Data Integrations and API's ===
* [[Data Tables in QPR ProcessAnalyzer|Manage Data Tables]]
* [[Manage Scripts in QPR ProcessAnalyzer Excel Client|Scripting Manager]]
* [[Data Extraction, Transformation, and Loading|Introduction to ETL Scripting]]
* [[QPR ProcessAnalyzer Scripting Commands|Scripting Commands Reference]]
* [[QPR ProcessAnalyzer ScriptLauncher| ScriptLauncher]]
* [[QPR_ProcessAnalyzer_Model_JSON_Settings#Loading_Process_Mining_Data_from_ODBC_Datasource|Loading Models from ODBC Datasource]]
* [[QPR ProcessAnalyzer Web Service API|QPR ProcessAnalyzer Web Service API]]
* [[QPR ProcessAnalyzer ETL Tutorial | ETL Scripting Tutorial]]
* [[Sample Files for QPR ProcessAnalyzer]]
</div>
</div>

== For Administrators ==
QPR ProcessAnalyzer installation requires installing the QPR ProcessAnalyzer Server to IIS and two databases. It is recommended to install also QPR UI server to fully utilize the power of QPR ProcessAnalyzer. With QPR UI installed, QPR ProcessAnalyzer can be used via web browser for analyzing process models and analyzer users do not need any additional software installed on their workstations. Developer users need also to have QPR ProcessAnalyzer Excel client installed.

<div style="display: flex;flex-wrap: wrap;">
<div style="flex: 1 0 290px;border:1px solid #dfdfdf;padding:0 1em 1em 1.5em;background-color:#F7FAFC;margin:10px 0px 0px 10px;">
=== Planning Installation ===
* [[QPR ProcessAnalyzer System Requirements|System Requirements for QPR ProcessAnalyzer]]
* [[QPR ProcessAnalyzer Release Notes]]
* [[QPR_ProcessAnalyzer_Version_Compatibility|QPR ProcessAnalyzer Version Compatibility]]
* [[QPR Software Products Architecture|QPR Software Products Architecture]]
</div>

<div style="flex: 1 0 290px;border:1px solid #dfdfdf;padding:0 1em 1em 1.5em;background-color:#F7FAFC;margin:10px 0px 0px 10px;">
=== Installing ===
* [[Installing QPR ProcessAnalyzer Server|New Installation for QPR ProcessAnalyzer Server]]
* [[Installing_QPR_ProcessAnalyzer_Server#Setting_Up_Scripting_Sandbox|Setting Up Scripting Environment]]
* [[Installing_QPR_ProcessAnalyzer_Server#Updating_QPR_ProcessAnalyzer_Server_to_Newer_Version|Upgrading Existing QPR ProcessAnalyzer Server]]
* [[Installing_QPR_ProcessAnalyzer_Excel_Client|Installing QPR ProcessAnalyzer Excel Client]]
* [[Installing_SAP_Connector|Installing SAP Connector]]
* [[Installing_QPR_ProcessAnalyzer_ScriptLauncher|Installing QPR ProcessAnalyzer ScriptLauncher]]
* To install QPR UI, follow the [[QPR_UI_Wiki#Installation and Administration|QPR UI installation documentation]]
</div>

<div style="flex: 1 0 290px;border:1px solid #dfdfdf;padding:0 1em 1em 1.5em;background-color:#F7FAFC;margin:10px 0px 0px 10px;">

=== Configuring ===
* [[Web.config_file_in_QPR_ProcessAnalyzer|Web.config File Settings]]
* [[PA_Configuration_database_table_in_QPR_ProcessAnalyzer|PA_Configuration Database Table Settings]]
* [[Installing_QPR_ProcessAnalyzer_Server#IIS_Configuration|IIS Configuration]]
* [[LDAP/AD_Authentication_in_QPR_ProcessAnalyzer_Server|AD/LDAP Authentication]]
* [[QPR ProcessAnalyzer Model JSON Settings|Model Settings]]
</div>
</div>

== Agreements ==
See the [[QPR End User Software License Agreement]] and [[QPR Software as a Service Agreement]].

__NOTOC__

QPR ProcessAnalyzer System Requirements

2019-04-11T07:15:10Z

VesKivi: /* Recommended Hardware for QPR ProcessAnalyzer Pro Database Server */

__TOC__

== System Requirements for QPR ProcessAnalyzer Excel Client ==
System requirements for QPR ProcessAnalyzer Excel Client:
* Microsoft Windows 7, Windows 8.1 or Windows 10 operating system (64 bit version)
** Mac users need to use Windows in a pure virtual machine, created on e.g. [http://www.parallels.com/products/desktop/ Parallels Desktop], [http://www.vmware.com/products/fusion/overview.html VMware Fusion], or as a virtualized Boot Camp partition created by either one.
* Microsoft Office 2010, 2013, 2016 (32 bit and 64 bit versions) or 2019.
* Internet connection for connecting to QPR ProcessAnalyzer Service

The following components are also required and they will be installed if not found on your computer:
* Microsoft .NET Framework 4.6.1
* Microsoft Visual Studio Tools for Office Runtime

Additional requirement for using [[Data_Extraction,_Transformation,_and_Loading#--.23ImportSapQuery|ImportSapQuery]] script command: [[Installing QPR ProcessAnalyzer Excel Client#Installing_SAP_Connector_for_Microsoft_.NET_Version_3.0_Dll_Files|install the SAP Connector for Microsoft .NET Dll files]].

== Additional System Requirements for QPR ProcessAnalyzer Xpress ==
In addition to the requirements for QPR ProcessAnalyzer Excel Client, there are the following additional requirements for QPR ProcessAnalyzer Xpress:
* 64-bit Microsoft Windows 7, Windows 8.1 or Windows 10 operating system
* SQL Server LocalDB 2016 database
* Internet connection in order to [[Activating QPR ProcessAnalyzer|activate]] the product

== System Requirements for QPR ProcessAnalyzer Server ==
QPR ProcessAnalyzer Server is needed for QPR ProcessAnalyzer Pro. System requirements for QPR ProcessAnalyzer Server:
* Microsoft Windows Server 2008 R2, 2012 or 2016 operating system
* Microsoft SQL Server 2012, 2014, 2016 or 2017 database with Database Engine Services installed
* Sufficiently powerful enough hardware to run the operating system
* '''Microsoft .NET Framework 4.6.1''' is installed
* [[Installing_QPR_ProcessAnalyzer_Server#Install_Server_Roles_and_Features_for_Microsoft_Internet_Information_Services_(IIS) | Install Server Roles and Features for Microsoft Internet Information Services (IIS)]]

== System Requirements for QPR ProcessAnalyzer ScriptLauncher ==
* Microsoft Windows 7, Windows 8.1, Windows 10 or Windows Server 2012 R2 operating system. Mac users need to use Windows as a pure virtual machine, created on e.g. [http://www.parallels.com/products/desktop/ Parallels Desktop] or [http://www.vmware.com/products/fusion/overview.html VMware Fusion], or as a virtualized Boot Camp partition created by either one.
* Internet connection
* The sapnco.dll and sapnco_utils.dll files distributed in the [http://service.sap.com/connectors SAP Connector for Microsoft .NET Version 3.0 (requires SAP Service Marketplace credentials)] package are needed in order to use the [[Data_Extraction,_Transformation,_and_Loading#--.23ImportSapQuery|ImportSapQuery]] script command. See the [[Installing QPR ProcessAnalyzer Excel Client#Installing_QPR_ProcessAnalyzer_ScriptLauncher|instructions]] for installing them.
* Microsoft .NET Framework 4.6.1 or newer

== Recommended Hardware for QPR ProcessAnalyzer Pro Server ==

* '''Small''' datasets (up to 5 million events per model) with simultaneous users
** 32GB memory
** 4 processor cores
** 50GB disk
* '''Medium''' datasets (5-10 million events per model) with simultaneous users
** 64GB memory
** 8 processor cores
** 100GB disk
* '''Large''' datasets (10-50 million events per model) with simultaneous users
** 256GB memory
** 16 processor cores
** 150GB disk
* '''Very large''' datasets (more than 50 million events per model) with simultaneous users
** 512GB memory
** 32 processor cores
** 200GB disk

== Recommended Hardware for QPR ProcessAnalyzer Pro Database Server ==
Recommended hardware configuration for the server computer running Microsoft SQL Server database:
* 16GB memory
* 4 processor cores
* 300GB - 1TB available SSD disk for SQL Server temp database
* 500GB - 10TB available SSD disk for data storage on a disk dedicated to QPR ProcessAnalyzer

== Recommended Hardware for QPR ProcessAnalyzer Xpress Excel Client==
* 8GB memory
* 4 core processor
* 32GB disk

[[Category: QPR ProcessAnalyzer]]

Filtering in QPR ProcessAnalyzer Queries

2019-04-11T07:13:29Z

VesKivi:

QPR ProcessAnalyzer analyses can be ''filtered'' enabling to include only defined data to the analysis calculation. QPR ProcessAnalyzer analysis requests have parameter '''Filter''' which is used to pass a JSON formatted filter definition for the analysis. This filter definition is combined with the ''stored filter object'', which is provided as the '''FilterId''' parameter. Influence analyses have also parameter '''Comparison''' which divides the analyzed data into two parts to compare them in the analysis. Comparison parameter has the same JSON syntax as in the Filter parameter.

When performing analyses, different filter specifications are applied in the following order (from first to last):
# Filter rules defined by a stored filter (the '''FilterId''' parameter) (this is mandatory as it also defines the model to use)
# Filter rules defined in the '''Filter''' parameter
# Other filtering related parameters, such as '''SelectedActivities''' or '''SelectedTransitions'''

== Filter parameter JSON syntax ==
The filter definition has syntax demonstrated by the following example:

<pre>
{
Items: [
{
Type: "IncludeCases",
Items: [
{
Type: "EventType",
Values: ["Sales Order Created", "Payment Received"]
},
{
Type: "CaseAttributeValue",
Attribute: "Region",
Values: ["Dallas", "Austin"]
}
]
},
{
Type: "ExcludeCases",
Items: [
{
Type: "Case",
Values: ["Case1", "Case2", "Case3"]
},
{
Type: "flow",
Values: [
{
From: "Shipment",
To: "Invoice"
}
]
}
]
}
]
}
</pre>

The outmost JSON object has a property '''Items''' which is an array of object with following properties:
* '''Type''': Specifies the type of the filtering operation with following options:
** '''IncludeCases''': Include only cases. All filter rule types can be used with this option.
** '''ExcludeCases''': Exclude cases. All filter rule types can be used with this option.
** '''IncludeEventTypes''': Include only event types. Only [[Filtering_in_QPR_ProcessAnalyzer_Queries#Event_ type|Event type]] and [[Filtering_in_QPR_ProcessAnalyzer_Queries#Expression|Expression]] filter rule types can be used with this option.
** '''ExcludeEventTypes''': Exclude event types. Only [[Filtering_in_QPR_ProcessAnalyzer_Queries#Event_type|Event type]] and [[Filtering_in_QPR_ProcessAnalyzer_Queries#Expression|Expression]] filter rule types can be used with this option.
** '''IncludeCaseAttributes''': Include only given case attributes.
** '''ExcludeCaseAttributes''': Exclude given case attributes.
** '''IncludeEventAttributes''': Include only given event attributes.
** '''ExcludeEventAttributes''': Exclude given event attributes.
** '''Union''': Select objects that belong to union of all the given child selections.
** '''Intersection''': Select objects that belong to intersection of all the given child selections.
** '''Negate''': Negate the filtered objects of given type.
** '''ClearFilters''': Clear filter for given type of objects.
* '''Items''': Specifies selected model objects. It is used when the Type is '''IncludeCases''', '''ExcludeCases''', '''IncludeEventTypes''' or '''ExcludeEventTypes'''. The following chapter define all possibilities that can be used here.
* '''ChildItems''': Specifies the selections to be combined using a set operation. Applicable only when the Type is '''Union''' or '''Intersection'''.
* '''Attributes''': Specifies an array of attribute names. Applicable when the Type is '''IncludeCaseAttributes''', '''ExcludeCaseAttributes''', '''IncludeEventAttributes''' or '''IncludeEventAttributes'''.
* '''TargetObjectType''': Specifies the type of objects the operation is targeted to. Supported values are '''EventType''' and '''Case'''. It is applicable when the Type is '''ClearFilters''' or '''Negate'''.

The following chapters list all filter rule types that can be used in the above defined '''Items''' property.

== Filter Rule Types ==
=== Expression ===
Filter rule type '''ExpressionValue''' selects cases or event types that match the given expression. It has property '''Configuration''' which contains the following properties:
* '''Root''': Specifies the root expression to return QPR ProcessAnalyzer objects that are used to evaluate the ''Expressions'' (see below). If not defined, all the cases in the current event log are used as root objects. Allowed object types for the root expression for the Cases filter are '''Case''', '''Event''', '''EventType''', '''Flow''', '''FlowOccurrence''' and '''Variation'''. For the EventTypes filter, only EventsType objects are valid.
* '''Expressions''': An array of expressions specifying the filter rules. The is an AND logic between the filter rules, so all expressions need to match for the objects to come to the filter. In the CAses filter, the resulting matched objects are converted to Cases to get the actual filtered Cases. If not defined, all the objects returned from the ''Root expression'' will be selected to the filter. Properties:
** '''Expression''': Expression that is evaluated for the root objects.
** '''Values''': An array of values to match to the expression result.
* '''Variables''': An object specifying key-value pairs, where each key-value pair generates one variable into the expression language where key is the name of the variable and value is its value. The values will be converted to strings.

Examples:
<pre>
{
Type: "ExpressionValue",
Configuration: {
Root: "Cases",
Expressions: [
{
Expression: "Name",
Values: ["case1", "case2"]
}
]
}
}

Select cases named "case1" and "case2".

{
Type: "ExpressionValue",
Configuration: {
Root: "Cases.Where(Duration.TotalDays > 1)"
}
}
Selects cases whose duration is longer than one day.

{
Type: "ExpressionValue",
Configuration: {
Variables: {
bpmnXml: "<XML BPMN model>"
},
Root: "Let(\"myConformanceModel\", ConformanceModelFromXml(bpmnXml));Cases.Where(IsConformant(myConformanceModel));"
}
}

Returns all cases that are conformant with the specified BPNM model.
</pre>

=== Case names ===
Filter rule type '''Case''' selects individual cases. It supports property '''Values''' which is an array of case names (strings).

Example:
<pre>
{
Type: "Case",
Values: ["case1", "case2", "case3"]
}
</pre>

Same example in the whole JSON configuration:
<pre>
{
Items: [
{
Type: "IncludeCases",
Items: [
{
Type: "Case",
Values: ["case1", "case2", "case3"]
}
]
}
]
}
</pre>

=== Case attribute values ===
Filter rule type '''CaseAttributeValue''' selects cases having given value in given case attribute. Properties:
* '''Attribute''': Case attribute name.
* '''Values''': Array of case attribute values in string format.

Example:
<pre>
{
Type: "CaseAttributeValue",
Attribute: "Region",
Values: ["Dallas", "Austin", "New York"]
}
</pre>

=== Event attribute values ===
Filter rule type '''EventAttributeValue''' selects cases having events with given event attribute values. Properties:
* '''Attribute''': Name of the event attribute.
* '''Values''': An array of event attribute values in string format.

Example:
<pre>
{
Type: "EventAttributeValue",
Attribute: "Organization",
Values: ["Organization 1", "Organization 2"]
}
</pre>

=== Event type ===
Filter rule type '''EventType''' selects cases containing selected event types (Type=IncludeCases/ExcludeCases) or selects event types (Type=IncludeEventTypes/ExcludeEventTypes). It has property '''Values''' which is an array of event type names.

Example:
<pre>
{
Type: "EventType",
Values: ["Sales Order Created", "Payment Received", "Delivery Sent"]
}
</pre>

=== Variation ===
Filter rule type '''Variation''' selects cases belonging to selected variations. It has the property '''Paths''' which is an array of variations. Each variation is a string array of event type names in the variation.

Example:
<pre>
{
Type: "Variation",
Paths: [
["Activity 1", "Activity 2", "Activity 3"],
["Activity 3"],
["Activity 2", "Activity 4"]
]
}
</pre>

=== Flow ===
Filter rule type '''Flow''' selects cases having the defined flows. It has property '''Flows''' which selects an array of objects with following properties:
* '''From''': Event type name which starts the flow.
* '''To''': Event type name into which the flow goes.
* '''Occurrence''': Zero-based occurrence index of the selected flow within its case. If not specified, represents all occurrences.

Example:
<pre>
{
Type: "Flow",
Flows: [ {From: "EventType1", To: "EventType2", "Occurrence": 1} ]
}
</pre>

== [[Legacy Filter Rules in QPR ProcessAnalyzer Queries]] ==

== Examples ==
<pre>
{
Items: [
{
Type: "Union",
ChildItems: [
{
Items: [
{
Type: "IncludeCases",
Items: [
{
Type: "Case",
Values: ["c1", "c3"]
}
]
}
]
},
{
Items: [
{
Type: "IncludeCases",
Items: [
{
Type: "Case",
Values: ["c1"]
}
]
},
{
Type: "Negate",
TargetObjectType: "Case"
}
]
}
]
}
]
}
</pre>

Case Level Permissions

2019-03-07T13:30:45Z

VesKivi: /* ODBC Driver Installation */

Each QPR ProcessAnalyzer model has a '''[[Project_Workspace_in_QPR_ProcessAnalyzer_Excel_Client#Model_Properties|Configuration]]''' field containing model related settings in a JSON format. Those settings are documented in this page. When the model JSON configuration is changed, the model is dropped from the memory.

== Memory Usage Settings ==
The memory usage settings are used to manage, how long objects are kept in the memory, which affect both the memory usage and performance. The longer the object storing durations, the more memory is consumed, but on the other hand users perceive better performance as analyses are more likely to be found in the memory already calculated. Memory usage settings can be defined in the [[Web.config_file_in_QPR_ProcessAnalyzer#Qpr.ProcessAnalyzer.Common.Properties.Settings_Section|web.config]] file and for each model separately in the model settings.

{| class="wikitable"
!'''Property'''
! '''Description'''
|-
||
CacheUsage/
DropUnusedModelsAfter
||
Duration after which the unused model, is dropped from the memory. Defined in format ''HH:mm:ss'' or ''d.HH:mm:ss'', for example 01:00:00 (one hour), 00:30:00 (30 minutes) or 1.00:00:00 (24 hours). When an analysis is requested for a model, the model's last used time is updated (also filter's last used time is updated).

If this setting is not defined, the server level [[Web.config_file_in_QPR_ProcessAnalyzer#Qpr.ProcessAnalyzer.Common.Properties.Settings_Section|default setting]] is used.
|-
||
CacheUsage/
DropUnusedFiltersAfter
||
Duration after which the model's unused filters, are dropped from the memory. Defined in format ''HH:mm:ss'' or ''d.HH:mm:ss'', for example 01:00:00 (one hour), 00:30:00 (30 minutes) or 1.00:00:00 (24 hours). When an analysis is requested for a filter , the filter's last used time is updated (also model's last used time is updated).

If this setting is not defined, the server level [[Web.config_file_in_QPR_ProcessAnalyzer#Qpr.ProcessAnalyzer.Common.Properties.Settings_Section|default setting]] is used.
|}

===Configuration Examples===
The following configuration keeps the model in memory for 1 hour and filters for 30 minutes.
<pre>
{
"CacheUsage": {
"DropUnusedModelsAfter": "1:00:00",
"DropUnusedFiltersAfter": "00:30:00"
}
}
</pre>

The following configuration keeps the model in memory for 15 minutes and filters for 5 minutes.
<pre>
{
"CacheUsage": {
"DropUnusedModelsAfter": "0:15:00",
"DropUnusedFiltersAfter": "00:05:00"
}
}
</pre>

The following configuration keeps the model in memory for 100 days (practically it's never dropped) and filters for 2 hours.
<pre>
{
"CacheUsage": {
"DropUnusedModelsAfter": "100.00:00:00",
"DropUnusedFiltersAfter": "02:00:00"
}
}
</pre>

===Memory Objects Summary===
Data handled by QPR ProcessAnalyzer memory is stored in following types of objects:
{| class="wikitable"
!'''Stored Objects'''
! '''Contents'''
! '''Unused objects dropped after'''
! '''Time to reload/calculate'''
! '''Memory consumption'''
|-
||Models
||Models objects contain all data in a QPR ProcessAnalyzer model, such as
* cases
* events
* variations
* event types
* flows
* flow occurrences
||Primarily defined by a model setting ''CacheUsage/DropUnusedModelsAfter''. If the model setting is not defined, the server level setting in the web.config file is used. If the server setting is not defined either, a default value of 1 hour is used. When the is a memory shortage in the server, models are not dropped from the memory.
||'''Slow'''

Models are loaded from the database requiring to transfer considerable amount of data, which takes much more time than e.g. calculating filters and analyses.
||'''High'''
|-
||Filters
||Filters contain all filtered data in QPR ProcessAnalyzer model, which includes similar data and structures as the models.
||Primarily defined by a model setting. If the model setting is not defined, the server setting is used. If the server setting is not defined, a default value of 30 minutes is used. When the is a memory shortage in the server, filters may be dropped from the memory to free memory.
||'''Fast'''

Filters are calculated from the model data that already exists in the memory. Practically, filters are subsets of models.
||'''Medium'''
|-
||Analysis results
||Results of the analysis (in tabular form).
||Unused analysis results are kept maximum of 15 minutes in the memory. When the is a memory shortage in the server, analysis results may be dropped from the memory to free memory.
||'''Fast'''

Analysis results are calculated from filters, which already exist in memory.
||'''Low'''
|}

If the QPR ProcessAnalyzer server doesn't have enough memory to store more objects, already stored objects are dropped from the memory starting from the one having the longest time from the last usage. Thus, when there is a short of memory, objects may be dropped earlier than their settings define. Only filters and analysis results are dropped during the memory shortage, i.e. model objects are not dropped prematurely. This is because recalculating filters and analysis results is usually faster than loading models from the database. That's why, when trying to load more models than there is available memory in the server, an out of memory error situation may occur.

== Model Automatic Loading on Server Startup ==
QPR ProcessAnalyzer models can be loaded automatically, when QPR ProcessAnalyzer Server starts. When the model loading takes long time, it's useful to load it automatically beforehand. In the model JSON settings, when the '''LoadOnStartup''' property is set to ''true'', the model is loaded automatically during QPR ProcessAnalyzer Server startup. The JSON configuration is as follows:
<pre>
{
"LoadOnStartup": true,
"CacheUsage": {
"DropUnusedModelsAfter": "100.00:00:00",
"DropUnusedFiltersAfter": "00:30:00"
}
}
</pre>

Note: For models that are set to load automatically on server startup, you also need to set the ''CacheUsage/DropUnusedModelsAfter'' setting is large value (as shown by the previous example), so that the model is not dropped from memory even if it's not used.

Note that ''LoadOnStartup'' setting to work, [[Installing_QPR_ProcessAnalyzer_Server#IIS_Configuration|IIS configurations]] related to QPR ProcessAnalyzer Server installation needs to be in place.

== Loading Process Mining Data from ODBC Datasource ==
The '''DataSource''' section is used to define where the QPR ProcessAnalyzer model data is loaded. See below examples, how to construct the full JSON.
{| class="wikitable"
!'''Property'''
! '''Description'''
|-
||DataSource/Cases/DataSourceType
||Datasource type to use, when fetching the Cases data. Currently the only supported value is '''odbc'''.
|-
||DataSource/Cases/OdbcConnectionString
||ODBC connection string to use to fetch the Cases data. Connection strings can be found in https://www.connectionstrings.com.
|-
||DataSource/Cases/OdbcQuery
||ODBC query to use to fetch the Cases data. Query syntax depends on the source system where the data is fetched.
|-
||DataSource/Cases/Columns
||Column name mappings for QPR ProcessAnalyzer data model. Only supported mapping is '''CaseId''' defining the case id (case name). Example:
<pre>
{
"CaseId": "SalesOrderHeaderId"
}
</pre>
All unmapped columns are taken to the model as case attributes. If the fetched data doesn't contain a mapped column, the model loading fails and an error message is given.
|-
||DataSource/Events/DataSourceType
||Datasource type to use, when fetching the Events data. Currently the only supported value is '''odbc'''.
|-
||DataSource/Events/OdbcConnectionString
||ODBC connection string to use to fetch the Events data. Connection strings can be found in https://www.connectionstrings.com.
|-
||DataSource/Events/OdbcQuery
||ODBC query to use to fetch the Events data. Query syntax depends on the source system where the data is fetched.
|-
||DataSource/Events/Columns
||
Column name mappings for QPR ProcessAnalyzer data model. Supported mappings for Events are '''CaseId''', '''EventType''' and '''Timestamp'''. Example:
<pre>
{
"CaseId": "SalesOrderHeaderId",
"EventType": "EventType",
"Timestamp": "CreatedDate"
}
</pre>
All unmapped columns are taken to the model as event attributes. If the fetched data doesn't contain a mapped column, the model loading fails and an error message is given.
|}

=== Configurations examples ===

==== ODBC Driver Installation ====
'''Microsoft Access Database Engine 2016 Redistributable''' is software package that contains ODBC drivers for
* Microsoft SQL Server
* Microsoft Access (*.mdb and *.accdb) files
* Microsoft Excel (*.xls, *.xlsx, and *.xlsb) files
* CSV text files

The package needs to be installed in the same computer where the QPR ProcessAnalyzer Server is running. Installation instructions:
# Go to https://www.microsoft.com/en-us/download/details.aspx?id=54920 and click Download.
# Select whether to use the 32bit or 64bit (x64) version (usually it's the 64bit version).
# Double-click the executable file on your hard disk to start the setup program.
# Follow the instructions on the screen to complete the installation.

If 32-bit office is installed in machine then 64-bit ODBC driver need install using /passive parameter.
More information
* ht tps://stackoverflow.com/questions/7116019/hand-install-of-64-bit-ms-access-odbc-drivers-when-32-bit-office-is-present
* ht tps://techblog.aimms.com/2014/10/27/installing-32-bit-and-64-bit-microsoft-access-drivers-next-to-each-other/

==== Read data from CSV file ====
In this example, data is loaded from CSV files located in the file system using ''Microsoft Access Text Driver (*.txt, *.csv)'' driver. Loaded files are C:\ProcessMiningData\ModelCaseAttributes.csv and C:\ProcessMiningData\ModelEventData.csv.
<pre>
{
"DataSource": {
"Cases": {
"DataSourceType": "odbc",
"OdbcConnectionString": "Driver={Microsoft Access Text Driver (*.txt, *.csv)};DefaultDir=C:\\ProcessMiningData\\;Extensions=asc,csv,tab,txt",
"OdbcQuery": "SELECT * FROM [ModelCaseAttributes.csv]",
"Columns": {
"CaseId": "Name"
}
},
"Events": {
"DataSourceType": "odbc",
"OdbcConnectionString": "Driver={Microsoft Access Text Driver (*.txt, *.csv)};DefaultDir=C:\\ProcessMiningData\\;Extensions=asc,csv,tab,txt",
"OdbcQuery": "SELECT * FROM [ModelEventData.csv]",
"Columns": {
"CaseId": "Case",
"EventType": "Event Type",
"Timestamp": "Start Time"
}
}
}
}
</pre>

When reading from CSV files, you may need to set the CSV file format for the ODBC driver using the '''Schema.ini''' file (more information: https://docs.microsoft.com/en-us/sql/odbc/microsoft/schema-ini-file-text-file-driver?view=sql-server-2017).

==== Read data from Excel file ====
In this example, data is loaded from a Excel file that is accessible in the file system. In this example, the loaded file is C:\ProcessMiningData\ModelData.xlsx and cases are in sheet ''MyCases'' and events in sheet ''MyEvents''.

<pre>
{
"DataSource": {
"Cases": {
"DataSourceType": "odbc",
"OdbcConnectionString": "Driver={Microsoft Excel Driver (*.xls, *.xlsx, *.xlsm, *.xlsb)};DBQ=C:\\ProcessMiningData\\ModelData.xlsx",
"OdbcQuery": "SELECT * FROM [MyCases$]",
"Columns": {
"CaseId": "Case ID"
}
},
"Events": {
"DataSourceType": "odbc",
"OdbcConnectionString": "Driver={Microsoft Excel Driver (*.xls, *.xlsx, *.xlsm, *.xlsb)};DBQ=C:\\ProcessMiningData\\ModelData.xlsx",
"OdbcQuery": "SELECT * FROM [MyEvents$]",
"Columns": {
"CaseId": "Case ID",
"EventType": "Activity",
"Timestamp": "Start Time"
}
}
}
}
</pre>

==== Read data from SQL Server table ====
Recommended driver: https://www.microsoft.com/en-us/download/details.aspx?id=56567

In this example, data is loaded from an SQL Server table. SQL Server hostname is ''myServerName'', instance name is ''myInstanceName'' and database name is ''MyDatabase''. The ''Trusted_Connection'' is for Windows authentication.

<pre>
{
"DataSource": {
"Cases": {
"DataSourceType": "odbc",
"OdbcConnectionString": "Driver={ODBC Driver 17 for SQL Server};Server=myServerName\myInstanceName;DataBase=MyDatabase;Trusted_Connection=Yes;",
"OdbcQuery": "SELECT CASENAME, COST, COUNTRY, PRODUCT FROM CASES_TABLE",
"Columns": {
"CaseId": "CASENAME"
}
},
"Events": {
"DataSourceType": "odbc",
"OdbcConnectionString": "Driver={ODBC Driver 17 for SQL Server};Server=myServerName\myInstanceName;DataBase=MyDatabase;Trusted_Connection=Yes;",
"OdbcQuery": "SELECT CASENAME, CREATED_DATE, CREATED_BY FROM EVENTS_TABLE",
"Columns": {
"CaseId": "CASENAME",
"Timestamp": "CREATED_DATE",
"EventType": "CREATED_BY"
}
}
}
}
</pre>

If SQL Server authentication is used, the connection string is
<pre>
Driver={ODBC Driver 17 for SQL Server};Server=myServerName\myInstanceName;DataBase=MyDatabase;Trusted_Connection=No;Uid=myUsername;PWD=myPassword;
</pre>

More about SQL Server connection strings: https://www.connectionstrings.com/sql-server/

=== Troubleshooting ===

The following error message may be encountered: ''System.Data.Odbc.OdbcException (0x80131937): ERROR [IM002] [Microsoft][ODBC Driver Manager] Data source name not found and no default driver specified''. Probable reason is that the ODBC driver is missing or driver name is not correct. To solve the issue:
* Check ODBC drivers is installed by running '''C:\Windows\System32\odbcad32.exe'''.
* Check the connection string.

The following error message may be encountered: '''ERROR [HY024] [Microsoft][ODBC Text Driver] '(unknown)' is not a valid path. Make sure that the path name is spelled correctly and that you are connected to the server on which the file resides.'''.
Example error when specified directory is missing:

Error when CSV file is missing: '''System.Data.Odbc.OdbcException (0x80131937): ERROR [42S02] [Microsoft][ODBC Text Driver] The Microsoft Access database engine could not find the object 'CaseAttributes.csv'. Make sure the object exists and that you spell its name and the path name correctly. If 'CaseAttributes.csv' is not a local object, check your network connection or contact the server administrator.'''

Error codes for troubleshooting: [https://docs.microsoft.com/en-us/sql/odbc/reference/appendixes/appendix-a-odbc-error-codes?view=sql-server-2017| ODBC Error Codes].

If the error message mention about Case or Event attributes named as ''F<column number>'' (e.g. F10), the data might be inconsistent, as there might be different amount of columns in different rows.

== Case Permissions ==
The '''Permissions''' section specifies data security restrictions for objects within the QPR ProcessAnalyzer model (i.e. limit visibility). If the Permissions section hasn't been defined, all the model data is visible to all users having '''GenericRead''' permission for the project in which the model resides ([[User Roles and Permissions in QPR ProcessAnalyzer|more information about roles and permissions]]). Permissions defined in this section, are only available when using the [[Installing QPR ProcessAnalyzer Server#Configure_Web_Service_to_use_In-Memory_or_In-Database_processing|In-Memory core]].

{| class="wikitable"
!'''Property'''
! '''Description'''
|-
|Permissions/Initialization
|[[QPR_ProcessAnalyzer_Expressions|Expression language]] expression used to make an initial calculation for all the other expressions within this same permissions context. This expression can be used to improve performance when part of the Case or EventLogKey expressions are common and thus they don't need to be calculated again for every Case separately. See the examples below of using the Initialization expression.
|-
||Permissions/Case
||[[QPR_ProcessAnalyzer_Expressions|Expression language]] expression determining which users can see each Cases. The expression is evaluated within the context of each Case. If the evaluation results '''true''', the Case is visible for the user. Otherwise the Case, its Events and case and event attributes are not visible. This setting implements case level security restrictions.
|-
||Permissions/EventLogKey
||[[QPR_ProcessAnalyzer_Expressions|Expression language]] expression used to uniquely identify all the unique event logs created by case permission filters. If a cached EventLog with the same key is already in the system, that EventLog is used instead of creating a new. The new EventLog is created by applying the Case expression to filter the Cases users have rights to.
|}

=== Example usecase for case permissions ===
Case level permissions (security control) can be implemented with the principle illustrated in the image below. ''Users'' already belong to certain ''groups'' in the user management, and ''cases'' have certain ''case attribute values'' which is part of the loaded process mining data. Additionally, the linkage between case attribute values (of a certain case attribute) and groups needs to be defined when this security feature is configured. The image below illustrates the chain between ''users'' and ''cases'', how certain users are able to see certain cases when viewing analyses from a QPR ProcessAnalyzer model.

[[File:CasePermissions.png|800px]]

Example: There are groups G1, G2 and G3. Case permissions have been set as follows:
* group G1 can only see cases where (case attribute) Region is Dallas
* group G2 can only see cases where Region is Austin
* group G3 can only see cases where Region is either Austin or New York

QPR ProcessAnalyzer model contains the following cases:
{| class="wikitable"
! Case name
! Region (case attribute)
! Groups can see
|-
|A
|Dallas
|G1
|-
|B
|Dallas
|G1
|-
|C
|Austin
|G2, G3
|-
|D
|New York
|G3
|-
|E
|New York
|G3
|-
|F
|New York
|G3
|}

Thus, when viewing analyses, a user see that the model contains the following cases:
* If the user belongs to group G1 only, the user can see cases A and B (2 cases)
* If the user belongs to group G2 only, the user can see case C (1 case)
* If the user belongs to group G3 only, the user can see cases C, D, E and F (4 cases)
* If the user belongs to groups G1 and G2 only, the user can see cases A, B and C (3 cases)

There is no way for a user to be aware of the existence of cases that the user doesn't have rights to.

=== Configuration examples for case permissions ===
In this example, visibility of cases is limited in a way that only those users can see the cases belonging to a user group which name is same as the Region (case attribute).
<pre>
{
"Permissions": {
"Initialization": "Let(\"groupNames\", OrderByValue(CurrentUser.GroupNames))",
"Case": "Region.In(groupNames)",
"EventLogKey": "StringJoin(\"_\", groupNames)"
}
}
</pre>

In this example, cases are only visible for users whose user name is same as the Account Manager (case attribute).
<pre>
{
"Permissions": {
"Initialization": "Let(\"userName\", CurrentUser.Name)",
"Case": "(Attribute(\"Account Manager\") == userName)",
"EventLogKey": "CurrentUser.Id"
}
}
</pre>

In this example, cases having "Region" case attribute of "Dallas" will only be visible for users belonging to user group "GroupA" (and "New York" for group "GroupB").
<pre>
{
"Permissions": {
"Initialization": "Let(\"groupNames\", CurrentUser.GroupNames)",
"Case": "(Region == \"Dallas\" && \"GroupA\".In(groupNames)) || (Region == \"New York\" && \"GroupB\".In(groupNames))",
"EventLogKey": "If(\"GroupA\".In(groupNames), \"_A\", \"_\") + If(\"GroupB\".In(groupNames), \"_B\", \"_\")"
}
}
</pre>

QPR ProcessAnalyzer Release Notes

2019-02-14T09:22:18Z

VesKivi: /* Additional Release for QPR ProcessAnalyzer 2019.1 (release date 2019-01-23) */

This page contains new features and fixed issues for each QPR ProcessAnalyzer release. For information on the compatibility of different versions, see [[QPR ProcessAnalyzer Version Compatibility|Version Compatibility Information]]. See also [[Planned Releases for QPR ProcessAnalyzer and QPR UI|next planned releases]].

== Next Release: QPR ProcessAnalyzer 2019.2 (release date 2019-02-14) ==
Build number: 2019.2.0.38539, Model compatibility version: 2, Database version: 58, Stream version: 7.

'''Release Highlights''':
* Support for [[QPR_ProcessAnalyzer_System_Requirements#System_Requirements_for_QPR_ProcessAnalyzer_Excel_Client| Microsoft Office 2019]] for QPR ProcessAnalyzer Excel Client.

'''Features for QPR ProcessAnalyzer Server:'''
* 307423: Improved memory management: unused objects are automatically dropped from the memory. Settings can be configured in [[Web.config_file_in_QPR_ProcessAnalyzer#Qpr.ProcessAnalyzer.Common.Properties.Settings_Section | web.config]] or from the [[QPR_ProcessAnalyzer_Model_JSON_Settings#Memory_Usage_Settings | model JSON settings]].

'''Fixed bugs in QPR ProcessAnalyzer UI:'''
* 218838: KPI analysis: Event Occurrence Time isn't calculated properly, e.g. Period=Month fails.

'''Fixed bugs in QPR ProcessAnalyzer Server:'''
* 218880: PAPO: odbc case and event attributes are not shown in dropdown menu.
* 218877: Support material - Project admins are not able to create new users.
* 218898: Importing XES file with xmlns -definition fails.
* 218893: Model status shows incorrectly "offline" when Model event log is in memory and Model information not.
* 218917: BaseContext.EvaluateChildExpression with given root object iterates the root object if it is an array.

== Additional Release for QPR ProcessAnalyzer 2019.1 (release date 2019-01-23) ==
Build number: 2019.1.0.38400, Model compatibility version: 2, Database version: 58, Stream version: 7.

'''Features for QPR ProcessAnalyzer Server:'''

* 307357: PA model management: Analysis requests canceling. All operations have new parameters QueryIdentifier and CancelEarlierQueriesWithIdentifier.

'''Fixed bugs in QPR ProcessAnalyzer Server:'''
* 218806: Variation filter doesn't filter correctly.
* 218802: It should not be able to load deleted models into memory.
* 218866: Case Analysis shows "0" for textual Case Attribute (SelectedActivityCounts=0 column count and data not match).
* 218862: Case Analysis returns incorrect Start and End times when start or end transition is selected.
* 218847: Variation Analysis Include Only Cases Filter Fails when using Event Counts and filter.
* 218765: Event Occurrence Time calculation for KPI analysis (Server side).

== QPR ProcessAnalyzer 2019.1 (release date 2019-01-03) ==
Build number: 2019.1.0.38310, Model compatibility version: 2, Database version: 58, Stream version: 7.

'''Release Highlights''':
* There are new training videos available for QPR ProcessAnalyzer in QPR Community. QPR ProcessAnalyzer users can access the videos by clicking Training Videos in the header menu of QPR ProcessAnalyzer UI.
* ChartView can show several measures at the same time. In table, measures are in different columns, and in chart, measures are presented as different series.

'''Fixed bugs for QPR ProcessAnalyzer UI:'''
* 218768: Number of decimals is not updated in KPI analysis due to HistoryId context variable.
* 218787: Datagrid export fails with numerical values.
* 218757: KPI analysis - null value shown as NaN.0 in table.
* 218794: Popup menu is replicated when PAPO is drawn multiple times.
* 218740: Case Analysis Year period should not show thousand separator.
* 218805: Analysis not shown after adding duration analysis to panel using view designer "shortcuts buttons".
* 218804: PAPO showing only Analysis Window doesn't show anything when other PAPO hides the Analysis window.
* 218815: Flowchart influence analysis does not always show the results in an identical way.
* 218791: Flowcharts visibility stepper don't work in PA deployment package Process benchmarking view.
* 218844: KPI Analysis sorting is not saved to the context variable.

'''Fixed bugs in QPR ProcessAnalyzer Server:'''
* 218755: If user selects Influence Analysis for Case Attributes into analysis window, it freezes the analysis window completely.
* 218756: PA model - with event attributes - without case attributes = event attributes shown in profiling case attributes analysis.

== QPR ProcessAnalyzer 2018.8 (release date 2018-11-29) ==
Build number: 2018.8.0.38236, Model compatibility version: 2, Database version: 58, Stream version: 7.

'''Release Highlights''':
* New types of charts have been added to the KPI Analysis in PAPO. In addition to the previously available column chart and table presentations, there are now bar, donut, area, line and spline charts.
* Tool palette contains now items for each QPR ProcessAnalyzer analysis making it easier to create dashboards with different analyses. The analyses have also needed context variables predefined so that settings are saved to the dashboard.
* Duration Influence Analysis is now calculated in the memory which makes it significantly faster than previously when it was calculated in the SQL Server.

'''Features for QPR ProcessAnalyzer UI:'''
* 307398: [[KPI_Analysis_(PAPO)#Settings |More chart types to KPI analysis]], such as line chart, bar chart and donut chart.
* 307473: PAPO tables exporting to Excel, Word and PDF

'''Features for QPR ProcessAnalyzer Server:'''
* 307417: Duration Influence Analysis in In-Memory.
* 307458: Performance improvement in reusing event logs.
* 307456: Expression language plugin mechanism.
* 307459: [[QPR_ProcessAnalyzer_Web_Service_API#Functions_in_the_Web_Service_API|PA service support for script generated reports as csv file (for QPR UI Script Manager)]].

'''Fixed bugs in QPR ProcessAnalyzer UI:'''
* 218711: PAPO duration analysis is failing.
* 218663: PAPO - KPI Analysis - Number of decimals effects column height.
* 218664: PAPO - KPI Analysis - Default number of decimals in the drop-down list should be 1.
* 218669: PAPO - KPI Analysis duration from - to.
* 218557: PAPO - Duplicate flows when increasing the flow amounts in flowchart.
* 218718: PAPO - Flowchart sometimes shows portions of the flowchart completely unconnected from start/end nodes of the flowchart.
* 218668: PAPO - KPI Analysis - wrong names in droplist and wrong chart title.
* 218666: PAPO - KPI Analysis - CamelCase column headers.
* 218670: PAPO - KPI Analysis - title Duration between "undefined" and "undefined".
* 218665: PAPO - KPI Analysis - numerical data should be shown linear on X axis.
* 218629: PAPO - KPI Analysis - Year period should not show thousand separator.
* 218667: PAPO - KPI Analysis - units are missing in table.
* 218725: PAPO - KPI Analysis - NumberOfDecimals should be enabled for numerical case&event attribute.
* 218731: PAPO - layout issue when displaying error message.
* 218747: PAPO - KPI analysis - Column header text is not consistent with x-axis label.
* 218762: PAPO - KPI Analysis - Error message doesn't disappear when switching from wrong selections to correct ones.

'''Fixed bugs in QPR ProcessAnalyzer Server:'''
* 218727: Null values don't work in GroupBy/GroupByValue functions.
* 218708: Filtering with duration value 0 does not work in duration analysis.
* 218770: Case analysis with variation Id -> Exception: The given key was not present in the dictionary.
* 218771: Conformance: Parallel gateways having multiple branches with only one node aren't analyzed correctly.

== QPR ProcessAnalyzer 2018.7 (release date 2018-10-10) ==
Build number: 2018.7.0.38036, Model compatibility version: 2, Database version: 58, Stream version: 7.

'''Features for QPR ProcessAnalyzer Server:'''
* 307319: Expression language: [[Generic_Properties_and_Functions_in_QPR_ProcessAnalyzer_Expressions#Other_functions | GroupBy and GroupByValue -functions]].
* 307370: PAPO/A1 cell case/event/event type/variation count should only show cases user has permissions in case level security.
* 307369: String handling functions in the expression language.
* 307424: KPI analysis in generic context.
* 307439: Quick & easy expression language improvements.
* 307336: PA performance improvement (part 1).

'''Fixed bugs in QPR ProcessAnalyzer UI:'''
* 218673: Null values in PA expression language should appear as nulls in datasets.
* 218693: Performance for PAPO's data grids has been optimized.

'''Fixed bugs in QPR ProcessAnalyzer Server:'''
* 218453: .TMP files is not deleted always. After 65k .TMP files exist then PA service stop working. If issue is encountered, workaround is to manually delete .TMP files (e.g. files are located in folder C:\Windows\Temp or C:\Users\<pa_applicationpool_user>\AppData\Local\Temp).
* 218643: InMemory: Open model after pacm file import fails to "Object reference not set to an instance of an object.".
* 218652: Access denied. Unexpected ModelEventLog dropping object with from cache.
* 218648: Import empty model with filter crash (evevenlog.Content is null).
* 218685: XES import runs out of memory when importing BPIC2018 -model.
* 218690: Expressions returning boolean values should be returned to QPR UI as booleans.
* 218687: Average and Sum functions should return null for zero length arrays instead of zero.
* 218705: InMemoryCore: TotalCost in event analysis has incorrect values.
* 218704: Mismatch in case counts in Variation Analysis when event type filter has been applied.
* 218709: FileType parameter not select correct stream compression mode in ImportFromStream.
* 218698: The given key was not present in the dictionary - Variation Analysis error.
* 218710: PAPO case analysis is currently failing.

== QPR ProcessAnalyzer 2018.6 (release date 2018-08-29) ==
Build number: 2018.6.0.37869, Model compatibility version: 2, Database version: 58, Stream version: 7.

'''Release Highlights'''
* KPI Analysis update: The KPI Analysis feature has new updates to it. The Analysis Menu design has new options that allow for efficient creation of KPI analysis presentations. Menu items have been grouped into sub-groups making finding analysis options much swifter.
* Model load on startup: You can now define which models are loaded onto memory on startup allowing for quicker setup of QPR ProcessAnalyzer servers. This loads the key models needed directly into memory without any separate in-memory loading.

'''Features for QPR ProcessAnalyzer UI:'''
* 307351: KPI analysis UI - part 2

'''Features for QPR ProcessAnalyzer Server:'''
* 307323: [[PA Migration to 2018.6 |Remove old PA web client]].
* 307200: [[QPR_ProcessAnalyzer_Model_JSON_Settings#Necessary_IIS_setup |PA model management: PA model automatic loading on startup]].
* 307350: KPI analysis UI - part 2 (server side).
* 307208: PA model management: PA model status information to expression language.

'''Fixed bugs in QPR ProcessAnalyzer UI:'''
* 218391: PA UI Flowchart selection does not clear automatically.
* 218606: Edit mode is ON > Floating Action Buttons are not clickable.
* 218626: PAPO: some popup menus are not closed properly in IE 11.
* 218607: PAPO: popup menu is not displayed in IE 11.

'''Fixed bugs in QPR ProcessAnalyzer Server:'''
* 218597: PA Exception details show null in QPR UI.
* 218575: Incorrect results in conformance analysis calculation.
* 218540: KPI analysis not working properly.
* 218314: Variation analysis shows duplicate variations if there are excluded event types.
* 218604: PA Excel client does not log enough during connection creation.
* 218624: Estimatedmemory not calculated correctly when model not have events.
* 218396: KPI analysis - ApplyAnalysisFilters. InvalidOperationException: Sequence contains no elements.´
* 218628: PAPO: Error popup appears, "Error processing QPR ProcessAnalyzer request.
* 218631: Performance improvements (Path analysis was slow).
* 218485: ProcessAnalyzer Excel client cannot be removed from Programs and Features, as it wont show up there.
* 217775: GetAnalysis(18) should write a progress log entry after each chunk.
* 217653: SQL command not in log when ODBC connection failed.

== QPR ProcessAnalyzer 2018.5 (release date 2018-07-17) ==
Build number: 2018.5.0.37716, Model compatibility version: 2, Database version: 58, Stream version: 7.

'''Release Highlights'''
*QPR ProcessAnalyzer Deployment Package for QPR UI: The new version comes with preloaded QPR UI views that can instantly kickstart your Process Mining experience. These views are readymade and require no extra configuration. These views introduce new functionalities, such as ready made conformance views, for deploying a more varied Process Mining offering.
*New Dashboard Design features: Panels can be now instantly developed and evaluated in viewer mode, allowing for a more powerful dashboard creation. The object placing logic has been overhauled, allowing for new options in creating dashboards.

'''Features for QPR ProcessAnalyzer Server:'''
* 307338: [[QPR_ProcessAnalyzer_API:_ResetModelCache | Web service support to load and drop PA models]].

'''Fixed bugs in QPR ProcessAnalyzer UI:'''
* 218536: PAPO: KPI Analysis should not be available from Control Windows.
* 218519: The numerical values in QPR ProcessAnalyzer Influence Analysis were aligned to the left.
* 217888: Selection lost from influence analysis table when user slightly adjusts browser window or panel/presentation object window size.
* 218465: PAPO: Newly created filters are not displayed in the list.
* 218556: PAPO: An unnecessary vertical scrollbar was shown after PAPO Case Analysis was resized.
* 218520: PAPO: Filter does not recognize decimal separators.

'''Fixed bugs in QPR ProcessAnalyzer Server:'''
* 218537: ODBC xlsx loading failed with data format issue.
* 218495: Changing default filter does not drop cached model information.
* 218550: Accessing projects from expression language fails in some cases.
* 218549: Datatable import from Excel sheet data corruption if first column value is empty.
* 218558: Errors in default.aspx. Login fails.

== QPR ProcessAnalyzer 2018.4 (release date 2018-06-11) ==
Build number: 2018.4.0.37669, Model compatibility version: 2, Database version: 58, Stream version: 7.

'''Release Highlights:'''
* ODBC driver support for QPR ProcessAnalyzer: Use external data sources to create a dynamic model that is updated every time the model is loaded. Using the ODBC driver, the model data can be accessed from a separate data source. All the event data information can be defined in JSON format allowing for automatic model creation.
* KPI Analysis: A new analysis is added to QPR ProcessAnalyzer. KPI Analysis utilizes the KPI expression engine for creating visualizations of data. KPI Analysis is a fully fledged analysis that can be used in conjuction with the existing QPR ProcessAnalyzer analysis for more focused results. In addition, KPI Analysis is available as a separate QPR UI view for creation of dashboards that present real-time data taken from QPR ProcessAnalyzer.
* Tabular Analysis results updated with data types: Analysis featuring tabulated data are now automatically updated with correct data types. Automatic data types allow for exporting the data in a format that can be used in other compatible tools as the data types are automatically defined into the data.

'''Features for QPR ProcessAnalyzer UI:'''
* 307265: [[KPI_Analysis_(PAPO)|KPI analysis UI]] - part 1 (KPI).
* 307278: The tabular analyses (e.g. Case analysis) in QPR ProcessAnalyzer UI now have the correct column data types based on the information from the QPR ProcessAnalyzer server.

'''Features for QPR ProcessAnalyzer Server:'''
* 307204: [[QPR_ProcessAnalyzer_Model_JSON_Settings#Model Datasources|Load PA model from ODBC datasource]].
* 307313: Expression language improvements - part 7 (performance).
* 307317: Update new [[QPR_End_User_Software_License_Agreement|EULA]] to QPR ProcessAnalyzer.

'''Fixed bugs in QPR ProcessAnalyzer UI:'''
* 218487: Influence analysis for Flowchart changes the flowchart settings.
* 218498: No history entry is created while changing visibility threshold via stepper or context variable.
* 218508: PAPO variation analysis should limit the queried number of variations.
* 218513: PAPO settings buttons cover analysis content.
* 218532: PAPO: Profiling analysis does not work with data loaded via ODBC.

'''Fixed bugs in QPR ProcessAnalyzer Server:'''
* 218515: IIS crashes in kernel during Odbc query reading csv/xlsx file with Microsoft Access Text Driver and Microsoft Excel Driver.
* 218484: ImportEvents fails in StartBackground mode.
* 218525: InMemory CaseAnalysis ShowAllCases not work if there is cases without events.
* 218463: Issue to install excel client (part 2).

== QPR ProcessAnalyzer 2018.3 (release date 2018-04-23) ==
Build number: 2018.3.0.37545, Model compatibility version: 2, Database version: 58, Stream version: 7.

'''Release Highlights:'''
*Conformance Checking is supported in QPR ProcessAnalyzer. Using the KPI Expression Language as a basis, process mining models can be compared to BPMN notation and analyzed if the process data conforms to the BPMN design. These results are implemented in ChartView and KPI Expression Language allows them to be implemented into dashboards.
*BPMN Editor has been added to ChartView. You can now import and design BPMN process maps for use in conformance analysis. The BPMN editor is a web component that is used in the browser, allowing for quick and easy process design. The designs can also be exported for further use.
*Flowchart Visibility Settings have been overhauled with a new visual presentation. New stepper elements allow for more flexible flow threshold settings while maintaining a user-friendly approach.

'''Features for QPR ProcessAnalyzer UI:'''
* 307276: Remove PAPO Offline mode.
* 307193 & 307298: The [[Flowchart_Analysis_(PAPO)#Visibility_Settings|Flowchart Visibility Settings]] were improved.
'''Features for QPR ProcessAnalyzer Server:'''
* 307077: [[QPR_ProcessAnalyzer_System_Requirements#System_Requirements_for_QPR_ProcessAnalyzer_Server | Support for Windows Server 2016 (PA Service)]].
* 307246: Expression function to calculate conformance to BPMN.
* 307297: Expression language improvements - part 6.
* 307301: In-memory memory usage optimizations.
'''Fixed bugs in QPR ProcessAnalyzer UI:'''
* 218306: PAPO control window is affected by analysis window's 'Show as' setting.
'''Fixed bugs in QPR ProcessAnalyzer Server:'''
* 218241: PA Duration Analysis In-Memory - numbers for Events and Cases too high (focus flow).
* 218456: Issue to install excel client (part 1).

== QPR ProcessAnalyzer 2018.2 (release date 2018-03-12) ==
Build number: 2018.2.0.37453, Model compatibility version: 2, Database version: 58, Stream version: 7.

'''Release Highlights:'''
* Case Permissions have been added to the data security featureset. Case Permissions allow for limiting model visibility based on rules that reference the case attributes of a set model. Case permissions can refer to usernames or user groups, creating a link between the attributes and groups.
* Influence Analysis for Case Attributes has been simplified. The feature presents basic information relating to the root causes when it is opened. If further information is needed, this can be accessed via the feature menu.
* DataGrids support Excel exporting. You are now able to export data from fixed dashboards featuring datagrids. With this feature, you can take your data for further manipulation using Microsoft Excel.
* Chartview has been improved with a new layout and excel exporting. The new layout allows for quicker access to creating charts using the ChartView tool. With the exporting functionality, the views created are exported for use in presentations in Microsoft Excel.
* KPI Expression Language has been added with support for Influence Analysis for Case Attributes. This allows for further creation of dashboards with specific analysis result queries. Using the KPI expression language, dashboards can be made to present up-to-date data based on influence analysis results.
* Dataset tag support for data visualization. Adding dataset tags will help in creating more dynamic chart presentations as the data can be inserted into the JSON settings of charts and datagrids.

'''Features for QPR ProcessAnalyzer UI:'''
* 307220: The [[Influence_Analysis_for_Case_Attributes_(PAPO)|Influence Analysis for Case Attributes]] settings now has a toggle for showing and hiding the detail columns.

'''Features for QPR ProcessAnalyzer Server:'''
* 307273: [[QPR ProcessAnalyzer Web Service API#Example| PA model JSON settings]].
* 307269: [[QPR_ProcessAnalyzer_Model_JSON_Settings#Case_Permissions |Case permissions]].
* 307261: PA InMemory core, part 8 (Path Analysis).
* 307282: PA KPI's and expressions (part 5).
'''Fixed bugs in QPR ProcessAnalyzer UI:'''
* 218426: Using PAPO with customers model crashes PA Server (Entice Changes).

'''Fixed bugs in QPR ProcessAnalyzer Server:'''
* 218371: Event types aren't provided to PAPO by PA server.
* 218372: Having multiple expressions in one selection item in a JSON filter does not work.
* 218375: Empty comparison -setting with nonempty filter -setting causes influence analysis to return incorrect results.
* 218380: PA Activation ends one day before the actual end date.
* 218362: WebService GetAnalysisAsImage does not work.
* 218389, 218397: Performance issues in PA in-memory core with multiple simultaneous users.
* 218412: PercentageNumber property is not set properly in PA analyses.
* 218410: Event attribute profiling event amount mismatch.
* 218404: Using PAPO with customers model crashes PA Server (PA changes).
* 218430: Pre-release mandatory PA bugfixes.

== QPR ProcessAnalyzer 2018.1 (release date 2018-01-31) ==
Build number: 2018.1.0.37330, Model compatibility version: 2, Database version: 57, Stream version: 7.

'''Release Highlights:'''
* ChartView is introduced as a new QPR UI view. This interactive view allows the creation of customized charts to answer specific business needs, with measures and dimensions the user has selected. ChartView comes preloaded with numerous different presentation features for the creation of customized charts fit for any business need.
* New Table Filtering for Data Table Views. A new Excel-style filtering feature has been added to the different analysis features, such as Influence Analysis for Case Attributes and Event Analysis. The feature allows the presentation and comparison of different data using robust filters.
* The QPR UI version of QPR ProcessAnalyzer has an overhauled popup menu. Selecting different analysis and creating new filters is quicker and new icons have been added for added clarity.
* XES filetype importing support. The IEEE TaskForce standardized XES logs are now supported by QPR ProcessAnalyzer. This filetype aims to unify the transactional data produced by information systems and makes them usable in tools used in data analysis.

'''Full Features for QPR ProcessAnalyzer UI:'''
* 307244: The various tables (e.g. Case Analysis) in QPR ProcessAnalyzer UI received filtering functionality familiar to the one in Microsoft Excel.
* 307163: Popup menu improvements.
* 307224: Cache model information into browser side.
'''Features for QPR ProcessAnalyzer Server:'''
* 307271: PA InMemory core, part 7 (Canceling analysis).
* 307247: XES Event log file format support.
* 307257, 307270: PA KPI's and expressions (part 3, 4).
* 307211: Enable custom data sources: Selections as JSON.
'''Fixed bugs in QPR ProcessAnalyzer UI:'''
* 218327: PAPO Grid view row selection issues when opening popup menu.
* 218328: PAPO Missing null check in ModelState.
* 218365: PAPO: Settings etc. buttons not visible in the latest chrome version (automatically updated).
* 218324: Fixed an issue where a dataset wasn't refreshed when a context variable was changed from PAPO.
'''Fixed bugs in QPR ProcessAnalyzer Server:'''
* 218288: PA service installation with DeployPAService.ps1.
* 218291: Problem with --#GetAnalysis type 31 (filter rules).
* 218315: PAPO: InMemoryCore: Offline mode shows incorrect case attribute values.
* 217922: Filtering Flow Table with Case Attribute is too slow.
* 218321: PA core - Internal server error in PAPO when duration analysis result is empty.
* 218322: Flow analysis results not always in same order (InMemory).
* 218340: Not allow to delete default filter ("No access/Access denied").
* 218345: Unknown filter rule. The given key was not present in the dictionary.
* 218363: Attribute values are sent to clients as strings from InMemory profiling analysis.
* 218365: PAPO: Settings etc. buttons not visible in the latest chrome version (automatically updated).
* 218379: PAPO: Side panels visible in multi papo even if they should be closed and invisible.

== QPR ProcessAnalyzer 2017.9 (release date 2017-12-19) ==
Build number: 2017.9.0.37199, Model compatibility version: 2, Database version: 57, Stream version: 7.

'''Release Highlights:'''
* The Filtering system on the WebUI has been updated. The user can now easily rename filters, add specific permissions to control privacy of the filters and delete filters easily. The filtering system has an improved interface for easier handling of the filters.
* New Expression language for KPI calculation. This new language allows power users to create analysis that are customized to their needs and creates the possibility for caluclating KPIs inside the server core. This JSON based language allows users to take their analysis functions even further.
* Other improvements in this release include performance improvements and further development of the in-memory mode.

'''Features for QPR ProcessAnalyzer UI:'''
* 307237: PAPO: There's now a new "DisabledFunctionalities" [[QPR_ProcessAnalyzer_Presentation_Object_(PAPO)#PAPO.27s_Context_Variables|context variable for using with PAPO]] to define which PAPO functionalities should not be.
* 307173: It's now possible to edit the Name and Privacy of a filter in QPR ProcessAnalyzer UI, as well as delete a filter.
'''Features for QPR ProcessAnalyzer Server:'''
* 307235: PA InMemory core, part 5 (Flow Analysis).
* 307262: PA InMemory core, part 6 (Canceling model loading).
* 307257: PA KPI's and expressions (part 2).
'''Fixed bugs in QPR ProcessAnalyzer UI:'''
* 218251: Multi-PAPO: Model page shows when model button of one papo has been disabled.
* 218275: Change PA WS methods from GET to POST.
* 218132: PAPO: Zoom change when item is selected from Variation Analysis.
* 218196: PAPO: Variation Analysis: graph bar lengths doesn't match with data.
* 218157: PAPO: QPR UI Graphics messed in Influence Analysis for Flowchart.
'''Fixed bugs in QPR ProcessAnalyzer Server:'''
* 218241: Duration Analysis In-Memory - numbers for Events, Median duration and Average duration are too high.
* 218046: System.ArgumentException: Value of '-170' is not valid for 'red'. 'red' should be greater than or equal to 0 and less than or equal to 255.
* 218275: Change PA WS methods from GET to POST.

== QPR ProcessAnalyzer 2017.8 (release date 2017-11-07) ==
Build number: 2017.8.0.37022, Model compatibility version: 2, Database version: 57, Stream version: 7.

'''Release Highlights:'''
* The QPR UI interface features a new feature: Profiling Event Analysis. Now you can drilldown to your events and see what event attributes the event types in your data contain. You can also use this knowledge to benchmark your process.
* The Selection logic in the QPR UI has been updated. You no longer have to update after making a selection, as the selections are responsive and updated automatically. This leads to more responsive and effective analysis.
* In-Memory Engine has been improved upon, allowing for more efficient analysis for small-to-mid-size models. This update gives you improved performance in your analysis operations. This feature applies for all analysis features and improves the performance of the software immensely, giving you faster operations.
* The Excel Client has been preloaded with new and updated demo models that demonstrate the power of QPR ProcessAnalyzer. New Models include Healthcare and Insurance claims process models. These give you a great idea on how to utilize QPR ProcessAnalyzer.

'''Features for QPR ProcessAnalyzer UI:'''
* 307161: When selecting items in PAPO, the "Selected" context variables are now updated without the need to explicitly do the update. As a result, the "Select into UI Context" item was removed from the PAPO popup menu. This means that the TempSelectedActivities, TempSelectedTransitions, TempSelectedVariations, and TempSelectedCounts context variables were removed, and their functionality changed to be in the SelectedActivities, SelectedTransitions, SelectedVariations, and SelectedCounts context variables.
* 307061: PAPO now has the [[Profiling_Case_Analysis_(PAPO)#Profiling_Event_Analysis|Profiling Event Analysis]] available.

'''Features for QPR ProcessAnalyzer Server:'''
* 307219: Excel client demo model changes.
* 307216: To improve performance, QPR ProcessAnalyzer can now be configured to run the analyses in the server memory instead of the database.

'''Fixed bugs in QPR ProcessAnalyzer UI:'''
* 218060: PAPO doesn't add transition duration but case duration filter rule type when Duration analysis shows transition duration.
* 218039: PAPO: Analysis window has incorrect width when opening view (splitter issue).
* 218036: PAPO: Web UI shows archived/recycled PA models.
* 218100: PAPO: Once Analysis view show "No records to display" message, then switch to other analysis view is not possible for current model.
* 218159: PAPO: Popup menus don't work in tabular analyses in IE11.
* 218169: PAPO: SelectedAttributeType parameter in PA request has invalid value when switching model and applying filter that requires model change.
'''Fixed bugs in QPR ProcessAnalyzer Server:'''
* 218148: InMemory: Include Only Event Types does not work with sampled models.
* 218179: InMemory: Amount of cases in Duration analysis when flow is selected.

== QPR ProcessAnalyzer 2017.7 (release date 2017-09-25) ==
Build number: 2017.7.0.36871 <s>36762</s>, Model compatibility version: 2, Database version: 57, Stream version: 7.

'''Release Highlights:'''
* New In-Memory core for Process Analysis calculation. This server-side improvement can improve Analysis Performance speed up to 20 times faster than previous releases. This is achieved by offloading the memory functions directly to the application server where in the previous versions of the software, the SQL server handledthe workload.
* This release also features different bug fixes and performance improvements, aiming to improve your process analysis experience. Combining these features with the new WebUI platform release, the implementation of your data for analysis and improvement is smoother than ever.

'''Features for QPR ProcessAnalyzer UI:'''
* 307060: CSS styling and grid configuration improvements (technical feature).
'''Fixed bugs in QPR ProcessAnalyzer UI:'''
* 217986: The pie (in profiling analysis) is rendered initially too small.
* 217721: One extra scroll position / zoom -history entry created when PAPO is initialized.
* 218052: Flowchart shows incorrect duration.
* 217978: Profiling analysis is empty in Analysis window when opening splitter again.
* 217926: Duration Analysis in control window doesn't select all "other" cases.
* 217708: It is not possible to make multiselection using radial graph.
* 218043: Issue with AnalysisWindowSize context variable.
* 218058: Profiling Analysis for Case Attributes doesn't work when using numerical case attribute.
* 218035: Switch model from filter: Error processing PA request. Invalid column name 'CA_VALUE_1290462'.
'''Fixed bugs in QPR ProcessAnalyzer Server:'''
* 218024: Add log writing to odbc query.
* 217836: Error when opening filter in customer environment.
* 217995: ImportCaseAttributes command does not import cases properly.
* 218094: PA error text doesn't have information which value have problem.
* 218145: Input String was not in the correct format error when opening customer model.

== Old Releases ==
See older releases in [[QPR ProcessAnalyzer Release Archive]]
__NOTOC__

Troubleshooting SQL Scripts

2019-02-07T09:48:22Z

VesKivi: /* Using "##" in a Script */

This page goes though some common problem situations in QPR ProcessAnalyzer scripts. After a script has been run, the [[QPR_ProcessAnalyzer_Logs#Script_Log|Script Log]] dialog is shown. You can use it to troubleshoot your script.

== Invalid Object Name ==
Issue: '''Invalid object name''' exception is thrown when running a script with #GetAnalysis and #ImportEvents commands.

The issue may arise when there are no events to import, i.e. the #GetAnalysis command doesn't create any table. In this case, the missing event table needs to be created in the script between the #GetAnalysis and #ImportEvents commands:
<pre>
/*This is the GetAnalysis part */
(SELECT 'AnalysisType', '6') UNION ALL
(SELECT 'MaximumCount', '0') UNION ALL
(SELECT 'FilterId', '10') UNION ALL
(SELECT 'SelectedEventAttributes', '*') UNION ALL
(SELECT 'TargetTable', '#AnalysisResult')
--#GetAnalysis

/*Here we create the event table, if it is missing */
IF object_id('tempdb..#AnalysisResult') is null
BEGIN
CREATE TABLE #AnalysisResult (
CaseName NVARCHAR(MAX),
EventTypeName NVARCHAR(MAX),
TimeStamp DATETIME,
Cost FLOAT,
TotalCost FLOAT
);
END

/*Then we use the ImportEvents */
(SELECT 'ProjectName', 'ExampleProject') UNION ALL
(SELECT 'ModelName', 'ExampleModel')
(SELECT * FROM [#AnalysisResult])
--#ImportEvents
</pre>

== Incorrect Syntax When Using ' Characters ==
Issue: '''SQL error: Incorrect syntax near ' '''

If you get this error message, check the ' characters in the parameter definitions. Note that you cannot use the ' character in the parameter value.

== Incorrect Syntax When Running Scripts Copied from QPR ProcessAnalyzer Wiki ==
Issue: '''SQL error: Incorrect syntax'''

You may get this kind of error message when trying to run a script that you have copied and pasted directly from, for example, the examples given in [[Data Extraction, Transformation, and Loading#Supported QPR ProcessAnalyzer Commands in Scripts|Supported QPR ProcessAnalyzer Commands in Scripts]]. This happens because the scripts are then likely to contain non-breaking spaces (encoded as 0xA0 but not visible when pasted to the '''Script Code''' field) which cause the running of the scripts to fail as they are not accepted in the SQL syntax.

The solution is to manually remove the non-breaking spaces after copying and pasting the script, so there are no extra spaces at the beginning of each line, for example.

== Using "##" in a Script ==
Issue: '''Using "##" in a script is not allowed. Did you mistype temporary table name?'''

This error message is displayed if the name of the project or model name contains two consecutive # characters (i.e. ##) and you try creating a new project or a model using scripts. Note that you cannot use the ## character in the name of the project or the model. Use expression like 'stringstart#' + '#stringend' or simlar to avoid have "##" in script.

== The ? Character in Project and Model Names ==
Issue: A project or model name contains question marks.

The problem arises if you try to, for example, create a project or a model with a name containing multibyte characters using scripts. The created project or model will then include question mark characters instead of multibyte characters. The fix is to add a prefix N' to the name containing multibyte characters (for example, N'【隱藏▲】【純文字檢視】【複製到剪貼簿】'). Another workaround is not to use multibyte characters at all in scripts but instead ProjectId and ModelId, if possible. To do that, you can view the Id column in the Models tab of the Workspace dialog in the same way as described for data tables in [[Project Workspace in QPR ProcessAnalyzer Excel Client#Adding_an_Id_Column_to_the_Data_Tables_List|Adding an Id Column to the Data Tables List]].

== Multiple Projects with the Same Name ==
Issue: '''There are multiple projects with name '<ProjectName>'. Please, specify ProjectId in sandbox script operation: #<Operation>'''

This error message is displayed when trying to run a script if you have access to two or several projects with the same name and you refer to the project by name in the script. The fix for resolving this ambiguity is to refer to the project by its ID using the 'ProjectId' parameter instead of 'ProjectName'. An ID is always unique, whereas a name is not.

== Multiple Models with the Same Name ==
Issue: '''There are multiple models with name '<ModelName>'. Please, specify ModelId in sandbox script operation: #<Operation>'''

This error message is displayed when trying to run a script if you have access to two or several models with the same name and you refer to the model by name in the script. The fix for resolving this ambiguity is to refer to the model by its ID using the 'ModelId' parameter instead of 'ModelName'. An ID is always unique, whereas a name is not.

== String Comparisons Not Being Correct ==
Issue: Different characters are considered as similar and my analysis or script is affected.

Due to the way SQL Server handles string comparisons, comparing attribute values that are in non-western character sets may result in values that are not similar to be treated as they were. For example the following characters are considered the same as the space character: Ǹ, ǹ, Ș, ș. This can have an effect in analyses using the attributes, i.e. Profiling Analysis, Influence Analysis, as well as Benchmarking and attribute value filtering and scripts that are run. To overcome this, before importing the attribute values, cast the SQL Variants holding the values into VARBINARY(MAX).

For example, the following script will show characters that are treated similar as zero "0":

<pre>
DECLARE @referenceAscii int = 0

IF object_id('tempdb..#ids') is null
CREATE TABLE #ids ( id int)

DECLARE @i int = 0
WHILE @i < 70000 BEGIN
SET @i = @i + 1
INSERT #ids VALUES (@i)
END

select * FROM (
select
sys.fn_varbintohexstr(CONVERT(varBINARY(8), id)) as CharacterAsHex,
id as ASCIICode,
nchar(id) as Character,
(CASE WHEN Nchar(@referenceAscii) = NCHAR(id) THEN 1 ELSE 0 END) as ShownAsSimilar
FROM #ids ) as x
where x.ShownAsSimilar = 1
--#ShowReport
</pre>

== Client Exception When Using #ImportSapQuery Command ==
Issue: Limitations in size of SAP query result.

The SAP system has limitations as to how much data can be queried. The workaround for the error is to reduce the amount of data to be queried using 'SapRowcount', 'SapRowskips', 'SapWhereClauseSelect', 'SapFieldNames' and 'SapFunction' parameters. See [[QPR ProcessAnalyzer Scripting Commands#--.23ImportSapQuery|--#ImportSapQuery]] for parameter explanations.

Issue: '''Client exception''' is thrown when running a script with #ImportSapQuery command using the 'SapWhereClauseSelect' parameter.

For example, the following error text can be displayed:
<pre>
#ImportSapQuery: SAP.Middleware.Connector.RfcAbapRuntimeException: SAP.Middleware.Connector.RfcAbapRuntimeException:
Error in module RSQL of the database interface
at SAP.Middleware.Connector.RfcConnection.ThrowRfcErrorMsg()
at SAP.Middleware.Connector.RfcConnection.ReadBytes(Byte* buffer, Int32 count)
at SAP.Middleware.Connector.RfcConnection.ReadRfcIDBegin(Int32& length)
at SAP.Middleware.Connector.RfcConnection.ReadUpTo(RFCGET readState, RfcFunction function, RFCID toRid)
at SAP.Middleware.Connector.RfcConnection.RfcReceive(RfcFunction function)
at SAP.Middleware.Connector.RfcFunction.RfcDeserialize(RfcConnection conn, IRfcIOStream stream)
at SAP.Middleware.Connector.RfcFunction.RfcCallReceive(RfcConnection conn, IRfcIOStream stream, RFCID rid)
at SAP.Middleware.Connector.RfcFunction.Invoke(RfcDestination destination)
at Qpr.ProcessAnalyzer.Common.Integration.Sap.SapQuery(RfcDestination destination, Action`2 getSapWhereClauseSelect, Boolean enableStreamCompression, IDictionary`2 parameters)
System.ServiceModel.FaultException`1[Qpr.Utils.SapError]: SAP.Middleware.Connector.RfcAbapRuntimeException: Error in module RSQL of the database interface
(Fault Detail is equal to SAP.Middleware.Connector.RfcAbapRuntimeException: Error in module RSQL of the database interface</pre>

:This issue may arise when you are extracting data from SAP and the size of 'SapWhereClauseSelect' parameter value is too large. Reduce the size of the 'SapWhereClauseSelect' value.

QPR ProcessAnalyzer API

2019-01-11T11:46:01Z

VesKivi:

QPR ProcessAnalyzer Web Service API (Application Programming Interface) can be used to automate operations and to create integration with other applications. All Web Service operations only accept HTTP POST method (HTTP GET is not allowed).

== Functions in the Web Service API ==
The following functions are available:
* [[QPR ProcessAnalyzer API: Authenticate|Authenticate]]: Tries to authenticate given user with given password and authentication parameters.
* [[QPR ProcessAnalyzer API: CancelQueryOperation|CancelQueryOperation]]: Cancels running operation using query identifier.
* [[QPR ProcessAnalyzer API: DeleteModel|DeleteModel]]: Deletes a model.
* [[QPR ProcessAnalyzer API: GetAnalysis|GetAnalysis]]: Calculates and returns QPR ProcessAnalyzer analysis.
* [[QPR ProcessAnalyzer API: GetAnalysisImageAsByteArray|GetAnalysisImageAsByteArray]]: Get [[Flowchart Analysis in QPR ProcessAnalyzer Excel Client|Flowchart Analysis]] as image.
* [[QPR ProcessAnalyzer API: GetModel|GetModel]]: Can be used to query QPR ProcessAnalyzer model data.
* [[QPR ProcessAnalyzer API: GetModels|GetModels]]: Can be used to query QPR ProcessAnalyzer model related information.
* [[QPR ProcessAnalyzer API: GetStream|GetStream]] can be used to query contents of a stream bound to the given session identified by given stream id.
* [[QPR ProcessAnalyzer API: GetUsers|GetUsers]]: can be used to get user related information.
* [[QPR ProcessAnalyzer API: LogOff|LogOff]]: Logs off the user session.
* [[QPR ProcessAnalyzer API: QueryObjectProperties|QueryObjectProperties]] returns all the listed properties queried for all the listed objects identified by unique identifiers.
* [[QPR ProcessAnalyzer API: ResetModelCache|ResetModelCache]]: Can be used to clear all cached model information of the given model.
* [[QPR ProcessAnalyzer API: RunScript|RunScript]] can be used to execute given PA script using given parameters.
* [[QPR ProcessAnalyzer API: SetModel|SetModel]]: Can be used to set model related information.
* [[QPR ProcessAnalyzer API: SetUser|SetUser]]: Can be used to set user information.
* [[QPR ProcessAnalyzer API: ValidateModel|ValidateModel]] can be used to perform all the pending tasks stored in the work queue of the given model.
* [[QPR ProcessAnalyzer API: GetUserPermissions|GetUserPermissions]] can be used to query permissions given user has for a set of objects.
* [[QPR ProcessAnalyzer API: ModifyUserRelations|ModifyUserRelations]] can be used to modify permissions given user.
* [[QPR ProcessAnalyzer API: GetUserRoles|GetUserRoles]] can be used to get available user roles.

== Examples ==
=== JavaScript Examples ===
<pre>
//login
$.ajax({
"method": "POST",
"url": "http://localhost/qprpa/Mainservice.svc/webHttp/Authenticate",
"dataType": "json", "contentType": "application/json; charset=utf-8",
"data": JSON.stringify({
'logOnName': '<username>',
'password': '<password>',
'parameters': ''
})
});
</pre>

<pre>
//create user
$.ajax({
"method": "POST",
"url": "http://localhost/qprpa/Mainservice.svc/webHttp/SetUser",
"dataType": "json", "contentType": "application/json; charset=utf-8",
"data": JSON.stringify({
"sessionId": sessionId,
"user": {"Name": "user", "FullName": "first last" },
"parameters": [{"Key": "Password", "Value": "demo"}]
})
});
</pre>

<pre>
//add user to group, value 8:12:0 is user:group:member type
$.ajax({
"method": "POST",
"url": "http://localhost/qprpa/Mainservice.svc/webHttp/ModifyUserRelations",
"dataType": "json", "contentType": "application/json; charset=utf-8",
"data": JSON.stringify({
"sessionId": sessionId,
"parameters": [{"Key": "AddGroups", "Value": "8:12:0"}]
})
});
</pre>

<pre>
//log off
$.ajax({
"method": "POST",
"url": "http://localhost/qprpa/Mainservice.svc/webHttp/LogOff",
"dataType": "json", "contentType": "application/json; charset=utf-8",
"data": JSON.stringify({
"sessionId": sessionId
})
});
</pre>

=== List Users (PowerShell) ===
<pre>
$paService=New-WebServiceProxy –Uri "http://localhost/qprpa/MainService.svc"
$connection=$paService.Authenticate("username", "password", @())
$token=$connection.GetValue(0).Value

$param=@()
$users=$paService.GetUsers($token, $null, $param)
$users
$paService | get-member | ? {$_.definition -match "GetAnalysis"}
</pre>

=== Update Model Configuration (PowerShell) ===
<pre>
$paService=New-WebServiceProxy –Uri "http://localhost/qprpa/MainService.svc"
$connection=$paService.Authenticate("username", "password", @())
$token=$connection.GetValue(0).Value
$param=@()
$modelId=@(2)
$model=$paService.GetModels($token,$modelId, $param)

$model[0]
$model[0].ConfigurationJson = "{}"

$paService.SetModel($token,$model[0], $param)
</pre>

=== Get Flowchart Image (PowerShell) ===
<pre>
$paService=New-WebServiceProxy –Uri "http://localhost/qprpa/MainService.svc"
$connection=$paService.Authenticate("username", "password", @())
$token=$connection.GetValue(0).Value

$filterId = 13
$analysisType = 0
$processAnalysisType = 4
$minTransitionPercentage = 0.0

$png= $paService.GetAnalysisImageAsByteArray($token,$filterId,1, $analysisType,1, $processAnalysisType,1 , $minTransitionPercentage,1)
[IO.File]::WriteAllBytes('c:\tmp\image.png', $png)
</pre>

QPR ProcessAnalyzer API

2019-01-11T11:23:35Z

VesKivi: /* Functions in the Web Service API */

QPR ProcessAnalyzer Web Service API (Application Programming Interface) can be used to automate operations and to create integration with other applications. All Web Service operations only accept HTTP POST method (HTTP GET is not allowed).

== Functions in the Web Service API ==
The following functions are available:
* [[QPR ProcessAnalyzer API: Authenticate|Authenticate]]: Tries to authenticate given user with given password and authentication parameters.
* [[QPR ProcessAnalyzer API: CancelQueryOperation|CancelQueryOperation]]: Cancels running operation using query identifier.
* [[QPR ProcessAnalyzer API: DeleteModel|DeleteModel]]: Deletes a model.
* [[QPR ProcessAnalyzer API: GetAnalysis|GetAnalysis]]: Calculates and returns QPR ProcessAnalyzer analysis.
* [[QPR ProcessAnalyzer API: GetAnalysisImageAsByteArray|GetAnalysisImageAsByteArray]]: Get [[Flowchart Analysis in QPR ProcessAnalyzer Excel Client|Flowchart Analysis]] as image.
* [[QPR ProcessAnalyzer API: GetModel|GetModel]]: Can be used to query QPR ProcessAnalyzer model data.
* [[QPR ProcessAnalyzer API: GetModels|GetModels]]: Can be used to query QPR ProcessAnalyzer model related information.
* [[QPR ProcessAnalyzer API: GetStream|GetStream]] can be used to query contents of a stream bound to the given session identified by given stream id.
* [[QPR ProcessAnalyzer API: GetUsers|GetUsers]]: can be used to get user related information.
* [[QPR ProcessAnalyzer API: LogOff|LogOff]]: Logs off the user session.
* [[QPR ProcessAnalyzer API: QueryObjectProperties|QueryObjectProperties]] returns all the listed properties queried for all the listed objects identified by unique identifiers.
* [[QPR ProcessAnalyzer API: ResetModelCache|ResetModelCache]]: Can be used to clear all cached model information of the given model.
* [[QPR ProcessAnalyzer API: RunScript|RunScript]] can be used to execute given PA script using given parameters.
* [[QPR ProcessAnalyzer API: SetModel|SetModel]]: Can be used to set model related information.
* [[QPR ProcessAnalyzer API: SetUser|SetUser]]: Can be used to set user information.
* [[QPR ProcessAnalyzer API: ValidateModel|ValidateModel]] can be used to perform all the pending tasks stored in the work queue of the given model.
* [[QPR ProcessAnalyzer API: GetUserPermissions|GetUserPermissions]] can be used to query permissions given user has for a set of objects.
* [[QPR ProcessAnalyzer API: GetUserRoles|GetUserRoles]] can be used to get available user roles.

== Examples ==
=== JavaScript Examples ===
<pre>
//login
$.ajax({
"method": "POST",
"url": "http://localhost/qprpa/Mainservice.svc/webHttp/Authenticate",
"dataType": "json", "contentType": "application/json; charset=utf-8",
"data": JSON.stringify({
'logOnName': '<username>',
'password': '<password>',
'parameters': ''
})
});
</pre>

<pre>
//create user
$.ajax({
"method": "POST",
"url": "http://localhost/qprpa/Mainservice.svc/webHttp/SetUser",
"dataType": "json", "contentType": "application/json; charset=utf-8",
"data": JSON.stringify({
"sessionId": sessionId,
"user": {"Name": "user", "FullName": "first last" },
"parameters": [{"Key": "Password", "Value": "demo"}]
})
});
</pre>

<pre>
//add user to group, value 8:12:0 is user:group:member type
$.ajax({
"method": "POST",
"url": "http://localhost/qprpa/Mainservice.svc/webHttp/ModifyUserRelations",
"dataType": "json", "contentType": "application/json; charset=utf-8",
"data": JSON.stringify({
"sessionId": sessionId,
"parameters": [{"Key": "AddGroups", "Value": "8:12:0"}]
})
});
</pre>

<pre>
//log off
$.ajax({
"method": "POST",
"url": "http://localhost/qprpa/Mainservice.svc/webHttp/LogOff",
"dataType": "json", "contentType": "application/json; charset=utf-8",
"data": JSON.stringify({
"sessionId": sessionId
})
});
</pre>

=== List Users (PowerShell) ===
<pre>
$paService=New-WebServiceProxy –Uri "http://localhost/qprpa/MainService.svc"
$connection=$paService.Authenticate("username", "password", @())
$token=$connection.GetValue(0).Value

$param=@()
$users=$paService.GetUsers($token, $null, $param)
$users
$paService | get-member | ? {$_.definition -match "GetAnalysis"}
</pre>

=== Update Model Configuration (PowerShell) ===
<pre>
$paService=New-WebServiceProxy –Uri "http://localhost/qprpa/MainService.svc"
$connection=$paService.Authenticate("username", "password", @())
$token=$connection.GetValue(0).Value
$param=@()
$modelId=@(2)
$model=$paService.GetModels($token,$modelId, $param)

$model[0]
$model[0].ConfigurationJson = "{}"

$paService.SetModel($token,$model[0], $param)
</pre>

=== Get Flowchart Image (PowerShell) ===
<pre>
$paService=New-WebServiceProxy –Uri "http://localhost/qprpa/MainService.svc"
$connection=$paService.Authenticate("username", "password", @())
$token=$connection.GetValue(0).Value

$filterId = 13
$analysisType = 0
$processAnalysisType = 4
$minTransitionPercentage = 0.0

$png= $paService.GetAnalysisImageAsByteArray($token,$filterId,1, $analysisType,1, $processAnalysisType,1 , $minTransitionPercentage,1)
[IO.File]::WriteAllBytes('c:\tmp\image.png', $png)
</pre>

QPR ProcessAnalyzer API

2019-01-11T07:58:10Z

VesKivi:

QPR ProcessAnalyzer Web Service API (Application Programming Interface) can be used to automate operations and to create integration with other applications. All Web Service operations only accept HTTP POST method (HTTP GET is not allowed).

== Functions in the Web Service API ==
The following functions are available:
* [[QPR ProcessAnalyzer API: Authenticate|Authenticate]]: Tries to authenticate given user with given password and authentication parameters.
* [[QPR ProcessAnalyzer API: CancelQueryOperation|CancelQueryOperation]]: Cancels running operation using query identifier.
* [[QPR ProcessAnalyzer API: DeleteModel|DeleteModel]]: Deletes a model.
* [[QPR ProcessAnalyzer API: GetAnalysis|GetAnalysis]]: Calculates and returns QPR ProcessAnalyzer analysis.
* [[QPR ProcessAnalyzer API: GetAnalysisImageAsByteArray|GetAnalysisImageAsByteArray]]: Get [[Flowchart Analysis in QPR ProcessAnalyzer Excel Client|Flowchart Analysis]] as image.
* [[QPR ProcessAnalyzer API: GetModel|GetModel]]: Can be used to query QPR ProcessAnalyzer model related information.
* [[QPR ProcessAnalyzer API: GetModels|GetModels]]: Can be used to query QPR ProcessAnalyzer model related information.
* [[QPR ProcessAnalyzer API: GetStream|GetStream]] can be used to query contents of a stream bound to the given session identified by given stream id.
* [[QPR ProcessAnalyzer API: GetUsers|GetUsers]]: can be used to get user related information.
* [[QPR ProcessAnalyzer API: LogOff|LogOff]]: Logs off the user session.
* [[QPR ProcessAnalyzer API: QueryObjectProperties|QueryObjectProperties]] returns all the listed properties queried for all the listed objects identified by unique identifiers.
* [[QPR ProcessAnalyzer API: ResetModelCache|ResetModelCache]]: Can be used to clear all cached model information of the given model.
* [[QPR ProcessAnalyzer API: RunScript|RunScript]] can be used to execute given PA script using given parameters.
* [[QPR ProcessAnalyzer API: SetModel|SetModel]]: Can be used to set model related information.
* [[QPR ProcessAnalyzer API: SetUser|SetUser]]: Can be used to set user information.
* [[QPR ProcessAnalyzer API: ValidateModel|ValidateModel]] can be used to perform all the pending tasks stored in the work queue of the given model.
* [[QPR ProcessAnalyzer API: GetUserPermissions|GetUserPermissions]] can be used to query permissions given user has for a set of objects.
* [[QPR ProcessAnalyzer API: GetUserRoles|GetUserRoles]] can be used to get available user roles.

== Examples ==
=== JavaScript Examples ===
<pre>
//login
$.ajax({
"method": "POST",
"url": "http://localhost/qprpa/Mainservice.svc/webHttp/Authenticate",
"dataType": "json", "contentType": "application/json; charset=utf-8",
"data": JSON.stringify({
'logOnName': '<username>',
'password': '<password>',
'parameters': ''
})
});
</pre>

<pre>
//create user
$.ajax({
"method": "POST",
"url": "http://localhost/qprpa/Mainservice.svc/webHttp/SetUser",
"dataType": "json", "contentType": "application/json; charset=utf-8",
"data": JSON.stringify({
"sessionId": sessionId,
"user": {"Name": "user", "FullName": "first last" },
"parameters": [{"Key": "Password", "Value": "demo"}]
})
});
</pre>

<pre>
//add user to group, value 8:12:0 is user:group:member type
$.ajax({
"method": "POST",
"url": "http://localhost/qprpa/Mainservice.svc/webHttp/ModifyUserRelations",
"dataType": "json", "contentType": "application/json; charset=utf-8",
"data": JSON.stringify({
"sessionId": sessionId,
"parameters": [{"Key": "AddGroups", "Value": "8:12:0"}]
})
});
</pre>

<pre>
//log off
$.ajax({
"method": "POST",
"url": "http://localhost/qprpa/Mainservice.svc/webHttp/LogOff",
"dataType": "json", "contentType": "application/json; charset=utf-8",
"data": JSON.stringify({
"sessionId": sessionId
})
});
</pre>

=== List Users (PowerShell) ===
<pre>
$paService=New-WebServiceProxy –Uri "http://localhost/qprpa/MainService.svc"
$connection=$paService.Authenticate("username", "password", @())
$token=$connection.GetValue(0).Value

$param=@()
$users=$paService.GetUsers($token, $null, $param)
$users
$paService | get-member | ? {$_.definition -match "GetAnalysis"}
</pre>

=== Update Model Configuration (PowerShell) ===
<pre>
$paService=New-WebServiceProxy –Uri "http://localhost/qprpa/MainService.svc"
$connection=$paService.Authenticate("username", "password", @())
$token=$connection.GetValue(0).Value
$param=@()
$modelId=@(2)
$model=$paService.GetModels($token,$modelId, $param)

$model[0]
$model[0].ConfigurationJson = "{}"

$paService.SetModel($token,$model[0], $param)
</pre>

=== Get Flowchart Image (PowerShell) ===
<pre>
$paService=New-WebServiceProxy –Uri "http://localhost/qprpa/MainService.svc"
$connection=$paService.Authenticate("username", "password", @())
$token=$connection.GetValue(0).Value

$filterId = 13
$analysisType = 0
$processAnalysisType = 4
$minTransitionPercentage = 0.0

$png= $paService.GetAnalysisImageAsByteArray($token,$filterId,1, $analysisType,1, $processAnalysisType,1 , $minTransitionPercentage,1)
[IO.File]::WriteAllBytes('c:\tmp\image.png', $png)
</pre>

QPR ProcessAnalyzer API

2019-01-10T10:47:03Z

VesKivi: /* Functions in the Web Service API */

QPR ProcessAnalyzer Web Service API (Application Programming Interface) can be used to automate operations and to create integration with other applications. All Web Service operations only accept HTTP POST method (HTTP GET is not allowed).

== Functions in the Web Service API ==
The following functions are available:
* [[QPR ProcessAnalyzer API: Authenticate|Authenticate]]: Tries to authenticate given user with given password and authentication parameters.
* [[QPR ProcessAnalyzer API: CancelQueryOperation|CancelQueryOperation]]: Cancels running operation using query identifier.
* [[QPR ProcessAnalyzer API: DeleteModel|DeleteModel]]: Deletes a model.
* [[QPR ProcessAnalyzer API: GetAnalysis|GetAnalysis]]: Calculates and returns QPR ProcessAnalyzer analysis.
* [[QPR ProcessAnalyzer API: GetAnalysisImageAsByteArray|GetAnalysisImageAsByteArray]]: Get [[Flowchart Analysis in QPR ProcessAnalyzer Excel Client|Flowchart Analysis]] as image.
* [[QPR ProcessAnalyzer API: GetModels|GetModels]]: Can be used to query QPR ProcessAnalyzer model related information.
* [[QPR ProcessAnalyzer API: GetStream|GetStream]] can be used to query contents of a stream bound to the given session identified by given stream id.
* [[QPR ProcessAnalyzer API: GetUsers|GetUsers]]: can be used to get user related information.
* [[QPR ProcessAnalyzer API: LogOff|LogOff]]: Logs off the user session.
* [[QPR ProcessAnalyzer API: QueryObjectProperties|QueryObjectProperties]] returns all the listed properties queried for all the listed objects identified by unique identifiers.
* [[QPR ProcessAnalyzer API: ResetModelCache|ResetModelCache]]: Can be used to clear all cached model information of the given model.
* [[QPR ProcessAnalyzer API: RunScript|RunScript]] can be used to execute given PA script using given parameters.
* [[QPR ProcessAnalyzer API: SetModel|SetModel]]: Can be used to set model related information.
* [[QPR ProcessAnalyzer API: SetUser|SetUser]]: Can be used to set user information.
* [[QPR ProcessAnalyzer API: ValidateModel|ValidateModel]] can be used to perform all the pending tasks stored in the work queue of the given model.
* [[QPR ProcessAnalyzer API: GetUserPermissions|GetUserPermissions]] can be used to query permissions given user has for a set of objects.
* [[QPR ProcessAnalyzer API: GetUserRoles|GetUserRoles]] can be used to get available user roles.

== Examples ==
=== JavaScript Examples ===
<pre>
//login
$.ajax({
"method": "POST",
"url": "http://localhost/qprpa/Mainservice.svc/webHttp/Authenticate",
"dataType": "json", "contentType": "application/json; charset=utf-8",
"data": JSON.stringify({
'logOnName': '<username>',
'password': '<password>',
'parameters': ''
})
});
</pre>

<pre>
//create user
$.ajax({
"method": "POST",
"url": "http://localhost/qprpa/Mainservice.svc/webHttp/SetUser",
"dataType": "json", "contentType": "application/json; charset=utf-8",
"data": JSON.stringify({
"sessionId": sessionId,
"user": {"Name": "user", "FullName": "first last" },
"parameters": [{"Key": "Password", "Value": "demo"}]
})
});
</pre>

<pre>
//add user to group, value 8:12:0 is user:group:member type
$.ajax({
"method": "POST",
"url": "http://localhost/qprpa/Mainservice.svc/webHttp/ModifyUserRelations",
"dataType": "json", "contentType": "application/json; charset=utf-8",
"data": JSON.stringify({
"sessionId": sessionId,
"parameters": [{"Key": "AddGroups", "Value": "8:12:0"}]
})
});
</pre>

<pre>
//log off
$.ajax({
"method": "POST",
"url": "http://localhost/qprpa/Mainservice.svc/webHttp/LogOff",
"dataType": "json", "contentType": "application/json; charset=utf-8",
"data": JSON.stringify({
"sessionId": sessionId
})
});
</pre>

=== List Users (PowerShell) ===
<pre>
$paService=New-WebServiceProxy –Uri "http://localhost/qprpa/MainService.svc"
$connection=$paService.Authenticate("username", "password", @())
$token=$connection.GetValue(0).Value

$param=@()
$users=$paService.GetUsers($token, $null, $param)
$users
$paService | get-member | ? {$_.definition -match "GetAnalysis"}
</pre>

=== Update Model Configuration (PowerShell) ===
<pre>
$paService=New-WebServiceProxy –Uri "http://localhost/qprpa/MainService.svc"
$connection=$paService.Authenticate("username", "password", @())
$token=$connection.GetValue(0).Value
$param=@()
$modelId=@(2)
$model=$paService.GetModels($token,$modelId, $param)

$model[0]
$model[0].ConfigurationJson = "{}"

$paService.SetModel($token,$model[0], $param)
</pre>

=== Get Flowchart Image (PowerShell) ===
<pre>
$paService=New-WebServiceProxy –Uri "http://localhost/qprpa/MainService.svc"
$connection=$paService.Authenticate("username", "password", @())
$token=$connection.GetValue(0).Value

$filterId = 13
$analysisType = 0
$processAnalysisType = 4
$minTransitionPercentage = 0.0

$png= $paService.GetAnalysisImageAsByteArray($token,$filterId,1, $analysisType,1, $processAnalysisType,1 , $minTransitionPercentage,1)
[IO.File]::WriteAllBytes('c:\tmp\image.png', $png)
</pre>

QPR ProcessAnalyzer API

2019-01-07T14:11:44Z

VesKivi: /* Functions in the Web Service API */

QPR ProcessAnalyzer Web Service API (Application Programming Interface) can be used to automate operations and to create integration with other applications. All Web Service operations only accept HTTP POST method (HTTP GET is not allowed).

== Functions in the Web Service API ==
The following functions are available:
* [[QPR ProcessAnalyzer API: Authenticate|Authenticate]]: Tries to authenticate given user with given password and authentication parameters.
* [[QPR ProcessAnalyzer API: CancelQueryOperation|CancelQueryOperation]]: Cancels running operation using query identifier.
* [[QPR ProcessAnalyzer API: DeleteModel|DeleteModel]]: Deletes a model.
* [[QPR ProcessAnalyzer API: GetAnalysis|GetAnalysis]]: Calculates and returns QPR ProcessAnalyzer analysis.
* [[QPR ProcessAnalyzer API: GetAnalysisImageAsByteArray|GetAnalysisImageAsByteArray]]: Get [[Flowchart Analysis in QPR ProcessAnalyzer Excel Client|Flowchart Analysis]] as image.
* [[QPR ProcessAnalyzer API: GetModels|GetModels]]: Can be used to query QPR ProcessAnalyzer model related information.
* [[QPR ProcessAnalyzer API: GetStream|GetStream]] can be used to query contents of a stream bound to the given session identified by given stream id.
* [[QPR ProcessAnalyzer API: GetUsers|GetUsers]]: Can be used to query QPR ProcessAnalyzer model related information.
* [[QPR ProcessAnalyzer API: LogOff|LogOff]]: Logs off the user session.
* [[QPR ProcessAnalyzer API: QueryObjectProperties|QueryObjectProperties]] returns all the listed properties queried for all the listed objects identified by unique identifiers.
* [[QPR ProcessAnalyzer API: ResetModelCache|ResetModelCache]]: Can be used to clear all cached model information of the given model.
* [[QPR ProcessAnalyzer API: RunScript|RunScript]] can be used to execute given PA script using given parameters.
* [[QPR ProcessAnalyzer API: SetModel|SetModel]]: Can be used to set model related information.
* [[QPR ProcessAnalyzer API: SetUser|SetUser]]: Can be used to set user information.
* [[QPR ProcessAnalyzer API: ValidateModel|ValidateModel]] can be used to perform all the pending tasks stored in the work queue of the given model.
* [[QPR ProcessAnalyzer API: GetUsers|GetUsers]] can be used to get users.
* [[QPR ProcessAnalyzer API: GetUserPermissions|GetUserPermissions]] can be used to query permissions given user has for a set of objects.
* [[QPR ProcessAnalyzer API: GetUserRoles|GetUserRoles]] can be used to get available user roles.

== Examples ==
=== JavaScript Examples ===
<pre>
//login
$.ajax({
"method": "POST",
"url": "http://localhost/qprpa/Mainservice.svc/webHttp/Authenticate",
"dataType": "json", "contentType": "application/json; charset=utf-8",
"data": JSON.stringify({
'logOnName': '<username>',
'password': '<password>',
'parameters': ''
})
});
</pre>

<pre>
//create user
$.ajax({
"method": "POST",
"url": "http://localhost/qprpa/Mainservice.svc/webHttp/SetUser",
"dataType": "json", "contentType": "application/json; charset=utf-8",
"data": JSON.stringify({
"sessionId": sessionId,
"user": {"Name": "user", "FullName": "first last" },
"parameters": [{"Key": "Password", "Value": "demo"}]
})
});
</pre>

<pre>
//add user to group, value 8:12:0 is user:group:member type
$.ajax({
"method": "POST",
"url": "http://localhost/qprpa/Mainservice.svc/webHttp/ModifyUserRelations",
"dataType": "json", "contentType": "application/json; charset=utf-8",
"data": JSON.stringify({
"sessionId": sessionId,
"parameters": [{"Key": "AddGroups", "Value": "8:12:0"}]
})
});
</pre>

<pre>
//log off
$.ajax({
"method": "POST",
"url": "http://localhost/qprpa/Mainservice.svc/webHttp/LogOff",
"dataType": "json", "contentType": "application/json; charset=utf-8",
"data": JSON.stringify({
"sessionId": sessionId
})
});
</pre>

=== List Users (PowerShell) ===
<pre>
$paService=New-WebServiceProxy –Uri "http://localhost/qprpa/MainService.svc"
$connection=$paService.Authenticate("username", "password", @())
$token=$connection.GetValue(0).Value

$param=@()
$users=$paService.GetUsers($token, $null, $param)
$users
$paService | get-member | ? {$_.definition -match "GetAnalysis"}
</pre>

=== Update Model Configuration (PowerShell) ===
<pre>
$paService=New-WebServiceProxy –Uri "http://localhost/qprpa/MainService.svc"
$connection=$paService.Authenticate("username", "password", @())
$token=$connection.GetValue(0).Value
$param=@()
$modelId=@(2)
$model=$paService.GetModels($token,$modelId, $param)

$model[0]
$model[0].ConfigurationJson = "{}"

$paService.SetModel($token,$model[0], $param)
</pre>

=== Get Flowchart Image (PowerShell) ===
<pre>
$paService=New-WebServiceProxy –Uri "http://localhost/qprpa/MainService.svc"
$connection=$paService.Authenticate("username", "password", @())
$token=$connection.GetValue(0).Value

$filterId = 13
$analysisType = 0
$processAnalysisType = 4
$minTransitionPercentage = 0.0

$png= $paService.GetAnalysisImageAsByteArray($token,$filterId,1, $analysisType,1, $processAnalysisType,1 , $minTransitionPercentage,1)
[IO.File]::WriteAllBytes('c:\tmp\image.png', $png)
</pre>

QPR ProcessAnalyzer API

2019-01-07T14:11:27Z

VesKivi: /* Functions in the Web Service API */

QPR ProcessAnalyzer Web Service API (Application Programming Interface) can be used to automate operations and to create integration with other applications. All Web Service operations only accept HTTP POST method (HTTP GET is not allowed).

== Functions in the Web Service API ==
The following functions are available:
* [[QPR ProcessAnalyzer API: Authenticate|Authenticate]]: Tries to authenticate given user with given password and authentication parameters.
* [[QPR ProcessAnalyzer API: CancelQueryOperation|CancelQueryOperation]]: Cancels running operation using query identifier.
* [[QPR ProcessAnalyzer API: DeleteModel|DeleteModel]]: Deletes a model.
* [[QPR ProcessAnalyzer API: GetAnalysis|GetAnalysis]]: Calculates and returns QPR ProcessAnalyzer analysis.
* [[QPR ProcessAnalyzer API: GetAnalysisImageAsByteArray|GetAnalysisImageAsByteArray]]: Get [[Flowchart Analysis in QPR ProcessAnalyzer Excel Client|Flowchart Analysis]] as image.
* [[QPR ProcessAnalyzer API: GetModels|GetModels]]: Can be used to query QPR ProcessAnalyzer model related information.
* [[QPR ProcessAnalyzer API: GetStream|GetStream]] can be used to query contents of a stream bound to the given session identified by given stream id.
* [[QPR ProcessAnalyzer API: GetUsers|GetUsers]]: Can be used to query QPR ProcessAnalyzer model related information.
* [[QPR ProcessAnalyzer API: LogOff|LogOff]]: Logs off the user session.
* [[QPR ProcessAnalyzer API: QueryObjectProperties|QueryObjectProperties]] returns all the listed properties queried for all the listed objects identified by unique identifiers.
* [[QPR ProcessAnalyzer API: ResetModelCache|ResetModelCache]]: Can be used to clear all cached model information of the given model.
* [[QPR ProcessAnalyzer API: RunScript|RunScript]] can be used to execute given PA script using given parameters.
* [[QPR ProcessAnalyzer API: SetModel|SetModel]]: Can be used to set model related information.
* [[QPR ProcessAnalyzer API: SetUser|SetUser]]: Can be used to set user information.
* [[QPR ProcessAnalyzer API: ValidateModel|ValidateModel]] can be used to perform all the pending tasks stored in the work queue of the given model.
* [[QPR ProcessAnalyzer API: GetUsers|GetUsers]] can be used to get users.
* [[QPR ProcessAnalyzer API: GetUserPermissions|GetUserPermissions]] can be used to query permissions given user has for a set of objects.
* [[QPR ProcessAnalyzer API: GetUserRoles|GetUserRoles]] can be used to get available user roles.
* [[QPR ProcessAnalyzer API: GetUsers|GetUsers]] can be used to get users.

== Examples ==
=== JavaScript Examples ===
<pre>
//login
$.ajax({
"method": "POST",
"url": "http://localhost/qprpa/Mainservice.svc/webHttp/Authenticate",
"dataType": "json", "contentType": "application/json; charset=utf-8",
"data": JSON.stringify({
'logOnName': '<username>',
'password': '<password>',
'parameters': ''
})
});
</pre>

<pre>
//create user
$.ajax({
"method": "POST",
"url": "http://localhost/qprpa/Mainservice.svc/webHttp/SetUser",
"dataType": "json", "contentType": "application/json; charset=utf-8",
"data": JSON.stringify({
"sessionId": sessionId,
"user": {"Name": "user", "FullName": "first last" },
"parameters": [{"Key": "Password", "Value": "demo"}]
})
});
</pre>

<pre>
//add user to group, value 8:12:0 is user:group:member type
$.ajax({
"method": "POST",
"url": "http://localhost/qprpa/Mainservice.svc/webHttp/ModifyUserRelations",
"dataType": "json", "contentType": "application/json; charset=utf-8",
"data": JSON.stringify({
"sessionId": sessionId,
"parameters": [{"Key": "AddGroups", "Value": "8:12:0"}]
})
});
</pre>

<pre>
//log off
$.ajax({
"method": "POST",
"url": "http://localhost/qprpa/Mainservice.svc/webHttp/LogOff",
"dataType": "json", "contentType": "application/json; charset=utf-8",
"data": JSON.stringify({
"sessionId": sessionId
})
});
</pre>

=== List Users (PowerShell) ===
<pre>
$paService=New-WebServiceProxy –Uri "http://localhost/qprpa/MainService.svc"
$connection=$paService.Authenticate("username", "password", @())
$token=$connection.GetValue(0).Value

$param=@()
$users=$paService.GetUsers($token, $null, $param)
$users
$paService | get-member | ? {$_.definition -match "GetAnalysis"}
</pre>

=== Update Model Configuration (PowerShell) ===
<pre>
$paService=New-WebServiceProxy –Uri "http://localhost/qprpa/MainService.svc"
$connection=$paService.Authenticate("username", "password", @())
$token=$connection.GetValue(0).Value
$param=@()
$modelId=@(2)
$model=$paService.GetModels($token,$modelId, $param)

$model[0]
$model[0].ConfigurationJson = "{}"

$paService.SetModel($token,$model[0], $param)
</pre>

=== Get Flowchart Image (PowerShell) ===
<pre>
$paService=New-WebServiceProxy –Uri "http://localhost/qprpa/MainService.svc"
$connection=$paService.Authenticate("username", "password", @())
$token=$connection.GetValue(0).Value

$filterId = 13
$analysisType = 0
$processAnalysisType = 4
$minTransitionPercentage = 0.0

$png= $paService.GetAnalysisImageAsByteArray($token,$filterId,1, $analysisType,1, $processAnalysisType,1 , $minTransitionPercentage,1)
[IO.File]::WriteAllBytes('c:\tmp\image.png', $png)
</pre>

QPR ProcessAnalyzer API

2018-10-24T07:42:25Z

VesKivi: /* Functions in the Web Service API */

QPR ProcessAnalyzer Web Service API (Application Programming Interface) can be used to automate operations and to create integration with other applications. All Web Service operations only accept HTTP POST method (HTTP GET is not allowed).

== Functions in the Web Service API ==
The following functions are available:
* [[QPR ProcessAnalyzer API: Authenticate|Authenticate]]: Tries to authenticate given user with given password and authentication parameters.
* [[QPR ProcessAnalyzer API: GetModels|GetModels]]: Can be used to query QPR ProcessAnalyzer model related information.
* [[QPR ProcessAnalyzer API: GetAnalysisImageAsByteArray|GetAnalysisImageAsByteArray]]: Get [[Flowchart Analysis in QPR ProcessAnalyzer Excel Client|Flowchart Analysis]] as image.
* [[QPR ProcessAnalyzer API: QueryObjectProperties|QueryObjectProperties]] returns all the listed properties queried for all the listed objects identified by unique identifiers.
* [[QPR ProcessAnalyzer API: ResetModelCache|ResetModelCache]]: Can be used to clear all cached model information of the given model.
* [[QPR ProcessAnalyzer API: SetModel|SetModel]]: Can be used to set model related information.
* [[QPR ProcessAnalyzer API: ValidateModel|ValidateModel]] can be used to perform all the pending tasks stored in the work queue of the given model.
* [[QPR ProcessAnalyzer API: RunScript|RunScript]] can be used to execute given PA script using given parameters.
* [[QPR ProcessAnalyzer API: GetStream|GetStream]] can be used to query contents of a stream bound to the given session identified by given stream id.

== Common Properties for all Object Types ==
The following properties are supported by all ProcessAnalyzer object types. These properties are used in the '''properties''' parameter of the [[QPR ProcessAnalyzer API: QueryObjectProperties|QueryObjectProperties]] function:
* '''typename''': Name of the type of the object.
* '''name''': Name of the given object.
* '''properties''': List of all the supported properties for given object.
* '''relatedcount''': Integer number of how many child nodes there are in the next level of given hierarchy. This is 0 if the element doesn't support the relation or there are no child objects for the given object in given hierarchy. Requires hierarchy-parameter to be defined.

== Object Types ==
=== DataTable ===
The following properties are supported by the DataTable object type:
* '''typename''': "DataTable"
* '''<column identifier>''': A Data Table column name converted to script name and also prefixed with"custom_" when used as an object property name in QueryObjectProperties. For example: when the Data Table column name is "Actual", the column identifier is "custom_actual".
* All [[QPR ProcessAnalyzer Web Service API#Common Properties for all Object Types|common properties]]

=== Product ===
Properties of Product object type:
* '''typename''': "product"
* '''name''': Name of the product (QPR ProcessAnalyzer)
* '''version''': Dll version of the Qpr.ProcessAnalyzer.Core.dll
* All [[QPR ProcessAnalyzer Web Service API#Common Properties for all Object Types|common properties]]

Relations of Product object type:
* '''related''': Returns the related objects. Supported relation hierarchies is '''datatable''' which returns all the projects available for the user.

=== Project ===
Properties of the Project object type:
* '''typename''': "Project"
* All [[QPR ProcessAnalyzer Web Service API#Common Properties for all Object Types|common properties]]

Relations of the Project object type:
* '''related''': Returns the related objects. Supported relation hierarchies: '''datatable''' which returns all the data tables in given project available for the user.

== Identifying QPR ProcessAnalyzer Objects ==
QPR ProcessAnalyzer unique identifiers are used to uniquely identify any object in QPR ProcessAnalyzer. The format of a unique identifier is:

'''PA.<type>.<object>'''

In the format, '''<type>''' can be any of the following:
* '''0''': undefined (reserved, do not use)
* '''1''': project
* '''2''': data table
* '''3''': model
* '''4''': filter
* '''5''': bookmark

== Example Usage==
<pre>
//login
$.ajax({
"method": "POST",
"url": "http://localhost/qprpa/Mainservice.svc/webHttp/Authenticate",
"dataType": "json", "contentType": "application/json; charset=utf-8",
"data": JSON.stringify({
'logOnName': '<username>',
'password': '<password>',
'parameters': ''
})
});

//create user
$.ajax({
"method": "POST",
"url": "http://localhost/qprpa/Mainservice.svc/webHttp/SetUser",
"dataType": "json", "contentType": "application/json; charset=utf-8",
"data": JSON.stringify({
"sessionId": "547c1aa5-e85b-4642-bbb1-8cb656015002",
"user": {"Name": "user", "FullName": "first last" },
"parameters": [{"Key": "Password", "Value": "demo"}]
})
});

//add user to group, value 8:12:0 is user:group:member type
$.ajax({
"method": "POST",
"url": "http://localhost/qprpa/Mainservice.svc/webHttp/ModifyUserRelations",
"dataType": "json", "contentType": "application/json; charset=utf-8",
"data": JSON.stringify({
"sessionId": "749dcbdb-e57b-434b-a739-1f4ddc7ebc30",
"parameters": [{"Key": "AddGroups", "Value": "8:12:0"}]
})
});

//log off
$.ajax({
"method": "POST",
"url": "http://localhost/qprpa/Mainservice.svc/webHttp/LogOff",
"dataType": "json", "contentType": "application/json; charset=utf-8",
"data": JSON.stringify({
"sessionId":"75aa3d08-5ad9-4b0b-8981-7daca98348cd"
})
});
</pre>

== PowerShell example of listing users ==
<pre>
$paService=New-WebServiceProxy –Uri "http://localhost/qprpa/MainService.svc"
$connection=$paService.Authenticate("username", "password", @())
$token=$connection.GetValue(0).Value

$param=@()
$users=$paService.GetUsers($token, $null, $param)
$users
$paService | get-member | ? {$_.definition -match "GetAnalysis"}
</pre>

== PowerShell example update model configuration ==
<pre>
$paService=New-WebServiceProxy –Uri "http://localhost/qprpa/MainService.svc"
$connection=$paService.Authenticate("username", "password", @())
$token=$connection.GetValue(0).Value
$param=@()
$modelId =@(2)
$model=$paService.GetModels($token,$modelId, $param)

$model[0]
$model[0].ConfigurationJson = "{}"

$paService.SetModel($token,$model[0], $param)
</pre>

== PowerShell example get flowchart image ==
<pre>
$paService=New-WebServiceProxy –Uri "http://localhost/qprpa/MainService.svc"
$connection=$paService.Authenticate("username", "password", @())
$token=$connection.GetValue(0).Value

$filterId = 13
$analysisType = 0
$processAnalysisType = 4
$minTransitionPercentage = 0.0

$png= $paService.GetAnalysisImageAsByteArray($token,$filterId,1, $analysisType,1, $processAnalysisType,1 , $minTransitionPercentage,1)
[IO.File]::WriteAllBytes('c:\tmp\image.png', $png)
</pre>

QPR ProcessAnalyzer Release Notes

2018-10-10T07:28:59Z

VesKivi: /* Next Release: QPR ProcessAnalyzer 2018.7 (release date 2018-10-10) */

This page lists new features and fixed issues for each QPR ProcessAnalyzer release. For information on the compatibility of different versions, see [[QPR ProcessAnalyzer Version Compatibility Matrix|Version Compatibility Matrix]]. Contact [mailto:customercare@qpr.com? QPR Customer Care] if you need more information.

== Next Release: QPR ProcessAnalyzer 2018.7 (release date 2018-10-10) ==
Build number: 2018.7.0.38036, Model compatibility version: 2, Database version: 58, Stream version: 7.

'''Features for QPR ProcessAnalyzer Server:'''
* 307319: Expression language: [[Generic_Properties_and_Functions_in_QPR_ProcessAnalyzer_Expressions#Other_functions | GroupBy and GroupByValue -functions]].
* 307370: PAPO/A1 cell case/event/event type/variation count should only show cases user has permissions in case level security.
* 307369: String handling functions in the expression language.
* 307424: KPI analysis in generic context.
* 307439: Quick & easy expression language improvements.
* 307336: PA performance improvement (part 1).

'''Fixed bugs in QPR ProcessAnalyzer UI:'''
* 218673: Null values in PA expression language should appear as nulls in datasets.
* 218693: Performance for PAPO's data grids has been optimized.

'''Fixed bugs in QPR ProcessAnalyzer Server:'''
* 218453: .TMP files is not deleted always. After 65k .TMP files exist then PA service stop working. If issue is encountered, workaround is to manually delete .TMP files (e.g. files are located in folder C:\Windows\Temp or C:\Users\<pa_applicationpool_user>\AppData\Local\Temp).
* 218643: InMemory: Open model after pacm file import fails to "Object reference not set to an instance of an object.".
* 218652: Access denied. Unexpected ModelEventLog dropping object with from cache.
* 218648: Import empty model with filter crash (evevenlog.Content is null).
* 218685: XES import runs out of memory when importing BPIC2018 -model.
* 218690: Expressions returning boolean values should be returned to QPR UI as booleans.
* 218687: Average and Sum functions should return null for zero length arrays instead of zero.
* 218705: InMemoryCore: TotalCost in event analysis has incorrect values.
* 218704: Mismatch in case counts in Variation Analysis when event type filter has been applied.
* 218709: FileType parameter not select correct stream compression mode in ImportFromStream.
* 218698: The given key was not present in the dictionary - Variation Analysis error.
* 218710: PAPO case analysis is currently failing.

== Latest Release: QPR ProcessAnalyzer 2018.6 (release date 2018-08-29) ==
Build number: 2018.6.0.37869, Model compatibility version: 2, Database version: 58, Stream version: 7.

'''Release Highlights'''
* KPI Analysis update: The KPI Analysis feature has new updates to it. The Analysis Menu design has new options that allow for efficient creation of KPI analysis presentations. Menu items have been grouped into sub-groups making finding analysis options much swifter.
* Model load on startup: You can now define which models are loaded onto memory on startup allowing for quicker setup of QPR ProcessAnalyzer servers. This loads the key models needed directly into memory without any separate in-memory loading.

'''Features for QPR ProcessAnalyzer UI:'''
* 307351: KPI analysis UI - part 2

'''Features for QPR ProcessAnalyzer Server:'''
* 307323: [[PA Migration to 2018.6 |Remove old PA web client]].
* 307200: [[QPR_ProcessAnalyzer_Model_JSON_Settings#Necessary_IIS_setup |PA model management: PA model automatic loading on startup]].
* 307350: KPI analysis UI - part 2 (server side).
* 307208: PA model management: PA model status information to expression language.

'''Fixed bugs in QPR ProcessAnalyzer UI:'''
* 218391: PA UI Flowchart selection does not clear automatically.
* 218606: Edit mode is ON > Floating Action Buttons are not clickable.
* 218626: PAPO: some popup menus are not closed properly in IE 11.
* 218607: PAPO: popup menu is not displayed in IE 11.

'''Fixed bugs in QPR ProcessAnalyzer Server:'''
* 218597: PA Exception details show null in QPR UI.
* 218575: Incorrect results in conformance analysis calculation.
* 218540: KPI analysis not working properly.
* 218314: Variation analysis shows duplicate variations if there are excluded event types.
* 218604: PA Excel client does not log enough during connection creation.
* 218624: Estimatedmemory not calculated correctly when model not have events.
* 218396: KPI analysis - ApplyAnalysisFilters. InvalidOperationException: Sequence contains no elements.´
* 218628: PAPO: Error popup appears, "Error processing QPR ProcessAnalyzer request.
* 218631: Performance improvements (Path analysis was slow).
* 218485: ProcessAnalyzer Excel client cannot be removed from Programs and Features, as it wont show up there.
* 217775: GetAnalysis(18) should write a progress log entry after each chunk.
* 217653: SQL command not in log when ODBC connection failed.

== QPR ProcessAnalyzer 2018.5 (release date 2018-07-17) ==
Build number: 2018.5.0.37716, Model compatibility version: 2, Database version: 58, Stream version: 7.

'''Release Highlights'''
*QPR ProcessAnalyzer Deployment Package for QPR UI: The new version comes with preloaded QPR UI views that can instantly kickstart your Process Mining experience. These views are readymade and require no extra configuration. These views introduce new functionalities, such as ready made conformance views, for deploying a more varied Process Mining offering.
*New Dashboard Design features: Panels can be now instantly developed and evaluated in viewer mode, allowing for a more powerful dashboard creation. The object placing logic has been overhauled, allowing for new options in creating dashboards.

'''Features for QPR ProcessAnalyzer Server:'''
* 307338: [[QPR_ProcessAnalyzer_API:_ResetModelCache | Web service support to load and drop PA models]].

'''Fixed bugs in QPR ProcessAnalyzer UI:'''
* 218536: PAPO: KPI Analysis should not be available from Control Windows.
* 218519: The numerical values in QPR ProcessAnalyzer Influence Analysis were aligned to the left.
* 217888: Selection lost from influence analysis table when user slightly adjusts browser window or panel/presentation object window size.
* 218465: PAPO: Newly created filters are not displayed in the list.
* 218556: PAPO: An unnecessary vertical scrollbar was shown after PAPO Case Analysis was resized.
* 218520: PAPO: Filter does not recognize decimal separators.

'''Fixed bugs in QPR ProcessAnalyzer Server:'''
* 218537: ODBC xlsx loading failed with data format issue.
* 218495: Changing default filter does not drop cached model information.
* 218550: Accessing projects from expression language fails in some cases.
* 218549: Datatable import from Excel sheet data corruption if first column value is empty.
* 218558: Errors in default.aspx. Login fails.

== QPR ProcessAnalyzer 2018.4 (release date 2018-06-11) ==
Build number: 2018.4.0.37669, Model compatibility version: 2, Database version: 58, Stream version: 7.

'''Release Highlights:'''
* ODBC driver support for QPR ProcessAnalyzer: Use external data sources to create a dynamic model that is updated every time the model is loaded. Using the ODBC driver, the model data can be accessed from a separate data source. All the event data information can be defined in JSON format allowing for automatic model creation.
* KPI Analysis: A new analysis is added to QPR ProcessAnalyzer. KPI Analysis utilizes the KPI expression engine for creating visualizations of data. KPI Analysis is a fully fledged analysis that can be used in conjuction with the existing QPR ProcessAnalyzer analysis for more focused results. In addition, KPI Analysis is available as a separate QPR UI view for creation of dashboards that present real-time data taken from QPR ProcessAnalyzer.
* Tabular Analysis results updated with data types: Analysis featuring tabulated data are now automatically updated with correct data types. Automatic data types allow for exporting the data in a format that can be used in other compatible tools as the data types are automatically defined into the data.

'''Features for QPR ProcessAnalyzer UI:'''
* 307265: [[KPI Analysis|KPI analysis UI]] - part 1 (KPI).
* 307278: The tabular analyses (e.g. Case analysis) in QPR ProcessAnalyzer UI now have the correct column data types based on the information from the QPR ProcessAnalyzer server.

'''Features for QPR ProcessAnalyzer Server:'''
* 307204: [[QPR_ProcessAnalyzer_Model_JSON_Settings#Model Datasources|Load PA model from ODBC datasource]].
* 307313: Expression language improvements - part 7 (performance).
* 307317: Update new [[QPR_End_User_Software_License_Agreement|EULA]] to QPR ProcessAnalyzer.

'''Fixed bugs in QPR ProcessAnalyzer UI:'''
* 218487: Influence analysis for Flowchart changes the flowchart settings.
* 218498: No history entry is created while changing visibility threshold via stepper or context variable.
* 218508: PAPO variation analysis should limit the queried number of variations.
* 218513: PAPO settings buttons cover analysis content.
* 218532: PAPO: Profiling analysis does not work with data loaded via ODBC.

'''Fixed bugs in QPR ProcessAnalyzer Server:'''
* 218515: IIS crashes in kernel during Odbc query reading csv/xlsx file with Microsoft Access Text Driver and Microsoft Excel Driver.
* 218484: ImportEvents fails in StartBackground mode.
* 218525: InMemory CaseAnalysis ShowAllCases not work if there is cases without events.
* 218463: Issue to install excel client (part 2).

== QPR ProcessAnalyzer 2018.3 (release date 2018-04-23) ==
Build number: 2018.3.0.37545, Model compatibility version: 2, Database version: 58, Stream version: 7.

'''Release Highlights:'''
*Conformance Checking is supported in QPR ProcessAnalyzer. Using the KPI Expression Language as a basis, process mining models can be compared to BPMN notation and analyzed if the process data conforms to the BPMN design. These results are implemented in ChartView and KPI Expression Language allows them to be implemented into dashboards.
*BPMN Editor has been added to ChartView. You can now import and design BPMN process maps for use in conformance analysis. The BPMN editor is a web component that is used in the browser, allowing for quick and easy process design. The designs can also be exported for further use.
*Flowchart Visibility Settings have been overhauled with a new visual presentation. New stepper elements allow for more flexible flow threshold settings while maintaining a user-friendly approach.

'''Features for QPR ProcessAnalyzer UI:'''
* 307276: Remove PAPO Offline mode.
* 307193 & 307298: The [[Flowchart_Analysis_(PAPO)#Visibility_Settings|Flowchart Visibility Settings]] were improved.
'''Features for QPR ProcessAnalyzer Server:'''
* 307077: [[QPR_ProcessAnalyzer_System_Requirements#System_Requirements_for_QPR_ProcessAnalyzer_Server | Support for Windows Server 2016 (PA Service)]].
* 307246: Expression function to calculate conformance to BPMN.
* 307297: Expression language improvements - part 6.
* 307301: In-memory memory usage optimizations.
'''Fixed bugs in QPR ProcessAnalyzer UI:'''
* 218306: PAPO control window is affected by analysis window's 'Show as' setting.
'''Fixed bugs in QPR ProcessAnalyzer Server:'''
* 218241: PA Duration Analysis In-Memory - numbers for Events and Cases too high (focus flow).
* 218456: Issue to install excel client (part 1).

== QPR ProcessAnalyzer 2018.2 (release date 2018-03-12) ==
Build number: 2018.2.0.37453, Model compatibility version: 2, Database version: 58, Stream version: 7.

'''Release Highlights:'''
* Case Permissions have been added to the data security featureset. Case Permissions allow for limiting model visibility based on rules that reference the case attributes of a set model. Case permissions can refer to usernames or user groups, creating a link between the attributes and groups.
* Influence Analysis for Case Attributes has been simplified. The feature presents basic information relating to the root causes when it is opened. If further information is needed, this can be accessed via the feature menu.
* DataGrids support Excel exporting. You are now able to export data from fixed dashboards featuring datagrids. With this feature, you can take your data for further manipulation using Microsoft Excel.
* Chartview has been improved with a new layout and excel exporting. The new layout allows for quicker access to creating charts using the ChartView tool. With the exporting functionality, the views created are exported for use in presentations in Microsoft Excel.
* KPI Expression Language has been added with support for Influence Analysis for Case Attributes. This allows for further creation of dashboards with specific analysis result queries. Using the KPI expression language, dashboards can be made to present up-to-date data based on influence analysis results.
* Dataset tag support for data visualization. Adding dataset tags will help in creating more dynamic chart presentations as the data can be inserted into the JSON settings of charts and datagrids.

'''Features for QPR ProcessAnalyzer UI:'''
* 307220: The [[Influence_Analysis_for_Case_Attributes_(PAPO)|Influence Analysis for Case Attributes]] settings now has a toggle for showing and hiding the detail columns.

'''Features for QPR ProcessAnalyzer Server:'''
* 307273: [[QPR ProcessAnalyzer Web Service API#Example| PA model JSON settings]].
* 307269: [[QPR_ProcessAnalyzer_Model_JSON_Settings#Case_Permissions |Case permissions]].
* 307261: PA InMemory core, part 8 (Path Analysis).
* 307282: PA KPI's and expressions (part 5).
'''Fixed bugs in QPR ProcessAnalyzer UI:'''
* 218426: Using PAPO with customers model crashes PA Server (Entice Changes).

'''Fixed bugs in QPR ProcessAnalyzer Server:'''
* 218371: Event types aren't provided to PAPO by PA server.
* 218372: Having multiple expressions in one selection item in a JSON filter does not work.
* 218375: Empty comparison -setting with nonempty filter -setting causes influence analysis to return incorrect results.
* 218380: PA Activation ends one day before the actual end date.
* 218362: WebService GetAnalysisAsImage does not work.
* 218389, 218397: Performance issues in PA in-memory core with multiple simultaneous users.
* 218412: PercentageNumber property is not set properly in PA analyses.
* 218410: Event attribute profiling event amount mismatch.
* 218404: Using PAPO with customers model crashes PA Server (PA changes).
* 218430: Pre-release mandatory PA bugfixes.

== QPR ProcessAnalyzer 2018.1 (release date 2018-01-31) ==
Build number: 2018.1.0.37330, Model compatibility version: 2, Database version: 57, Stream version: 7.

'''Release Highlights:'''
* ChartView is introduced as a new QPR UI view. This interactive view allows the creation of customized charts to answer specific business needs, with measures and dimensions the user has selected. ChartView comes preloaded with numerous different presentation features for the creation of customized charts fit for any business need.
* New Table Filtering for Data Table Views. A new Excel-style filtering feature has been added to the different analysis features, such as Influence Analysis for Case Attributes and Event Analysis. The feature allows the presentation and comparison of different data using robust filters.
* The QPR UI version of QPR ProcessAnalyzer has an overhauled popup menu. Selecting different analysis and creating new filters is quicker and new icons have been added for added clarity.
* XES filetype importing support. The IEEE TaskForce standardized XES logs are now supported by QPR ProcessAnalyzer. This filetype aims to unify the transactional data produced by information systems and makes them usable in tools used in data analysis.

'''Full Features for QPR ProcessAnalyzer UI:'''
* 307244: The various tables (e.g. Case Analysis) in QPR ProcessAnalyzer UI received filtering functionality familiar to the one in Microsoft Excel.
* 307163: Popup menu improvements.
* 307224: Cache model information into browser side.
'''Features for QPR ProcessAnalyzer Server:'''
* 307271: PA InMemory core, part 7 (Canceling analysis).
* 307247: XES Event log file format support.
* 307257, 307270: PA KPI's and expressions (part 3, 4).
* 307211: Enable custom data sources: Selections as JSON.
'''Fixed bugs in QPR ProcessAnalyzer UI:'''
* 218327: PAPO Grid view row selection issues when opening popup menu.
* 218328: PAPO Missing null check in ModelState.
* 218365: PAPO: Settings etc. buttons not visible in the latest chrome version (automatically updated).
* 218324: Fixed an issue where a dataset wasn't refreshed when a context variable was changed from PAPO.
'''Fixed bugs in QPR ProcessAnalyzer Server:'''
* 218288: PA service installation with DeployPAService.ps1.
* 218291: Problem with --#GetAnalysis type 31 (filter rules).
* 218315: PAPO: InMemoryCore: Offline mode shows incorrect case attribute values.
* 217922: Filtering Flow Table with Case Attribute is too slow.
* 218321: PA core - Internal server error in PAPO when duration analysis result is empty.
* 218322: Flow analysis results not always in same order (InMemory).
* 218340: Not allow to delete default filter ("No access/Access denied").
* 218345: Unknown filter rule. The given key was not present in the dictionary.
* 218363: Attribute values are sent to clients as strings from InMemory profiling analysis.
* 218365: PAPO: Settings etc. buttons not visible in the latest chrome version (automatically updated).
* 218379: PAPO: Side panels visible in multi papo even if they should be closed and invisible.

== QPR ProcessAnalyzer 2017.9 (release date 2017-12-19) ==
Build number: 2017.9.0.37199, Model compatibility version: 2, Database version: 57, Stream version: 7.

'''Release Highlights:'''
* The Filtering system on the WebUI has been updated. The user can now easily rename filters, add specific permissions to control privacy of the filters and delete filters easily. The filtering system has an improved interface for easier handling of the filters.
* New Expression language for KPI calculation. This new language allows power users to create analysis that are customized to their needs and creates the possibility for caluclating KPIs inside the server core. This JSON based language allows users to take their analysis functions even further.
* Other improvements in this release include performance improvements and further development of the in-memory mode.

'''Features for QPR ProcessAnalyzer UI:'''
* 307237: PAPO: There's now a new "DisabledFunctionalities" [[QPR_ProcessAnalyzer_Presentation_Object_(PAPO)#PAPO.27s_Context_Variables|context variable for using with PAPO]] to define which PAPO functionalities should not be.
* 307173: It's now possible to edit the Name and Privacy of a filter in QPR ProcessAnalyzer UI, as well as delete a filter.
'''Features for QPR ProcessAnalyzer Server:'''
* 307235: PA InMemory core, part 5 (Flow Analysis).
* 307262: PA InMemory core, part 6 (Canceling model loading).
* 307257: PA KPI's and expressions (part 2).
'''Fixed bugs in QPR ProcessAnalyzer UI:'''
* 218251: Multi-PAPO: Model page shows when model button of one papo has been disabled.
* 218275: Change PA WS methods from GET to POST.
* 218132: PAPO: Zoom change when item is selected from Variation Analysis.
* 218196: PAPO: Variation Analysis: graph bar lengths doesn't match with data.
* 218157: PAPO: QPR UI Graphics messed in Influence Analysis for Flowchart.
'''Fixed bugs in QPR ProcessAnalyzer Server:'''
* 218241: Duration Analysis In-Memory - numbers for Events, Median duration and Average duration are too high.
* 218046: System.ArgumentException: Value of '-170' is not valid for 'red'. 'red' should be greater than or equal to 0 and less than or equal to 255.
* 218275: Change PA WS methods from GET to POST.

== QPR ProcessAnalyzer 2017.8 (release date 2017-11-07) ==
Build number: 2017.8.0.37022, Model compatibility version: 2, Database version: 57, Stream version: 7.

'''Release Highlights:'''
* The QPR UI interface features a new feature: Profiling Event Analysis. Now you can drilldown to your events and see what event attributes the event types in your data contain. You can also use this knowledge to benchmark your process.
* The Selection logic in the QPR UI has been updated. You no longer have to update after making a selection, as the selections are responsive and updated automatically. This leads to more responsive and effective analysis.
* In-Memory Engine has been improved upon, allowing for more efficient analysis for small-to-mid-size models. This update gives you improved performance in your analysis operations. This feature applies for all analysis features and improves the performance of the software immensely, giving you faster operations.
* The Excel Client has been preloaded with new and updated demo models that demonstrate the power of QPR ProcessAnalyzer. New Models include Healthcare and Insurance claims process models. These give you a great idea on how to utilize QPR ProcessAnalyzer.

'''Features for QPR ProcessAnalyzer UI:'''
* 307161: When selecting items in PAPO, the "Selected" context variables are now updated without the need to explicitly do the update. As a result, the "Select into UI Context" item was removed from the PAPO popup menu. This means that the TempSelectedActivities, TempSelectedTransitions, TempSelectedVariations, and TempSelectedCounts context variables were removed, and their functionality changed to be in the SelectedActivities, SelectedTransitions, SelectedVariations, and SelectedCounts context variables.
* 307061: PAPO now has the [[Profiling_Analysis_(PAPO)#Profiling_Event_Analysis|Profiling Event Analysis]] available.

'''Features for QPR ProcessAnalyzer Server:'''
* 307219: Excel client demo model changes.
* 307216: To improve performance, QPR ProcessAnalyzer can now be configured to run the analyses in the server memory instead of the database.

'''Fixed bugs in QPR ProcessAnalyzer UI:'''
* 218060: PAPO doesn't add transition duration but case duration filter rule type when Duration analysis shows transition duration.
* 218039: PAPO: Analysis window has incorrect width when opening view (splitter issue).
* 218036: PAPO: Web UI shows archived/recycled PA models.
* 218100: PAPO: Once Analysis view show "No records to display" message, then switch to other analysis view is not possible for current model.
* 218159: PAPO: Popup menus don't work in tabular analyses in IE11.
* 218169: PAPO: SelectedAttributeType parameter in PA request has invalid value when switching model and applying filter that requires model change.
'''Fixed bugs in QPR ProcessAnalyzer Server:'''
* 218148: InMemory: Include Only Event Types does not work with sampled models.
* 218179: InMemory: Amount of cases in Duration analysis when flow is selected.

== QPR ProcessAnalyzer 2017.7 (release date 2017-09-25) ==
Build number: 2017.7.0.36871 <s>36762</s>, Model compatibility version: 2, Database version: 57, Stream version: 7.

'''Release Highlights:'''
* New In-Memory core for Process Analysis calculation. This server-side improvement can improve Analysis Performance speed up to 20 times faster than previous releases. This is achieved by offloading the memory functions directly to the application server where in the previous versions of the software, the SQL server handledthe workload.
* This release also features different bug fixes and performance improvements, aiming to improve your process analysis experience. Combining these features with the new WebUI platform release, the implementation of your data for analysis and improvement is smoother than ever.

'''Features for QPR ProcessAnalyzer UI:'''
* 307060: CSS styling and grid configuration improvements (technical feature).
'''Fixed bugs in QPR ProcessAnalyzer UI:'''
* 217986: The pie (in profiling analysis) is rendered initially too small.
* 217721: One extra scroll position / zoom -history entry created when PAPO is initialized.
* 218052: Flowchart shows incorrect duration.
* 217978: Profiling analysis is empty in Analysis window when opening splitter again.
* 217926: Duration Analysis in control window doesn't select all "other" cases.
* 217708: It is not possible to make multiselection using radial graph.
* 218043: Issue with AnalysisWindowSize context variable.
* 218058: Profiling Analysis for Case Attributes doesn't work when using numerical case attribute.
* 218035: Switch model from filter: Error processing PA request. Invalid column name 'CA_VALUE_1290462'.
'''Fixed bugs in QPR ProcessAnalyzer Server:'''
* 218024: Add log writing to odbc query.
* 217836: Error when opening filter in customer environment.
* 217995: ImportCaseAttributes command does not import cases properly.
* 218094: PA error text doesn't have information which value have problem.
* 218145: Input String was not in the correct format error when opening customer model.

== QPR ProcessAnalyzer 2017.6 (release date 2017-08-15) ==
Build number: 2017.6.0.36561, Model compatibility version: 2, Database version: 57, Stream version: 7.

'''Release Highlights:'''
* The major feature of this release is the support for Multiwindow Process Analysis. Need to create new, custom views for specific analysis? It's now possible with the customizable dashboards offered.
* If you want to take dashboard customization even further, you can now add SVG Backgrounds to views and panels. You can make your dashboards look more impressive by adding a SVG image to it.
* For powerful analysis, the new version offers a table view for Profiling Analysis. For larger datasets with multiple attributes, this is an extremely useful feature as you can easily profile the data with the table.
* If you want to do accurate lead time analysis, you will find the table view for Duration Analysis very useful. The data presented in the tables offers you accurate data and can be used for further analysis.
* Managing navigation and creating links for dashboards has been furthered with the addition of Identifier Support. You can now give your dashboards identifiers that you choose, making your dashboard management much easier.
* For more under the hood features, we implemented dynamic tag support. Dynamic tags allow you to add functional behaviour to dashboards by specifying set context variables. This will lead to more responsive dashboards!
* Finally, we redesigned the zoom buttons. Not only did we redesign the buttons, but we implemented into the analysis window! By adding a zoom button to the analysis window, we now offer you the chance more control on the visualization of the analysis.

'''PAPO Features:'''
* 307063: The [[Profiling_Analysis_(PAPO)|Profiling Analysis]] can now be shown as a table.
* 307012: The zoom button look was changed.
* 307064: The [[Duration_Analysis_(PAPO)|Duration Analysis]] can now be shown as a table.

'''Fixed bugs:'''
* 218010: Sample files are missing from PA Excel Client.

'''PAPO Fixed bugs:'''
* 218005: The Profiling Analysis case attribute selection was reset to the default value after applying a filter.
* 217876: The flowchart was not centered after being opened in the {{DriverNameForTheDay}} window.
* 217934: Fixed an issue where the "Limit to" field in the analysis settings could be used to enter unacceptable values and could display negative values.
* 218028: The Model and Analysis buttons were shown in the {{DriverNameForTheDay}} and {{AnalysisNameForTheDay}} windows even when the windows were hidden by using the splitter.

== QPR ProcessAnalyzer 2017.5 (release date 2017-07-06) ==
Build number: 2017.5.0.36503, Model compatibility version: 2, Database version: 57, Stream version: 7.

'''PAPO Features:'''

* 307067: The [[Variation_Analysis (PAPO)|Variation Analysis]] in QPR ProcessAnalyzer Presentation Object can now be run in the {{DriverNameForTheDay}} window.<br>
* 307021: The QPR ProcessAnalyzer Presentation Object now has [[Case_Analysis_(PAPO)|Case Analysis]].<br>
* 307020: The QPR ProcessAnalyzer Presentation Object now has [[Event_Analysis_(PAPO)|Event Analysis]].<br>
* 307058: The QPR ProcessAnalyzer Presentation Object now has [[Event_Type_Analysis_(PAPO)|Event Type Analysis]].<br>
* 307105: PAPO: In the Flowchart analysis, some terms, default values, and button visibility were changed.<br>
'''Fixed bugs:'''
* 217925: 'SelectedCaseAttributeTypes' is not supported in --#CreateFilter.
* 217710: Copyright shows 2016.
* 217973: PAPO now uses the web browser's date and number formatting when showing date and numbers in data grids/tables.<br>
* 217946: Fixed an issue in PAPO, where the table grid didn't fit the window after switching from Offline Mode to normal mode on Case analysis<br>

== QPR ProcessAnalyzer 2017.4 (release date 2017-05-23) ==
Build number: 2017.4.0.36424, Model compatibility version: 2, Database version: 57, Stream version: 7.

'''PAPO Features:'''
* 307022: The Profiling Analysis can now be used in the Control window in the [[QPR_ProcessAnalyzer_Presentation_Object_(PAPO)#QPR_ProcessAnalyzer_Presentation_Object_.28PAPO.29|QPR ProcessAnalyzer Presentation Object]] to select cases for the analysis in the Analysis window.<br>
* 307003: The buttons in the [[QPR_ProcessAnalyzer_Presentation_Object_(PAPO)#QPR_ProcessAnalyzer_Presentation_Object_.28PAPO.29|QPR ProcessAnalyzer Presentation Object (PAPO)]] were rearranged.<br>
* 307057: The Duration, Profiling, Influence, and Variation Analyses in [[QPR_ProcessAnalyzer_Presentation_Object_(PAPO)#QPR_ProcessAnalyzer_Presentation_Object_.28PAPO.29|QPR ProcessAnalyzer Presentation Object]] now have generic and some analysis specific settings supported.<br>
* 306969: The QPR ProcessAnalyzer Presentation Object now supports the [[QPR_ProcessAnalyzer_Presentation_Object_(PAPO)#Influence_Analysis_for_Case_Attributes|Influence Analysis for Case Attributes]] in the grid format.
* 307030: [[QPR_ProcessAnalyzer_Presentation_Object_(PAPO)#Duration_Analysis|Duration Analysis]] can now be used in the {{DriverNameForTheDay}} window of the QPR ProcessAnalyzer Presentation Object.

'''PA Features:'''
* 403516: Consolidate event names in PA example Excels (SAP_OrderToCash.xlsx, SAP_OrderToCash v2.xlsx and SAP_OrderToCash_Extended.xlsx).

'''Fixed bugs:'''
* 217845: Create Filter from CaseAttributeTrends with PA script doesn't work.
* 217830: Tab delimiter is not taken into use when datatable imported.
* 217902: SqlException thrown when opening influence analysis on a filter without any case attributes.

== QPR ProcessAnalyzer 2017.3 (release date 2017-04-11) ==
Build number: 2017.3.0.36338 <s>36324</s>, Model compatibility version: 2, Database version: 57, Stream version: 7.

'''Features:'''
* 305862: There now are new StartTime Limit and Maximum Text Length settings to be used with the [[Operation Log]] and the Operation Log Analysis [[QPR ProcessAnalyzer Scripting Commands#--.23GetAnalysis|GetAnalysis]] script command.
* 306983: PAPO - Highlight selected flow label in flowchart: selected flow labels are now clearly visible on the flowchart. Selected objects are highlighted on the flowchart.
* 306986 & 307017: The QPR ProcessAnalyzer Presentation Object (PAPO) now has a new [[QPR_ProcessAnalyzer_Presentation_Object_(PAPO)#Control_Window_and_Analysis_Window|window system]].
* 306987: PAPO - in-memory Variation analysis: Variation analysis is now supported in in-memory mode.
* 307000: The model shown in the QPR ProcessAnalyzer Presentation Object (PAPO) can now be changed via a menu.
* 306999: The Start and End symbols in the QPR ProcessAnalyzer Presentation Object (PAPO) flowchart were updated.
'''Fixed bugs:'''
* 217679: PA cannot add new case Attribute values to exising case via Excel if CaseId starts with leading zero.
* 217790: Filtering is too slow.

== QPR ProcessAnalyzer 2017.2 (release date 2017-02-28) ==
Build number: 2017.2.0.36218, Model compatibility version: 2, Database version: 56, Stream version: 7.

'''Features:'''
* 306966: Performance optimizations into PA database.
* 306930: Improved messages to SQL Queries.
* 306910: Implement importSalesforceQuery support for TLS 1.1. Note that the support from PA Salesforce Integration service has been discontinued.
* 306964: Make it possible to transfer the contents of a filter efficiently to UI.
'''Fixed bugs:'''
* 217605: Operation log throws some exception.
* 217546: Slow access to project by project name. ETL parameter: (SELECT 'ProjectName', 'name').
* 217363: ScriptLauncher should LogOff.
* 217618, 217636: PA Excel Client doesn't connect to PA Server when Windows performance counter is not accessible (part 1 and 2).
* 217650: System.DBNull objects returned from event analysis when IncludeCaseAttributeValues is used.

== QPR ProcessAnalyzer 2017.1 (release date 2017-01-16) ==
Build number: 2017.1.0.36111, Model compatibility version: 2, Database version: 55, Stream version: 7.

'''Features:'''

* 306899: The [[QPR ProcessAnalyzer Scripting Commands#--.23SendEmail|SendEmail]] script command now supports sending attachments.
* 306896: A [[Open R in QPR ProcessAnalyzer#Case_Prediction_Example_Script|case prediction Open R example script]] was added to QPR ProcessAnalyzer wiki.
* 306484: There is now a new [[QPR ProcessAnalyzer Scripting Commands#--.23ImportEventsIncremental|ImportEventsIncremental]] script command for synchronizing event data between a data table that holds event data and the specified model.
* 306906: The [[Script Log]] entries are now written to the database at the same time as the script is being run. There is also a new Script Log Report analysis type for the [[QPR ProcessAnalyzer Scripting Commands#--.23GetAnalysis|GetAnalysis]] script command for administrators to access script logs.

'''Fixed bugs:'''
* 217526: Log entries written as errors even if they are not.
* 217545: Session expires exceedingly often in a service deployed in AWS behind load balancer.
* 217591: Special characters in PA script parameters cause script to fail and hide the actual root cause of the failure.

== Old Releases ==
See older releases in [[QPR ProcessAnalyzer Release Archive]]
__NOTOC__

QPR ProcessAnalyzer Release Notes

2018-08-27T06:55:06Z

VesKivi: /* Next Release: QPR ProcessAnalyzer 2018.6 (planned release date 2018-08-28) */

This page lists new features and fixed issues for each QPR ProcessAnalyzer release. For information on the compatibility of different versions, see [[QPR ProcessAnalyzer Version Compatibility Matrix|Version Compatibility Matrix]]. Contact [mailto:customercare@qpr.com? QPR Customer Care] if you need more information.

== Next Release: QPR ProcessAnalyzer 2018.6 (planned release date 2018-08-28) ==
Build number: 2018.6.0.37869, Model compatibility version: 2, Database version: 58, Stream version: 7.

'''Features for QPR ProcessAnalyzer UI:'''
* 307351: KPI analysis UI - part 2 (client side).

'''Features for QPR ProcessAnalyzer Server:'''
* 307323: [[PA Migration to 2018.6 |Remove old PA web client]] .
* 307200: [[QPR_ProcessAnalyzer_Model_JSON_Settings#Necessary_IIS_setup |PA model management: PA model automatic loading on startup]].
* 307350: KPI analysis UI - part 2 (server side).
* 307208: PA model management: PA model status information to expression language.

'''Fixed bugs in QPR ProcessAnalyzer UI:'''
* 218391: PA UI Flowchart selection does not clear automatically.
* 218606: Edit mode is ON > Floating Action Buttons are not clickable.
* 218626: PAPO: some popup menus are not closed properly in IE 11.
* 218607: PAPO: popup menu is not displayed in IE 11.

'''Fixed bugs in QPR ProcessAnalyzer Server:'''
* 218597: PA Exception details show null in QPR UI.
* 218575: Incorrect results in conformance analysis calculation.
* 218540: KPI analysis not working properly.
* 218314: Variation analysis shows duplicate variations if there are excluded event types.
* 218604: PA Excel client does not log enough during connection creation.
* 218624: Estimatedmemory not calculated correctly when model not have events.
* 218396: KPI analysis - ApplyAnalysisFilters. InvalidOperationException: Sequence contains no elements.´
* 218628: PAPO: Error popup appears, "Error processing QPR ProcessAnalyzer request.
* 218631: Performance improvements (Path analysis was slow).
* 218485: ProcessAnalyzer Excel client cannot be removed from Programs and Features, as it wont show up there.
* 217775: GetAnalysis(18) should write a progress log entry after each chunk.
* 217653: SQL command not in log when ODBC connection failed.

== Latest Release: QPR ProcessAnalyzer 2018.5 (release date 2018-07-17) ==
Build number: 2018.5.0.37716, Model compatibility version: 2, Database version: 58, Stream version: 7.

'''Release Highlights'''
*QPR ProcessAnalyzer Deployment Package for QPR UI: The new version comes with preloaded QPR UI views that can instantly kickstart your Process Mining experience. These views are readymade and require no extra configuration. These views introduce new functionalities, such as ready made conformance views, for deploying a more varied Process Mining offering.
*New Dashboard Design features: Panels can be now instantly developed and evaluated in viewer mode, allowing for a more powerful dashboard creation. The object placing logic has been overhauled, allowing for new options in creating dashboards.

'''Features for QPR ProcessAnalyzer Server:'''
* 307338: [[QPR_ProcessAnalyzer_API:_ResetModelCache | Web service support to load and drop PA models]].

'''Fixed bugs in QPR ProcessAnalyzer UI:'''
* 218536: PAPO: KPI Analysis should not be available from Control Windows.
* 218519: The numerical values in QPR ProcessAnalyzer Influence Analysis were aligned to the left.
* 217888: Selection lost from influence analysis table when user slightly adjusts browser window or panel/presentation object window size.
* 218465: PAPO: Newly created filters are not displayed in the list.
* 218556: PAPO: An unnecessary vertical scrollbar was shown after PAPO Case Analysis was resized.
* 218520: PAPO: Filter does not recognize decimal separators.

'''Fixed bugs in QPR ProcessAnalyzer Server:'''
* 218537: ODBC xlsx loading failed with data format issue.
* 218495: Changing default filter does not drop cached model information.
* 218550: Accessing projects from expression language fails in some cases.
* 218549: Datatable import from Excel sheet data corruption if first column value is empty.
* 218558: Errors in default.aspx. Login fails.

== QPR ProcessAnalyzer 2018.4 (release date 2018-06-11) ==
Build number: 2018.4.0.37669, Model compatibility version: 2, Database version: 58, Stream version: 7.

'''Release Highlights:'''
* ODBC driver support for QPR ProcessAnalyzer: Use external data sources to create a dynamic model that is updated every time the model is loaded. Using the ODBC driver, the model data can be accessed from a separate data source. All the event data information can be defined in JSON format allowing for automatic model creation.
* KPI Analysis: A new analysis is added to QPR ProcessAnalyzer. KPI Analysis utilizes the KPI expression engine for creating visualizations of data. KPI Analysis is a fully fledged analysis that can be used in conjuction with the existing QPR ProcessAnalyzer analysis for more focused results. In addition, KPI Analysis is available as a separate QPR UI view for creation of dashboards that present real-time data taken from QPR ProcessAnalyzer.
* Tabular Analysis results updated with data types: Analysis featuring tabulated data are now automatically updated with correct data types. Automatic data types allow for exporting the data in a format that can be used in other compatible tools as the data types are automatically defined into the data.

'''Features for QPR ProcessAnalyzer UI:'''
* 307265: [[KPI Analysis|KPI analysis UI]] - part 1 (KPI).
* 307278: The tabular analyses (e.g. Case analysis) in QPR ProcessAnalyzer UI now have the correct column data types based on the information from the QPR ProcessAnalyzer server.

'''Features for QPR ProcessAnalyzer Server:'''
* 307204: [[QPR_ProcessAnalyzer_Model_JSON_Settings#Model Datasources|Load PA model from ODBC datasource]].
* 307313: Expression language improvements - part 7 (performance).
* 307317: Update new [[QPR_End_User_Software_License_Agreement|EULA]] to QPR ProcessAnalyzer.

'''Fixed bugs in QPR ProcessAnalyzer UI:'''
* 218487: Influence analysis for Flowchart changes the flowchart settings.
* 218498: No history entry is created while changing visibility threshold via stepper or context variable.
* 218508: PAPO variation analysis should limit the queried number of variations.
* 218513: PAPO settings buttons cover analysis content.
* 218532: PAPO: Profiling analysis does not work with data loaded via ODBC.

'''Fixed bugs in QPR ProcessAnalyzer Server:'''
* 218515: IIS crashes in kernel during Odbc query reading csv/xlsx file with Microsoft Access Text Driver and Microsoft Excel Driver.
* 218484: ImportEvents fails in StartBackground mode.
* 218525: InMemory CaseAnalysis ShowAllCases not work if there is cases without events.
* 218463: Issue to install excel client (part 2).

== QPR ProcessAnalyzer 2018.3 (release date 2018-04-23) ==
Build number: 2018.3.0.37545, Model compatibility version: 2, Database version: 58, Stream version: 7.

'''Release Highlights:'''
*Conformance Checking is supported in QPR ProcessAnalyzer. Using the KPI Expression Language as a basis, process mining models can be compared to BPMN notation and analyzed if the process data conforms to the BPMN design. These results are implemented in ChartView and KPI Expression Language allows them to be implemented into dashboards.
*BPMN Editor has been added to ChartView. You can now import and design BPMN process maps for use in conformance analysis. The BPMN editor is a web component that is used in the browser, allowing for quick and easy process design. The designs can also be exported for further use.
*Flowchart Visibility Settings have been overhauled with a new visual presentation. New stepper elements allow for more flexible flow threshold settings while maintaining a user-friendly approach.

'''Features for QPR ProcessAnalyzer UI:'''
* 307276: Remove PAPO Offline mode.
* 307193 & 307298: The [[Flowchart_Analysis_(PAPO)#Visibility_Settings|Flowchart Visibility Settings]] were improved.
'''Features for QPR ProcessAnalyzer Server:'''
* 307077: [[QPR_ProcessAnalyzer_System_Requirements#System_Requirements_for_QPR_ProcessAnalyzer_Server | Support for Windows Server 2016 (PA Service)]].
* 307246: Expression function to calculate conformance to BPMN.
* 307297: Expression language improvements - part 6.
* 307301: In-memory memory usage optimizations.
'''Fixed bugs in QPR ProcessAnalyzer UI:'''
* 218306: PAPO control window is affected by analysis window's 'Show as' setting.
'''Fixed bugs in QPR ProcessAnalyzer Server:'''
* 218241: PA Duration Analysis In-Memory - numbers for Events and Cases too high (focus flow).
* 218456: Issue to install excel client (part 1).

== QPR ProcessAnalyzer 2018.2 (release date 2018-03-12) ==
Build number: 2018.2.0.37453, Model compatibility version: 2, Database version: 58, Stream version: 7.

'''Release Highlights:'''
* Case Permissions have been added to the data security featureset. Case Permissions allow for limiting model visibility based on rules that reference the case attributes of a set model. Case permissions can refer to usernames or user groups, creating a link between the attributes and groups.
* Influence Analysis for Case Attributes has been simplified. The feature presents basic information relating to the root causes when it is opened. If further information is needed, this can be accessed via the feature menu.
* DataGrids support Excel exporting. You are now able to export data from fixed dashboards featuring datagrids. With this feature, you can take your data for further manipulation using Microsoft Excel.
* Chartview has been improved with a new layout and excel exporting. The new layout allows for quicker access to creating charts using the ChartView tool. With the exporting functionality, the views created are exported for use in presentations in Microsoft Excel.
* KPI Expression Language has been added with support for Influence Analysis for Case Attributes. This allows for further creation of dashboards with specific analysis result queries. Using the KPI expression language, dashboards can be made to present up-to-date data based on influence analysis results.
* Dataset tag support for data visualization. Adding dataset tags will help in creating more dynamic chart presentations as the data can be inserted into the JSON settings of charts and datagrids.

'''Features for QPR ProcessAnalyzer UI:'''
* 307220: The [[Influence_Analysis_for_Case_Attributes_(PAPO)|Influence Analysis for Case Attributes]] settings now has a toggle for showing and hiding the detail columns.

'''Features for QPR ProcessAnalyzer Server:'''
* 307273: [[QPR ProcessAnalyzer Web Service API#Example| PA model JSON settings]].
* 307269: [[QPR_ProcessAnalyzer_Model_JSON_Settings#Case_Permissions |Case permissions]].
* 307261: PA InMemory core, part 8 (Path Analysis).
* 307282: PA KPI's and expressions (part 5).
'''Fixed bugs in QPR ProcessAnalyzer UI:'''
* 218426: Using PAPO with customers model crashes PA Server (Entice Changes).

'''Fixed bugs in QPR ProcessAnalyzer Server:'''
* 218371: Event types aren't provided to PAPO by PA server.
* 218372: Having multiple expressions in one selection item in a JSON filter does not work.
* 218375: Empty comparison -setting with nonempty filter -setting causes influence analysis to return incorrect results.
* 218380: PA Activation ends one day before the actual end date.
* 218362: WebService GetAnalysisAsImage does not work.
* 218389, 218397: Performance issues in PA in-memory core with multiple simultaneous users.
* 218412: PercentageNumber property is not set properly in PA analyses.
* 218410: Event attribute profiling event amount mismatch.
* 218404: Using PAPO with customers model crashes PA Server (PA changes).
* 218430: Pre-release mandatory PA bugfixes.

== QPR ProcessAnalyzer 2018.1 (release date 2018-01-31) ==
Build number: 2018.1.0.37330, Model compatibility version: 2, Database version: 57, Stream version: 7.

'''Release Highlights:'''
* ChartView is introduced as a new QPR UI view. This interactive view allows the creation of customized charts to answer specific business needs, with measures and dimensions the user has selected. ChartView comes preloaded with numerous different presentation features for the creation of customized charts fit for any business need.
* New Table Filtering for Data Table Views. A new Excel-style filtering feature has been added to the different analysis features, such as Influence Analysis for Case Attributes and Event Analysis. The feature allows the presentation and comparison of different data using robust filters.
* The QPR UI version of QPR ProcessAnalyzer has an overhauled popup menu. Selecting different analysis and creating new filters is quicker and new icons have been added for added clarity.
* XES filetype importing support. The IEEE TaskForce standardized XES logs are now supported by QPR ProcessAnalyzer. This filetype aims to unify the transactional data produced by information systems and makes them usable in tools used in data analysis.

'''Full Features for QPR ProcessAnalyzer UI:'''
* 307244: The various tables (e.g. Case Analysis) in QPR ProcessAnalyzer UI received filtering functionality familiar to the one in Microsoft Excel.
* 307163: Popup menu improvements.
* 307224: Cache model information into browser side.
'''Features for QPR ProcessAnalyzer Server:'''
* 307271: PA InMemory core, part 7 (Canceling analysis).
* 307247: XES Event log file format support.
* 307257, 307270: PA KPI's and expressions (part 3, 4).
* 307211: Enable custom data sources: Selections as JSON.
'''Fixed bugs in QPR ProcessAnalyzer UI:'''
* 218327: PAPO Grid view row selection issues when opening popup menu.
* 218328: PAPO Missing null check in ModelState.
* 218365: PAPO: Settings etc. buttons not visible in the latest chrome version (automatically updated).
* 218324: Fixed an issue where a dataset wasn't refreshed when a context variable was changed from PAPO.
'''Fixed bugs in QPR ProcessAnalyzer Server:'''
* 218288: PA service installation with DeployPAService.ps1.
* 218291: Problem with --#GetAnalysis type 31 (filter rules).
* 218315: PAPO: InMemoryCore: Offline mode shows incorrect case attribute values.
* 217922: Filtering Flow Table with Case Attribute is too slow.
* 218321: PA core - Internal server error in PAPO when duration analysis result is empty.
* 218322: Flow analysis results not always in same order (InMemory).
* 218340: Not allow to delete default filter ("No access/Access denied").
* 218345: Unknown filter rule. The given key was not present in the dictionary.
* 218363: Attribute values are sent to clients as strings from InMemory profiling analysis.
* 218365: PAPO: Settings etc. buttons not visible in the latest chrome version (automatically updated).
* 218379: PAPO: Side panels visible in multi papo even if they should be closed and invisible.

== QPR ProcessAnalyzer 2017.9 (release date 2017-12-19) ==
Build number: 2017.9.0.37199, Model compatibility version: 2, Database version: 57, Stream version: 7.

'''Release Highlights:'''
* The Filtering system on the WebUI has been updated. The user can now easily rename filters, add specific permissions to control privacy of the filters and delete filters easily. The filtering system has an improved interface for easier handling of the filters.
* New Expression language for KPI calculation. This new language allows power users to create analysis that are customized to their needs and creates the possibility for caluclating KPIs inside the server core. This JSON based language allows users to take their analysis functions even further.
* Other improvements in this release include performance improvements and further development of the in-memory mode.

'''Features for QPR ProcessAnalyzer UI:'''
* 307237: PAPO: There's now a new "DisabledFunctionalities" [[QPR_ProcessAnalyzer_Presentation_Object_(PAPO)#PAPO.27s_Context_Variables|context variable for using with PAPO]] to define which PAPO functionalities should not be.
* 307173: It's now possible to edit the Name and Privacy of a filter in QPR ProcessAnalyzer UI, as well as delete a filter.
'''Features for QPR ProcessAnalyzer Server:'''
* 307235: PA InMemory core, part 5 (Flow Analysis).
* 307262: PA InMemory core, part 6 (Canceling model loading).
* 307257: PA KPI's and expressions (part 2).
'''Fixed bugs in QPR ProcessAnalyzer UI:'''
* 218251: Multi-PAPO: Model page shows when model button of one papo has been disabled.
* 218275: Change PA WS methods from GET to POST.
* 218132: PAPO: Zoom change when item is selected from Variation Analysis.
* 218196: PAPO: Variation Analysis: graph bar lengths doesn't match with data.
* 218157: PAPO: QPR UI Graphics messed in Influence Analysis for Flowchart.
'''Fixed bugs in QPR ProcessAnalyzer Server:'''
* 218241: Duration Analysis In-Memory - numbers for Events, Median duration and Average duration are too high.
* 218046: System.ArgumentException: Value of '-170' is not valid for 'red'. 'red' should be greater than or equal to 0 and less than or equal to 255.
* 218275: Change PA WS methods from GET to POST.

== QPR ProcessAnalyzer 2017.8 (release date 2017-11-07) ==
Build number: 2017.8.0.37022, Model compatibility version: 2, Database version: 57, Stream version: 7.

'''Release Highlights:'''
* The QPR UI interface features a new feature: Profiling Event Analysis. Now you can drilldown to your events and see what event attributes the event types in your data contain. You can also use this knowledge to benchmark your process.
* The Selection logic in the QPR UI has been updated. You no longer have to update after making a selection, as the selections are responsive and updated automatically. This leads to more responsive and effective analysis.
* In-Memory Engine has been improved upon, allowing for more efficient analysis for small-to-mid-size models. This update gives you improved performance in your analysis operations. This feature applies for all analysis features and improves the performance of the software immensely, giving you faster operations.
* The Excel Client has been preloaded with new and updated demo models that demonstrate the power of QPR ProcessAnalyzer. New Models include Healthcare and Insurance claims process models. These give you a great idea on how to utilize QPR ProcessAnalyzer.

'''Features for QPR ProcessAnalyzer UI:'''
* 307161: When selecting items in PAPO, the "Selected" context variables are now updated without the need to explicitly do the update. As a result, the "Select into UI Context" item was removed from the PAPO popup menu. This means that the TempSelectedActivities, TempSelectedTransitions, TempSelectedVariations, and TempSelectedCounts context variables were removed, and their functionality changed to be in the SelectedActivities, SelectedTransitions, SelectedVariations, and SelectedCounts context variables.
* 307061: PAPO now has the [[Profiling_Analysis_(PAPO)#Profiling_Event_Analysis|Profiling Event Analysis]] available.

'''Features for QPR ProcessAnalyzer Server:'''
* 307219: Excel client demo model changes.
* 307216: To improve performance, QPR ProcessAnalyzer can now be configured to run the analyses in the server memory instead of the database.

'''Fixed bugs in QPR ProcessAnalyzer UI:'''
* 218060: PAPO doesn't add transition duration but case duration filter rule type when Duration analysis shows transition duration.
* 218039: PAPO: Analysis window has incorrect width when opening view (splitter issue).
* 218036: PAPO: Web UI shows archived/recycled PA models.
* 218100: PAPO: Once Analysis view show "No records to display" message, then switch to other analysis view is not possible for current model.
* 218159: PAPO: Popup menus don't work in tabular analyses in IE11.
* 218169: PAPO: SelectedAttributeType parameter in PA request has invalid value when switching model and applying filter that requires model change.
'''Fixed bugs in QPR ProcessAnalyzer Server:'''
* 218148: InMemory: Include Only Event Types does not work with sampled models.
* 218179: InMemory: Amount of cases in Duration analysis when flow is selected.

== QPR ProcessAnalyzer 2017.7 (release date 2017-09-25) ==
Build number: 2017.7.0.36871 <s>36762</s>, Model compatibility version: 2, Database version: 57, Stream version: 7.

'''Release Highlights:'''
* New In-Memory core for Process Analysis calculation. This server-side improvement can improve Analysis Performance speed up to 20 times faster than previous releases. This is achieved by offloading the memory functions directly to the application server where in the previous versions of the software, the SQL server handledthe workload.
* This release also features different bug fixes and performance improvements, aiming to improve your process analysis experience. Combining these features with the new WebUI platform release, the implementation of your data for analysis and improvement is smoother than ever.

'''Features for QPR ProcessAnalyzer UI:'''
* 307060: CSS styling and grid configuration improvements (technical feature).
'''Fixed bugs in QPR ProcessAnalyzer UI:'''
* 217986: The pie (in profiling analysis) is rendered initially too small.
* 217721: One extra scroll position / zoom -history entry created when PAPO is initialized.
* 218052: Flowchart shows incorrect duration.
* 217978: Profiling analysis is empty in Analysis window when opening splitter again.
* 217926: Duration Analysis in control window doesn't select all "other" cases.
* 217708: It is not possible to make multiselection using radial graph.
* 218043: Issue with AnalysisWindowSize context variable.
* 218058: Profiling Analysis for Case Attributes doesn't work when using numerical case attribute.
* 218035: Switch model from filter: Error processing PA request. Invalid column name 'CA_VALUE_1290462'.
'''Fixed bugs in QPR ProcessAnalyzer Server:'''
* 218024: Add log writing to odbc query.
* 217836: Error when opening filter in customer environment.
* 217995: ImportCaseAttributes command does not import cases properly.
* 218094: PA error text doesn't have information which value have problem.
* 218145: Input String was not in the correct format error when opening customer model.

== QPR ProcessAnalyzer 2017.6 (release date 2017-08-15) ==
Build number: 2017.6.0.36561, Model compatibility version: 2, Database version: 57, Stream version: 7.

'''Release Highlights:'''
* The major feature of this release is the support for Multiwindow Process Analysis. Need to create new, custom views for specific analysis? It's now possible with the customizable dashboards offered.
* If you want to take dashboard customization even further, you can now add SVG Backgrounds to views and panels. You can make your dashboards look more impressive by adding a SVG image to it.
* For powerful analysis, the new version offers a table view for Profiling Analysis. For larger datasets with multiple attributes, this is an extremely useful feature as you can easily profile the data with the table.
* If you want to do accurate lead time analysis, you will find the table view for Duration Analysis very useful. The data presented in the tables offers you accurate data and can be used for further analysis.
* Managing navigation and creating links for dashboards has been furthered with the addition of Identifier Support. You can now give your dashboards identifiers that you choose, making your dashboard management much easier.
* For more under the hood features, we implemented dynamic tag support. Dynamic tags allow you to add functional behaviour to dashboards by specifying set context variables. This will lead to more responsive dashboards!
* Finally, we redesigned the zoom buttons. Not only did we redesign the buttons, but we implemented into the analysis window! By adding a zoom button to the analysis window, we now offer you the chance more control on the visualization of the analysis.

'''PAPO Features:'''
* 307063: The [[Profiling_Analysis_(PAPO)|Profiling Analysis]] can now be shown as a table.
* 307012: The zoom button look was changed.
* 307064: The [[Duration_Analysis_(PAPO)|Duration Analysis]] can now be shown as a table.

'''Fixed bugs:'''
* 218010: Sample files are missing from PA Excel Client.

'''PAPO Fixed bugs:'''
* 218005: The Profiling Analysis case attribute selection was reset to the default value after applying a filter.
* 217876: The flowchart was not centered after being opened in the {{DriverNameForTheDay}} window.
* 217934: Fixed an issue where the "Limit to" field in the analysis settings could be used to enter unacceptable values and could display negative values.
* 218028: The Model and Analysis buttons were shown in the {{DriverNameForTheDay}} and {{AnalysisNameForTheDay}} windows even when the windows were hidden by using the splitter.

== QPR ProcessAnalyzer 2017.5 (release date 2017-07-06) ==
Build number: 2017.5.0.36503, Model compatibility version: 2, Database version: 57, Stream version: 7.

'''PAPO Features:'''

* 307067: The [[Variation_Analysis (PAPO)|Variation Analysis]] in QPR ProcessAnalyzer Presentation Object can now be run in the {{DriverNameForTheDay}} window.<br>
* 307021: The QPR ProcessAnalyzer Presentation Object now has [[Case_Analysis_(PAPO)|Case Analysis]].<br>
* 307020: The QPR ProcessAnalyzer Presentation Object now has [[Event_Analysis_(PAPO)|Event Analysis]].<br>
* 307058: The QPR ProcessAnalyzer Presentation Object now has [[Event_Type_Analysis_(PAPO)|Event Type Analysis]].<br>
* 307105: PAPO: In the Flowchart analysis, some terms, default values, and button visibility were changed.<br>
'''Fixed bugs:'''
* 217925: 'SelectedCaseAttributeTypes' is not supported in --#CreateFilter.
* 217710: Copyright shows 2016.
* 217973: PAPO now uses the web browser's date and number formatting when showing date and numbers in data grids/tables.<br>
* 217946: Fixed an issue in PAPO, where the table grid didn't fit the window after switching from Offline Mode to normal mode on Case analysis<br>

== QPR ProcessAnalyzer 2017.4 (release date 2017-05-23) ==
Build number: 2017.4.0.36424, Model compatibility version: 2, Database version: 57, Stream version: 7.

'''PAPO Features:'''
* 307022: The Profiling Analysis can now be used in the Control window in the [[QPR_ProcessAnalyzer_Presentation_Object_(PAPO)#QPR_ProcessAnalyzer_Presentation_Object_.28PAPO.29|QPR ProcessAnalyzer Presentation Object]] to select cases for the analysis in the Analysis window.<br>
* 307003: The buttons in the [[QPR_ProcessAnalyzer_Presentation_Object_(PAPO)#QPR_ProcessAnalyzer_Presentation_Object_.28PAPO.29|QPR ProcessAnalyzer Presentation Object (PAPO)]] were rearranged.<br>
* 307057: The Duration, Profiling, Influence, and Variation Analyses in [[QPR_ProcessAnalyzer_Presentation_Object_(PAPO)#QPR_ProcessAnalyzer_Presentation_Object_.28PAPO.29|QPR ProcessAnalyzer Presentation Object]] now have generic and some analysis specific settings supported.<br>
* 306969: The QPR ProcessAnalyzer Presentation Object now supports the [[QPR_ProcessAnalyzer_Presentation_Object_(PAPO)#Influence_Analysis_for_Case_Attributes|Influence Analysis for Case Attributes]] in the grid format.
* 307030: [[QPR_ProcessAnalyzer_Presentation_Object_(PAPO)#Duration_Analysis|Duration Analysis]] can now be used in the {{DriverNameForTheDay}} window of the QPR ProcessAnalyzer Presentation Object.

'''PA Features:'''
* 403516: Consolidate event names in PA example Excels (SAP_OrderToCash.xlsx, SAP_OrderToCash v2.xlsx and SAP_OrderToCash_Extended.xlsx).

'''Fixed bugs:'''
* 217845: Create Filter from CaseAttributeTrends with PA script doesn't work.
* 217830: Tab delimiter is not taken into use when datatable imported.
* 217902: SqlException thrown when opening influence analysis on a filter without any case attributes.

== QPR ProcessAnalyzer 2017.3 (release date 2017-04-11) ==
Build number: 2017.3.0.36338 <s>36324</s>, Model compatibility version: 2, Database version: 57, Stream version: 7.

'''Features:'''
* 305862: There now are new StartTime Limit and Maximum Text Length settings to be used with the [[Operation Log]] and the Operation Log Analysis [[QPR ProcessAnalyzer Scripting Commands#--.23GetAnalysis|GetAnalysis]] script command.
* 306983: PAPO - Highlight selected flow label in flowchart: selected flow labels are now clearly visible on the flowchart. Selected objects are highlighted on the flowchart.
* 306986 & 307017: The QPR ProcessAnalyzer Presentation Object (PAPO) now has a new [[QPR_ProcessAnalyzer_Presentation_Object_(PAPO)#Control_Window_and_Analysis_Window|window system]].
* 306987: PAPO - in-memory Variation analysis: Variation analysis is now supported in in-memory mode.
* 307000: The model shown in the QPR ProcessAnalyzer Presentation Object (PAPO) can now be changed via a menu.
* 306999: The Start and End symbols in the QPR ProcessAnalyzer Presentation Object (PAPO) flowchart were updated.
'''Fixed bugs:'''
* 217679: PA cannot add new case Attribute values to exising case via Excel if CaseId starts with leading zero.
* 217790: Filtering is too slow.

== QPR ProcessAnalyzer 2017.2 (release date 2017-02-28) ==
Build number: 2017.2.0.36218, Model compatibility version: 2, Database version: 56, Stream version: 7.

'''Features:'''
* 306966: Performance optimizations into PA database.
* 306930: Improved messages to SQL Queries.
* 306910: Implement importSalesforceQuery support for TLS 1.1. Note that the support from PA Salesforce Integration service has been discontinued.
* 306964: Make it possible to transfer the contents of a filter efficiently to UI.
'''Fixed bugs:'''
* 217605: Operation log throws some exception.
* 217546: Slow access to project by project name. ETL parameter: (SELECT 'ProjectName', 'name').
* 217363: ScriptLauncher should LogOff.
* 217618, 217636: PA Excel Client doesn't connect to PA Server when Windows performance counter is not accessible (part 1 and 2).
* 217650: System.DBNull objects returned from event analysis when IncludeCaseAttributeValues is used.

== QPR ProcessAnalyzer 2017.1 (release date 2017-01-16) ==
Build number: 2017.1.0.36111, Model compatibility version: 2, Database version: 55, Stream version: 7.

'''Features:'''

* 306899: The [[QPR ProcessAnalyzer Scripting Commands#--.23SendEmail|SendEmail]] script command now supports sending attachments.
* 306896: A [[Open R in QPR ProcessAnalyzer#Case_Prediction_Example_Script|case prediction Open R example script]] was added to QPR ProcessAnalyzer wiki.
* 306484: There is now a new [[QPR ProcessAnalyzer Scripting Commands#--.23ImportEventsIncremental|ImportEventsIncremental]] script command for synchronizing event data between a data table that holds event data and the specified model.
* 306906: The [[Script Log]] entries are now written to the database at the same time as the script is being run. There is also a new Script Log Report analysis type for the [[QPR ProcessAnalyzer Scripting Commands#--.23GetAnalysis|GetAnalysis]] script command for administrators to access script logs.

'''Fixed bugs:'''
* 217526: Log entries written as errors even if they are not.
* 217545: Session expires exceedingly often in a service deployed in AWS behind load balancer.
* 217591: Special characters in PA script parameters cause script to fail and hide the actual root cause of the failure.

== Old Releases ==
See older releases in [[QPR ProcessAnalyzer Release Archive]]
__NOTOC__

Case Level Permissions

2018-08-13T08:23:59Z

VesKivi: /* Necessary IIS setup */

Each QPR ProcessAnalyzer model has a '''[[Project_Workspace_in_QPR_ProcessAnalyzer_Excel_Client#Model_Properties|Configuration]]''' field containing model related settings in a JSON format. Those settings are documented in this page. When the model JSON configuration is changed, the model is dropped from the memory.

== Model Datasources ==
The '''DataSource''' section is used to define where the QPR ProcessAnalyzer model data is loaded. See below examples, how to construct the full JSON.
{| class="wikitable"
!'''Property'''
! '''Description'''
|-
|Cases
|
{| class="wikitable"
!'''Property'''
! '''Description'''
|-
||DataSourceType
||Datasource type to use, when fetching the Cases data. Currently the only supported value is '''odbc'''.
|-
||OdbcConnectionString
||ODBC connection string to use to fetch the Cases data. Connection strings can be found in https://www.connectionstrings.com.
|-
||OdbcQuery
||ODBC query to use to fetch the Cases data. Query syntax depends on the source system where the data is fetched.
|-
||Columns
||Column name mappings for QPR ProcessAnalyzer data model. Only supported mapping is '''CaseId''' defining the case id (case name). Example:
<pre>
{
"CaseId": "SalesOrderHeaderId"
}
</pre>
All unmapped columns are taken to the model as case attributes. If the fetched data doesn't contain a mapped column, the model loading fails and an error message is given.
|}

|-
||Events
||
{| class="wikitable"
!'''Property'''
! '''Description'''
|-
||DataSourceType
||Datasource type to use, when fetching the Events data. Currently the only supported value is '''odbc'''.
|-
||OdbcConnectionString
||ODBC connection string to use to fetch the Events data. Connection strings can be found in https://www.connectionstrings.com.
|-
||OdbcQuery
||ODBC query to use to fetch the Events data. Query syntax depends on the source system where the data is fetched.
|-
||Columns
||
Column name mappings for QPR ProcessAnalyzer data model. Supported mappings for Events are '''CaseId''', '''EventType''' and '''Timestamp'''. Example:
<pre>
{
"CaseId": "SalesOrderHeaderId",
"EventType": "EventType",
"Timestamp": "CreatedDate"
}
</pre>
All unmapped columns are taken to the model as event attributes. If the fetched data doesn't contain a mapped column, the model loading fails and an error message is given.
|}
|}

=== Example: Loading QPR ProcessAnalyzer models from ODBC datasources ===

==== ODBC Driver Installation ====
'''Microsoft Access Database Engine 2016 Redistributable''' is software package that contains ODBC drivers for
* Microsoft SQL Server
* Microsoft Access (*.mdb and *.accdb) files
* Microsoft Excel (*.xls, *.xlsx, and *.xlsb) files
* CSV text files

The package needs to be installed in the same computer where the QPR ProcessAnalyzer Server is running. Installation instructions:
# Go to https://www.microsoft.com/en-us/download/details.aspx?id=54920 and click Download.
# Select whether to use the 32bit or 64bit (x64) version (usually it's the 64bit version).
# Double-click the executable file on your hard disk to start the setup program.
# Follow the instructions on the screen to complete the installation.

==== Read data from CSV file ====
In this example, data is loaded from CSV files located in the file system using ''Microsoft Access Text Driver (*.txt, *.csv)'' driver. Loaded files are C:\ProcessMiningData\ModelCaseAttributes.csv and C:\ProcessMiningData\ModelEventData.csv.
<pre>
{
"DataSource": {
"Cases": {
"DataSourceType": "odbc",
"OdbcConnectionString": "Driver={Microsoft Access Text Driver (*.txt, *.csv)};DefaultDir=C:\\ProcessMiningData\\;Extensions=asc,csv,tab,txt",
"OdbcQuery": "SELECT * FROM [ModelCaseAttributes.csv]",
"Columns": {
"CaseId": "Name"
}
},
"Events": {
"DataSourceType": "odbc",
"OdbcConnectionString": "Driver={Microsoft Access Text Driver (*.txt, *.csv)};DefaultDir=C:\\ProcessMiningData\\;Extensions=asc,csv,tab,txt",
"OdbcQuery": "SELECT * FROM [ModelEventData.csv]",
"Columns": {
"CaseId": "Case",
"EventType": "Event Type",
"Timestamp": "Start Time"
}
}
}
}
</pre>

When reading from CSV files, you may need to set the CSV file format for the ODBC driver using the '''Schema.ini''' file (more information: https://docs.microsoft.com/en-us/sql/odbc/microsoft/schema-ini-file-text-file-driver?view=sql-server-2017).

==== Read data from Excel file ====
In this example, data is loaded from a Excel file that is accessible in the file system. In this example, the loaded file is C:\ProcessMiningData\ModelData.xlsx and cases are in sheet ''MyCases'' and events in sheet ''MyEvents''.

<pre>
{
"DataSource": {
"Cases": {
"DataSourceType": "odbc",
"OdbcConnectionString": "Driver={Microsoft Excel Driver (*.xls, *.xlsx, *.xlsm, *.xlsb)};DBQ=C:\\ProcessMiningData\\ModelData.xlsx",
"OdbcQuery": "SELECT * FROM [MyCases$]",
"Columns": {
"CaseId": "Case ID"
}
},
"Events": {
"DataSourceType": "odbc",
"OdbcConnectionString": "Driver={Microsoft Excel Driver (*.xls, *.xlsx, *.xlsm, *.xlsb)};DBQ=C:\\ProcessMiningData\\ModelData.xlsx",
"OdbcQuery": "SELECT * FROM [MyEvents$]",
"Columns": {
"CaseId": "Case ID",
"EventType": "Activity",
"Timestamp": "Start Time"
}
}
}
}
</pre>

==== Read data from SQL Server table ====
In this example, data is loaded from an SQL Server table. In this example, the SQL Server hostname is ''MySQLServer'' and database name is ''MyDatabase''.

<pre>
{
"DataSource": {
"Cases": {
"DataSourceType": "odbc",
"OdbcConnectionString": "Driver={SQL Server};Server=MySQLServer;DataBase=MyDatabase;Trusted_Connection=True;",
"OdbcQuery": "SELECT CASENAME, COST, COUNTRY, PRODUCT FROM CASES_TABLE",
"Columns": {
"CaseId": "CASENAME"
}
},
"Events": {
"DataSourceType": "odbc",
"OdbcConnectionString": "Driver={SQL Server};Server=MySQLServer;DataBase=MyDatabase;Trusted_Connection=True;",
"OdbcQuery": "SELECT CASENAME, CREATED_DATE, CREATED_BY FROM EVENT_TABLE",
"Columns": {
"CaseId": "CASENAME",
"Timestamp": "CREATED_DATE",
"EventType": "CREATED_BY"
}
}
}
}
</pre>

==== Troubleshooting ====

Most common reason for error 'System.Data.Odbc.OdbcException (0x80131937): ERROR [IM002] [Microsoft][ODBC Driver Manager] Data source name not found and no default driver specified' is driver is missing or driver name is not exactly correct.
* Check ODBC drivers is installed. 64-bit machine: C:\Windows\System32\odbcad32.exe
* Check connection string. Example 32-bit driver name 'Driver={Microsoft Text Driver (*.txt; *.csv)}' and 64-bit driver name 'Driver={Microsoft Access Text Driver (*.txt, *.csv)}'.

Example error when specified directory is missing: 'ERROR [HY024] [Microsoft][ODBC Text Driver] '(unknown)' is not a valid path. Make sure that the path name is spelled correctly and that you are connected to the server on which the file resides.'

Example error when CSV file is missing: 'System.Data.Odbc.OdbcException (0x80131937): ERROR [42S02] [Microsoft][ODBC Text Driver] The Microsoft Access database engine could not find the object 'CaseAttributes.csv'. Make sure the object exists and that you spell its name and the path name correctly. If 'CaseAttributes.csv' is not a local object, check your network connection or contact the server administrator.'

Error codes for troubleshooting are accessible from [https://docs.microsoft.com/en-us/sql/odbc/reference/appendixes/appendix-a-odbc-error-codes?view=sql-server-2017| ODBC Error Codes].

If the error message mention about Case or Event attributes named as ''F<column number>'' (e.g. F10), the data might be inconsistent, as there might be different amount of columns in different rows.

[https://devnet.onqpr.com/pawiki/index.php/Installing_QPR_ProcessAnalyzer_Server#Update_IIS_Application_pool_loadUserProfile_to_true Application pool crash]

== Model Load OnStartup ==
The '''LoadOnStartup''' section is used to define automatic the QPR ProcessAnalyzer model data loading in memory during startup. If value is true model is loaded on startup.
<pre>
{
"LoadOnStartup": true
}
</pre>

=== Necessary IIS setup ===

==== Install the Application Initialization role or feature ====
To support application initialization on your Web server, you must install the Application Initialization role or feature.

In Windows Server 2012, Windows Server 2012 R2 or Windows Server 2016:
* On the taskbar, click Server Manager.
* In Server Manager, click the Manage menu, and then click Add Roles and Features.
* In the Add Roles and Features Wizard, click Next. Select the installation type and click Next. Select the destination server and click Next.
* On the Server Roles page, expand Web Server (IIS), expand Web Server, expand Application Development, and then select Application Initialization. Click Next.
[[File:AddRolesAndFeaturesWizard.JPG]]
* On the Select Features page, click Next.
* On the Confirm installation selections page, click Install.
* On the Results page, click Close.

==== Set the application pool to AlwaysRunning ====
You need to set the pool to AlwaysRunning. Open C:\Windows\System32\inetsrv\config\applicationHost.config and change the pool settings as shown below:
<pre>
<applicationPools> <add name="MyAppPool" startMode="AlwaysRunning" /> </applicationPools>
</pre>

==== Set site or application to Preloaded ====
In the same file (applicationHost.config), look for your site in the element and add preloadEnabled="true", for example:

<pre>
<application path="/pa_ui_inmemory_test" preloadEnabled="true" applicationPool="QPRPAPoolUI">
</pre>

==== Set site or application initialize after restart ====
<pre>
<system.webServer>
<applicationInitialization
doAppInitAfterRestart="true">
<add initializationPage="/MainService.svc" />
</applicationInitialization>
</system.webServer>
</pre>

==== Disable ModelLoadOnStartup via web.config setting ====

Default value is true. If ModelLoadOnStartup need disable set value to false.
<pre>
<configuration>
<applicationSettings>
<Qpr.ProcessAnalyzer.Service.Properties.Settings>
<setting name="ModelLoadOnStartup" serializeAs="String">
<value>True</value>
</setting>
</Qpr.ProcessAnalyzer.Service.Properties.Settings>
</applicationSettings>
</configuration>
</pre>

== Case Permissions ==
The '''Permissions''' section specifies data security restrictions for objects within the QPR ProcessAnalyzer model (i.e. limit visibility). If the Permissions section hasn't been defined, all the model data is visible to all users having '''GenericRead''' permission for the project in which the model resides ([[User Roles and Permissions in QPR ProcessAnalyzer|more information about roles and permissions]]). Permissions defined in this section, are only available when using the [[Installing QPR ProcessAnalyzer Server#Configure_Web_Service_to_use_In-Memory_or_In-Database_processing|In-Memory core]].

{| class="wikitable"
!'''Property'''
! '''Description'''
|-
|Initialization
|[[QPR_ProcessAnalyzer_Expressions|Expression language]] expression used to make an initial calculation for all the other expressions within this same permissions context. This expression can be used to improve performance when part of the Case or EventLogKey expressions are common and thus they don't need to be calculated again for every Case separately. See the examples below of using the Initialization expression.
|-
||Case
||[[QPR_ProcessAnalyzer_Expressions|Expression language]] expression determining which users can see each Cases. The expression is evaluated within the context of each Case. If the evaluation results '''true''', the Case is visible for the user. Otherwise the Case, its Events and case and event attributes are not visible. This setting implements case level security restrictions.
|-
||EventLogKey
||[[QPR_ProcessAnalyzer_Expressions|Expression language]] expression used to uniquely identify all the unique event logs created by case permission filters. If a cached EventLog with the same key is already in the system, that EventLog is used instead of creating a new. The new EventLog is created by applying the Case expression to filter the Cases users have rights to.
|}

=== Example usecase for case permissions ===
There are groups G1, G2 and G3. Case permissions have been set as follows:
* group G1 can only see cases where (case attribute) Region is Dallas
* group G2 can only see cases where Region is Austin
* group G3 can only see cases where Region is either Austin or New York

QPR ProcessAnalyzer model contains the following cases:
{| class="wikitable"
! Case name
! Region (case attribute)
! Groups can see
|-
|A
|Dallas
|G1
|-
|B
|Dallas
|G1
|-
|C
|Austin
|G2, G3
|-
|D
|New York
|G3
|-
|E
|New York
|G3
|-
|F
|New York
|G3
|}

Thus, when viewing analyses, a user see that the model contains the following cases:
* If the user belongs to group G1 only, the user can see cases A and B (2 cases)
* If the user belongs to group G2 only, the user can see case C (1 case)
* If the user belongs to group G3 only, the user can see cases C, D, E and F (4 cases)
* If the user belongs to groups G1 and G2 only, the user can see cases A, B and C (3 cases)

There is no way for a user to be aware of the existence of cases that the user doesn't have rights to.

=== Configuration examples for case permissions ===
In this example, visibility of cases is limited in a way that only those users can see the cases belonging to a user group which name is same as the Region (case attribute).
<pre>
{
"Permissions": {
"Initialization": "Let(\"groupNames\", OrderByValue(CurrentUser.GroupNames))",
"Case": "Region.In(groupNames)",
"EventLogKey": "StringJoin(\"_\", groupNames)"
}
}
</pre>

In this example, cases are only visible for users whose user name is same as the Account Manager (case attribute).
<pre>
{
"Permissions": {
"Initialization": "Let(\"userName\", CurrentUser.Name)",
"Case": "(Attribute(\"Account Manager\") == userName)",
"EventLogKey": "CurrentUser.Id"
}
}
</pre>

In this example, cases having "Region" case attribute of "Dallas" will only be visible for users belonging to user group "GroupA" (and "New York" for group "GroupB").
<pre>
{
"Permissions": {
"Initialization": "Let(\"groupNames\", CurrentUser.GroupNames)",
"Case": "(Region == \"Dallas\" && \"GroupA\".In(groupNames)) || (Region == \"New York\" && \"GroupB\".In(groupNames))",
"EventLogKey": "If(\"GroupA\".In(groupNames), \"_A\", \"_\") + If(\"GroupB\".In(groupNames), \"_B\", \"_\")"
}
}
</pre>

Case Level Permissions

2018-07-04T08:40:54Z

VesKivi: /* Necessary IIS setup */

Each QPR ProcessAnalyzer model has a '''[[Project_Workspace_in_QPR_ProcessAnalyzer_Excel_Client#Model_Properties|Configuration]]''' field containing model related settings in a JSON format. Those settings are documented in this page. When the model JSON configuration is changed, the model is dropped from the memory.

== Model Datasources ==
The '''DataSource''' section is used to define where the QPR ProcessAnalyzer model data is loaded. See below examples, how to construct the full JSON.
{| class="wikitable"
!'''Property'''
! '''Description'''
|-
|Cases
|
{| class="wikitable"
!'''Property'''
! '''Description'''
|-
||DataSourceType
||Datasource type to use, when fetching the Cases data. Currently the only supported value is '''odbc'''.
|-
||OdbcConnectionString
||ODBC connection string to use to fetch the Cases data. Connection strings can be found in https://www.connectionstrings.com.
|-
||OdbcQuery
||ODBC query to use to fetch the Cases data. Query syntax depends on the source system where the data is fetched.
|-
||Columns
||Column name mappings for QPR ProcessAnalyzer data model. Only supported mapping is '''CaseId''' defining the case id (case name). Example:
<pre>
{
"CaseId": "SalesOrderHeaderId"
}
</pre>
All unmapped columns are taken to the model as case attributes. If the fetched data doesn't contain a mapped column, the model loading fails and an error message is given.
|}

|-
||Events
||
{| class="wikitable"
!'''Property'''
! '''Description'''
|-
||DataSourceType
||Datasource type to use, when fetching the Events data. Currently the only supported value is '''odbc'''.
|-
||OdbcConnectionString
||ODBC connection string to use to fetch the Events data. Connection strings can be found in https://www.connectionstrings.com.
|-
||OdbcQuery
||ODBC query to use to fetch the Events data. Query syntax depends on the source system where the data is fetched.
|-
||Columns
||
Column name mappings for QPR ProcessAnalyzer data model. Supported mappings for Events are '''CaseId''', '''EventType''' and '''Timestamp'''. Example:
<pre>
{
"CaseId": "SalesOrderHeaderId",
"EventType": "EventType",
"Timestamp": "CreatedDate"
}
</pre>
All unmapped columns are taken to the model as event attributes. If the fetched data doesn't contain a mapped column, the model loading fails and an error message is given.
|}
|}

=== Example: Loading QPR ProcessAnalyzer models from ODBC datasources ===

==== ODBC Driver Installation ====
'''Microsoft Access Database Engine 2016 Redistributable''' is software package that contains ODBC drivers for
* Microsoft SQL Server
* Microsoft Access (*.mdb and *.accdb) files
* Microsoft Excel (*.xls, *.xlsx, and *.xlsb) files
* CSV text files

The package needs to be installed in the same computer where the QPR ProcessAnalyzer Server is running. Installation instructions:
# Go to https://www.microsoft.com/en-us/download/details.aspx?id=54920 and click Download.
# Select whether to use the 32bit or 64bit (x64) version (usually it's the 64bit version).
# Double-click the executable file on your hard disk to start the setup program.
# Follow the instructions on the screen to complete the installation.

==== Read data from CSV file ====
In this example, data is loaded from CSV files located in the file system using ''Microsoft Access Text Driver (*.txt, *.csv)'' driver. Loaded files are C:\ProcessMiningData\ModelCaseAttributes.csv and C:\ProcessMiningData\ModelEventData.csv.
<pre>
{
"DataSource": {
"Cases": {
"DataSourceType": "odbc",
"OdbcConnectionString": "Driver={Microsoft Access Text Driver (*.txt, *.csv)};DefaultDir=C:\\ProcessMiningData\\;Extensions=asc,csv,tab,txt",
"OdbcQuery": "SELECT * FROM [ModelCaseAttributes.csv]",
"Columns": {
"CaseId": "Name"
}
},
"Events": {
"DataSourceType": "odbc",
"OdbcConnectionString": "Driver={Microsoft Access Text Driver (*.txt, *.csv)};DefaultDir=C:\\ProcessMiningData\\;Extensions=asc,csv,tab,txt",
"OdbcQuery": "SELECT * FROM [ModelEventData.csv]",
"Columns": {
"CaseId": "Case",
"EventType": "Event Type",
"Timestamp": "Start Time"
}
}
}
}
</pre>

When reading from CSV files, you may need to set the CSV file format for the ODBC driver using the '''Schema.ini''' file (more information: https://docs.microsoft.com/en-us/sql/odbc/microsoft/schema-ini-file-text-file-driver?view=sql-server-2017).

==== Read data from Excel file ====
In this example, data is loaded from a Excel file that is accessible in the file system. In this example, the loaded file is C:\ProcessMiningData\ModelData.xlsx and cases are in sheet ''MyCases'' and events in sheet ''MyEvents''.

<pre>
{
"DataSource": {
"Cases": {
"DataSourceType": "odbc",
"OdbcConnectionString": "Driver={Microsoft Excel Driver (*.xls, *.xlsx, *.xlsm, *.xlsb)};DBQ=C:\\ProcessMiningData\\ModelData.xlsx",
"OdbcQuery": "SELECT * FROM [MyCases$]",
"Columns": {
"CaseId": "Case ID"
}
},
"Events": {
"DataSourceType": "odbc",
"OdbcConnectionString": "Driver={Microsoft Excel Driver (*.xls, *.xlsx, *.xlsm, *.xlsb)};DBQ=C:\\ProcessMiningData\\ModelData.xlsx",
"OdbcQuery": "SELECT * FROM [MyEvents$]",
"Columns": {
"CaseId": "Case ID",
"EventType": "Activity",
"Timestamp": "Start Time"
}
}
}
}
</pre>

==== Read data from SQL Server table ====
In this example, data is loaded from an SQL Server table. In this example, the SQL Server hostname is ''MySQLServer'' and database name is ''MyDatabase''.

<pre>
{
"DataSource": {
"Cases": {
"DataSourceType": "odbc",
"OdbcConnectionString": "Driver={SQL Server};Server=MySQLServer;DataBase=MyDatabase;Trusted_Connection=True;",
"OdbcQuery": "SELECT CASENAME, COST, COUNTRY, PRODUCT FROM CASES_TABLE",
"Columns": {
"CaseId": "CASENAME"
}
},
"Events": {
"DataSourceType": "odbc",
"OdbcConnectionString": "Driver={SQL Server};Server=MySQLServer;DataBase=MyDatabase;Trusted_Connection=True;",
"OdbcQuery": "SELECT CASENAME, CREATED_DATE, CREATED_BY FROM EVENT_TABLE",
"Columns": {
"CaseId": "CASENAME",
"Timestamp": "CREATED_DATE",
"EventType": "CREATED_BY"
}
}
}
}
</pre>

==== Troubleshooting ====

Most common reason for error 'System.Data.Odbc.OdbcException (0x80131937): ERROR [IM002] [Microsoft][ODBC Driver Manager] Data source name not found and no default driver specified' is driver is missing or driver name is not exactly correct.
* Check ODBC drivers is installed. 64-bit machine: C:\Windows\System32\odbcad32.exe
* Check connection string. Example 32-bit driver name 'Driver={Microsoft Text Driver (*.txt; *.csv)}' and 64-bit driver name 'Driver={Microsoft Access Text Driver (*.txt, *.csv)}'.

Example error when specified directory is missing: 'ERROR [HY024] [Microsoft][ODBC Text Driver] '(unknown)' is not a valid path. Make sure that the path name is spelled correctly and that you are connected to the server on which the file resides.'

Example error when CSV file is missing: 'System.Data.Odbc.OdbcException (0x80131937): ERROR [42S02] [Microsoft][ODBC Text Driver] The Microsoft Access database engine could not find the object 'CaseAttributes.csv'. Make sure the object exists and that you spell its name and the path name correctly. If 'CaseAttributes.csv' is not a local object, check your network connection or contact the server administrator.'

Error codes for troubleshooting are accessible from [https://docs.microsoft.com/en-us/sql/odbc/reference/appendixes/appendix-a-odbc-error-codes?view=sql-server-2017| ODBC Error Codes].

If the error message mention about Case or Event attributes named as ''F<column number>'' (e.g. F10), the data might be inconsistent, as there might be different amount of columns in different rows.

[https://devnet.onqpr.com/pawiki/index.php/Installing_QPR_ProcessAnalyzer_Server#Update_IIS_Application_pool_loadUserProfile_to_true Application pool crash]

== Model Load OnStartup ==
The '''LoadOnStartup''' section is used to define automatic the QPR ProcessAnalyzer model data loading in memory during startup. If value is true model is loaded on startup.
<pre>
{
"LoadOnStartup": true
}
</pre>

=== Necessary IIS setup ===

==== Install the Application Initialization role or feature ====
To support application initialization on your Web server, you must install the Application Initialization role or feature.

Windows Server 2012 or Windows Server 2012 R2
* On the taskbar, click Server Manager.
* In Server Manager, click the Manage menu, and then click Add Roles and Features.
* In the Add Roles and Features wizard, click Next. Select the installation type and click Next. Select the destination server and click Next.
* On the Server Roles page, expand Web Server (IIS), expand Web Server, expand Application Development, and then select Application Initialization. Click Next.
* .
* On the Select Features page, click Next.
* On the Confirm installation selections page, click Install.
* On the Results page, click Close.

==== Set the application pool to AlwaysRunning ====
You need to set the pool to AlwaysRunning. Open C:\Windows\System32\inetsrv\config\applicationHost.config and change the pool settings as shown below:
<pre>
<applicationPools> <add name=”MyAppPool” startMode=”AlwaysRunning” /> </applicationPools>
</pre>

==== Set site or application to Preloaded ====
Look for your site in the element and add preloadEnabled=”true”, for example:

preloadEnabled="true" applicationPool=".NET v4.5">

==== Disable ModelLoadOnStartup via web.config setting ====

Default value is true. If ModelLoadOnStartup need disable set value to false.
<pre>
<configuration>
<applicationSettings>
<Qpr.ProcessAnalyzer.Service.Properties.Settings>
<setting name="ModelLoadOnStartup" serializeAs="String">
<value>True</value>
</setting>
</Qpr.ProcessAnalyzer.Service.Properties.Settings>
</applicationSettings>
</configuration>
</pre>

== Case Permissions ==
The '''Permissions''' section specifies data security restrictions for objects within the QPR ProcessAnalyzer model (i.e. limit visibility). If the Permissions section hasn't been defined, all the model data is visible to all users having '''GenericRead''' permission for the project in which the model resides ([[User Roles and Permissions in QPR ProcessAnalyzer|more information about roles and permissions]]). Permissions defined in this section, are only available when using the [[Installing QPR ProcessAnalyzer Server#Configure_Web_Service_to_use_In-Memory_or_In-Database_processing|In-Memory core]].

{| class="wikitable"
!'''Property'''
! '''Description'''
|-
|Initialization
|[[QPR_ProcessAnalyzer_Expressions|Expression language]] expression used to make an initial calculation for all the other expressions within this same permissions context. This expression can be used to improve performance when part of the Case or EventLogKey expressions are common and thus they don't need to be calculated again for every Case separately. See the examples below of using the Initialization expression.
|-
||Case
||[[QPR_ProcessAnalyzer_Expressions|Expression language]] expression determining which users can see each Cases. The expression is evaluated within the context of each Case. If the evaluation results '''true''', the Case is visible for the user. Otherwise the Case, its Events and case and event attributes are not visible. This setting implements case level security restrictions.
|-
||EventLogKey
||[[QPR_ProcessAnalyzer_Expressions|Expression language]] expression used to uniquely identify all the unique event logs created by case permission filters. If a cached EventLog with the same key is already in the system, that EventLog is used instead of creating a new. The new EventLog is created by applying the Case expression to filter the Cases users have rights to.
|}

=== Example usecase for case permissions ===
There are groups G1, G2 and G3. Case permissions have been set as follows:
* group G1 can only see cases where (case attribute) Region is Dallas
* group G2 can only see cases where Region is Austin
* group G3 can only see cases where Region is either Austin or New York

QPR ProcessAnalyzer model contains the following cases:
{| class="wikitable"
! Case name
! Region (case attribute)
! Groups can see
|-
|A
|Dallas
|G1
|-
|B
|Dallas
|G1
|-
|C
|Austin
|G2, G3
|-
|D
|New York
|G3
|-
|E
|New York
|G3
|-
|F
|New York
|G3
|}

Thus, when viewing analyses, a user see that the model contains the following cases:
* If the user belongs to group G1 only, the user can see cases A and B (2 cases)
* If the user belongs to group G2 only, the user can see case C (1 case)
* If the user belongs to group G3 only, the user can see cases C, D, E and F (4 cases)
* If the user belongs to groups G1 and G2 only, the user can see cases A, B and C (3 cases)

There is no way for a user to be aware of the existence of cases that the user doesn't have rights to.

=== Configuration examples for case permissions ===
In this example, visibility of cases is limited in a way that only those users can see the cases belonging to a user group which name is same as the Region (case attribute).
<pre>
{
"Permissions": {
"Initialization": "Let(\"groupNames\", OrderByValue(CurrentUser.GroupNames))",
"Case": "Region.In(groupNames)",
"EventLogKey": "StringJoin(\"_\", groupNames)"
}
}
</pre>

In this example, cases are only visible for users whose user name is same as the Account Manager (case attribute).
<pre>
{
"Permissions": {
"Initialization": "Let(\"userName\", CurrentUser.Name)",
"Case": "(Attribute(\"Account Manager\") == userName)",
"EventLogKey": "CurrentUser.Id"
}
}
</pre>

In this example, cases having "Region" case attribute of "Dallas" will only be visible for users belonging to user group "GroupA" (and "New York" for group "GroupB").
<pre>
{
"Permissions": {
"Initialization": "Let(\"groupNames\", CurrentUser.GroupNames)",
"Case": "(Region == \"Dallas\" && \"GroupA\".In(groupNames)) || (Region == \"New York\" && \"GroupB\".In(groupNames))",
"EventLogKey": "If(\"GroupA\".In(groupNames), \"_A\", \"_\") + If(\"GroupB\".In(groupNames), \"_B\", \"_\")"
}
}
</pre>

Case Level Permissions

2018-06-28T08:29:50Z

VesKivi: /* IIS setup */

Each QPR ProcessAnalyzer model has a '''[[Project_Workspace_in_QPR_ProcessAnalyzer_Excel_Client#Model_Properties|Configuration]]''' field containing model related settings in a JSON format. Those settings are documented in this page. When the model JSON configuration is changed, the model is dropped from the memory.

== Model Datasources ==
The '''DataSource''' section is used to define where the QPR ProcessAnalyzer model data is loaded. See below examples, how to construct the full JSON.
{| class="wikitable"
!'''Property'''
! '''Description'''
|-
|Cases
|
{| class="wikitable"
!'''Property'''
! '''Description'''
|-
||DataSourceType
||Datasource type to use, when fetching the Cases data. Currently the only supported value is '''odbc'''.
|-
||OdbcConnectionString
||ODBC connection string to use to fetch the Cases data. Connection strings can be found in https://www.connectionstrings.com.
|-
||OdbcQuery
||ODBC query to use to fetch the Cases data. Query syntax depends on the source system where the data is fetched.
|-
||Columns
||Column name mappings for QPR ProcessAnalyzer data model. Only supported mapping is '''CaseId''' defining the case id (case name). Example:
<pre>
{
"CaseId": "SalesOrderHeaderId"
}
</pre>
All unmapped columns are taken to the model as case attributes. If the fetched data doesn't contain a mapped column, the model loading fails and an error message is given.
|}

|-
||Events
||
{| class="wikitable"
!'''Property'''
! '''Description'''
|-
||DataSourceType
||Datasource type to use, when fetching the Events data. Currently the only supported value is '''odbc'''.
|-
||OdbcConnectionString
||ODBC connection string to use to fetch the Events data. Connection strings can be found in https://www.connectionstrings.com.
|-
||OdbcQuery
||ODBC query to use to fetch the Events data. Query syntax depends on the source system where the data is fetched.
|-
||Columns
||
Column name mappings for QPR ProcessAnalyzer data model. Supported mappings for Events are '''CaseId''', '''EventType''' and '''Timestamp'''. Example:
<pre>
{
"CaseId": "SalesOrderHeaderId",
"EventType": "EventType",
"Timestamp": "CreatedDate"
}
</pre>
All unmapped columns are taken to the model as event attributes. If the fetched data doesn't contain a mapped column, the model loading fails and an error message is given.
|}
|}

=== Example: Loading QPR ProcessAnalyzer models from ODBC datasources ===

==== ODBC Driver Installation ====
'''Microsoft Access Database Engine 2016 Redistributable''' is software package that contains ODBC drivers for
* Microsoft SQL Server
* Microsoft Access (*.mdb and *.accdb) files
* Microsoft Excel (*.xls, *.xlsx, and *.xlsb) files
* CSV text files

The package needs to be installed in the same computer where the QPR ProcessAnalyzer Server is running. Installation instructions:
# Go to https://www.microsoft.com/en-us/download/details.aspx?id=54920 and click Download.
# Select whether to use the 32bit or 64bit (x64) version (usually it's the 64bit version).
# Double-click the executable file on your hard disk to start the setup program.
# Follow the instructions on the screen to complete the installation.

==== Read data from CSV file ====
In this example, data is loaded from CSV files located in the file system using ''Microsoft Access Text Driver (*.txt, *.csv)'' driver. Loaded files are C:\ProcessMiningData\ModelCaseAttributes.csv and C:\ProcessMiningData\ModelEventData.csv.
<pre>
{
"DataSource": {
"Cases": {
"DataSourceType": "odbc",
"OdbcConnectionString": "Driver={Microsoft Access Text Driver (*.txt, *.csv)};DefaultDir=C:\\ProcessMiningData\\;Extensions=asc,csv,tab,txt",
"OdbcQuery": "SELECT * FROM [ModelCaseAttributes.csv]",
"Columns": {
"CaseId": "Name"
}
},
"Events": {
"DataSourceType": "odbc",
"OdbcConnectionString": "Driver={Microsoft Access Text Driver (*.txt, *.csv)};DefaultDir=C:\\ProcessMiningData\\;Extensions=asc,csv,tab,txt",
"OdbcQuery": "SELECT * FROM [ModelEventData.csv]",
"Columns": {
"CaseId": "Case",
"EventType": "Event Type",
"Timestamp": "Start Time"
}
}
}
}
</pre>

When reading from CSV files, you may need to set the CSV file format for the ODBC driver using the '''Schema.ini''' file (more information: https://docs.microsoft.com/en-us/sql/odbc/microsoft/schema-ini-file-text-file-driver?view=sql-server-2017).

==== Read data from Excel file ====
In this example, data is loaded from a Excel file that is accessible in the file system. In this example, the loaded file is C:\ProcessMiningData\ModelData.xlsx and cases are in sheet ''MyCases'' and events in sheet ''MyEvents''.

<pre>
{
"DataSource": {
"Cases": {
"DataSourceType": "odbc",
"OdbcConnectionString": "Driver={Microsoft Excel Driver (*.xls, *.xlsx, *.xlsm, *.xlsb)};DBQ=C:\\ProcessMiningData\\ModelData.xlsx",
"OdbcQuery": "SELECT * FROM [MyCases$]",
"Columns": {
"CaseId": "Case ID"
}
},
"Events": {
"DataSourceType": "odbc",
"OdbcConnectionString": "Driver={Microsoft Excel Driver (*.xls, *.xlsx, *.xlsm, *.xlsb)};DBQ=C:\\ProcessMiningData\\ModelData.xlsx",
"OdbcQuery": "SELECT * FROM [MyEvents$]",
"Columns": {
"CaseId": "Case ID",
"EventType": "Activity",
"Timestamp": "Start Time"
}
}
}
}
</pre>

==== Read data from SQL Server table ====
In this example, data is loaded from an SQL Server table. In this example, the SQL Server hostname is ''MySQLServer'' and database name is ''MyDatabase''.

<pre>
{
"DataSource": {
"Cases": {
"DataSourceType": "odbc",
"OdbcConnectionString": "Driver={SQL Server};Server=MySQLServer;DataBase=MyDatabase;Trusted_Connection=True;",
"OdbcQuery": "SELECT CASENAME, COST, COUNTRY, PRODUCT FROM CASES_TABLE",
"Columns": {
"CaseId": "CASENAME"
}
},
"Events": {
"DataSourceType": "odbc",
"OdbcConnectionString": "Driver={SQL Server};Server=MySQLServer;DataBase=MyDatabase;Trusted_Connection=True;",
"OdbcQuery": "SELECT CASENAME, CREATED_DATE, CREATED_BY FROM EVENT_TABLE",
"Columns": {
"CaseId": "CASENAME",
"Timestamp": "CREATED_DATE",
"EventType": "CREATED_BY"
}
}
}
}
</pre>

==== Troubleshooting ====

Most common reason for error 'System.Data.Odbc.OdbcException (0x80131937): ERROR [IM002] [Microsoft][ODBC Driver Manager] Data source name not found and no default driver specified' is driver is missing or driver name is not exactly correct.
* Check ODBC drivers is installed. 64-bit machine: C:\Windows\System32\odbcad32.exe
* Check connection string. Example 32-bit driver name 'Driver={Microsoft Text Driver (*.txt; *.csv)}' and 64-bit driver name 'Driver={Microsoft Access Text Driver (*.txt, *.csv)}'.

Example error when specified directory is missing: 'ERROR [HY024] [Microsoft][ODBC Text Driver] '(unknown)' is not a valid path. Make sure that the path name is spelled correctly and that you are connected to the server on which the file resides.'

Example error when CSV file is missing: 'System.Data.Odbc.OdbcException (0x80131937): ERROR [42S02] [Microsoft][ODBC Text Driver] The Microsoft Access database engine could not find the object 'CaseAttributes.csv'. Make sure the object exists and that you spell its name and the path name correctly. If 'CaseAttributes.csv' is not a local object, check your network connection or contact the server administrator.'

Error codes for troubleshooting are accessible from [https://docs.microsoft.com/en-us/sql/odbc/reference/appendixes/appendix-a-odbc-error-codes?view=sql-server-2017| ODBC Error Codes].

If the error message mention about Case or Event attributes named as ''F<column number>'' (e.g. F10), the data might be inconsistent, as there might be different amount of columns in different rows.

[https://devnet.onqpr.com/pawiki/index.php/Installing_QPR_ProcessAnalyzer_Server#Update_IIS_Application_pool_loadUserProfile_to_true Application pool crash]

== Model Load OnStartup ==
The '''LoadOnStartup''' section is used to define automatic the QPR ProcessAnalyzer model data loading in memory during startup. If value is true model is loaded on startup.
<pre>
{
"LoadOnStartup": true
}
</pre>

=== Necessary IIS setup ===

==== Install the Application Initialization role or feature ====
To support application initialization on your Web server, you must install the Application Initialization role or feature.

Windows Server 2012 or Windows Server 2012 R2
* On the taskbar, click Server Manager.
* In Server Manager, click the Manage menu, and then click Add Roles and Features.
* In the Add Roles and Features wizard, click Next. Select the installation type and click Next. Select the destination server and click Next.
* On the Server Roles page, expand Web Server (IIS), expand Web Server, expand Application Development, and then select Application Initialization. Click Next.
* .
* On the Select Features page, click Next.
* On the Confirm installation selections page, click Install.
* On the Results page, click Close.

==== Set the application pool to AlwaysRunning ====
You need to set the pool to AlwaysRunning. Open C:\Windows\System32\inetsrv\config\applicationHost.config and change the pool settings as shown below:
<pre>
<applicationPools> <add name=”MyAppPool” startMode=”AlwaysRunning” /> </applicationPools>
</pre>

==== Set site or application to Preloaded ====
Look for your site in the element and add preloadEnabled=”true”, for example:

preloadEnabled="true" applicationPool=".NET v4.5">

== Case Permissions ==
The '''Permissions''' section specifies data security restrictions for objects within the QPR ProcessAnalyzer model (i.e. limit visibility). If the Permissions section hasn't been defined, all the model data is visible to all users having '''GenericRead''' permission for the project in which the model resides ([[User Roles and Permissions in QPR ProcessAnalyzer|more information about roles and permissions]]). Permissions defined in this section, are only available when using the [[Installing QPR ProcessAnalyzer Server#Configure_Web_Service_to_use_In-Memory_or_In-Database_processing|In-Memory core]].

{| class="wikitable"
!'''Property'''
! '''Description'''
|-
|Initialization
|[[QPR_ProcessAnalyzer_Expressions|Expression language]] expression used to make an initial calculation for all the other expressions within this same permissions context. This expression can be used to improve performance when part of the Case or EventLogKey expressions are common and thus they don't need to be calculated again for every Case separately. See the examples below of using the Initialization expression.
|-
||Case
||[[QPR_ProcessAnalyzer_Expressions|Expression language]] expression determining which users can see each Cases. The expression is evaluated within the context of each Case. If the evaluation results '''true''', the Case is visible for the user. Otherwise the Case, its Events and case and event attributes are not visible. This setting implements case level security restrictions.
|-
||EventLogKey
||[[QPR_ProcessAnalyzer_Expressions|Expression language]] expression used to uniquely identify all the unique event logs created by case permission filters. If a cached EventLog with the same key is already in the system, that EventLog is used instead of creating a new. The new EventLog is created by applying the Case expression to filter the Cases users have rights to.
|}

=== Example usecase for case permissions ===
There are groups G1, G2 and G3. Case permissions have been set as follows:
* group G1 can only see cases where (case attribute) Region is Dallas
* group G2 can only see cases where Region is Austin
* group G3 can only see cases where Region is either Austin or New York

QPR ProcessAnalyzer model contains the following cases:
{| class="wikitable"
! Case name
! Region (case attribute)
! Groups can see
|-
|A
|Dallas
|G1
|-
|B
|Dallas
|G1
|-
|C
|Austin
|G2, G3
|-
|D
|New York
|G3
|-
|E
|New York
|G3
|-
|F
|New York
|G3
|}

Thus, when viewing analyses, a user see that the model contains the following cases:
* If the user belongs to group G1 only, the user can see cases A and B (2 cases)
* If the user belongs to group G2 only, the user can see case C (1 case)
* If the user belongs to group G3 only, the user can see cases C, D, E and F (4 cases)
* If the user belongs to groups G1 and G2 only, the user can see cases A, B and C (3 cases)

There is no way for a user to be aware of the existence of cases that the user doesn't have rights to.

=== Configuration examples for case permissions ===
In this example, visibility of cases is limited in a way that only those users can see the cases belonging to a user group which name is same as the Region (case attribute).
<pre>
{
"Permissions": {
"Initialization": "Let(\"groupNames\", OrderByValue(CurrentUser.GroupNames))",
"Case": "Region.In(groupNames)",
"EventLogKey": "StringJoin(\"_\", groupNames)"
}
}
</pre>

In this example, cases are only visible for users whose user name is same as the Account Manager (case attribute).
<pre>
{
"Permissions": {
"Initialization": "Let(\"userName\", CurrentUser.Name)",
"Case": "(Attribute(\"Account Manager\") == userName)",
"EventLogKey": "CurrentUser.Id"
}
}
</pre>

In this example, cases having "Region" case attribute of "Dallas" will only be visible for users belonging to user group "GroupA" (and "New York" for group "GroupB").
<pre>
{
"Permissions": {
"Initialization": "Let(\"groupNames\", CurrentUser.GroupNames)",
"Case": "(Region == \"Dallas\" && \"GroupA\".In(groupNames)) || (Region == \"New York\" && \"GroupB\".In(groupNames))",
"EventLogKey": "If(\"GroupA\".In(groupNames), \"_A\", \"_\") + If(\"GroupB\".In(groupNames), \"_B\", \"_\")"
}
}
</pre>

Case Level Permissions

2018-06-28T08:29:01Z