SQL Scripting for ETL: Difference between revisions

From QPR ProcessAnalyzer Wiki
Jump to navigation Jump to search
m (Reverted edits by TeeHiet (talk) to last revision by Johan)
Line 1: Line 1:
It is possible to load raw data into QPR ProcessAnalyzer and do the data transformation and loading into QPR ProcessAnalyzer Service via scripts using temporary database tables, so that the resulting transformed data can be used for analyses in QPR ProcessAnalyzer.
It is possible to load raw data into QPR ProcessAnalyzer and do the data transformation and loading into QPR ProcessAnalyzer Service via '''Load Scripts''' using temporary database tables, so that the resulting transformed data can be used for analyses in QPR ProcessAnalyzer.


A user with the ManageIntegrations and RunScripts permissions can define a script via the [[Script Management#Script Manager|Script Manager]] dialog. The script consists of SQL statements and QPR ProcessAnalyzer commands that take the preceding SQL statements as parameters.
A user with the ManageIntegrations and RunScripts permissions can define a '''Load Script''' in the [[Model Properties]] dialog. The Load Script consists of SQL statements and QPR ProcessAnalyzer commands that take the preceding SQL statements as parameters.


== Supported QPR ProcessAnalyzer Commands in Scripts ==
== Supported QPR ProcessAnalyzer Commands in Load Scripts ==
==== --#Exit ====
==== --#Exit ====
: Stops the execution of the script and gives a message to the user.
: Stops the execution of the script and gives a message to the user.
Line 10: Line 10:
: The parameters defined in the SQL SELECT statements:<br/>
: The parameters defined in the SQL SELECT statements:<br/>
:; 'Exit', '<Value>'
:; 'Exit', '<Value>'
:: Defines whether to stop the script execution:
:: Defines whether to stop the script execution. 1 = stop execution, 0 = do not stop execution.
:: 1 = stop execution of the current script and call the script defined by the RunsScriptId 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>'
:; 'MessageText', '<Text>'
:: Text to be shown to the user after the script execution is finished if the script finished because of the Exit command, i.e. when Exit=1. The default value is "Script execution finished.", which is shown also when the script finished normally, i.e. when Exit=0. The text is also written to the script log.
:: Text to be shown to the user after the script execution is finished if the script finished because of the Exit command, i.e. when Exit=1. The default value is "Script execution finished.", which is shown also when the script finished normally, i.e. when Exit=0.
:; 'RunScriptId', '<Id>'
:: Optional. The Id of the script to be run. Note that the script can call itself, so be careful not to create a looping script.


: '''Example'''
: '''Example'''
: The following example stops the script execution, gives a message, and runs a script with Id 12.
: The following example stops the script execution and gives a message.
: <code>
: <code>
: (SELECT 'Exit', '1') UNION ALL
: SELECT ('Exit', '1') UNION ALL
: (SELECT 'MessageText', 'Data from SAP not valid. Script execution will be terminated. Check source data. Running script Id 12.') UNION ALL
: SELECT ('MessageText', 'Data from SAP not valid. Script execution will be terminated. Check source data')
: (SELECT 'RunScriptId', '12')
: --#Exit
: --#Exit
</code>
</code>
----
----
==== --#GetAnalysis ====
: Creates an analysis from the data which the preceding SQL statements given as parameters provide. The analysis parameters have to be defined in the SQL SELECT statements as follows:<br/>


==== --#GetAnalysis ====
: '<Analysis Parameter>', '<Value>'
: Creates an analysis from the data which the preceding SQL statements given as parameters provide.


: '''Parameters'''
: See [[Analysis Parameters]] for a list of supported analysis parameters in QPR ProcessAnalyzer.
: The analysis parameters have to be defined in the SQL SELECT statements as follows:<br/>
:; '<Analysis Parameter>', '<Value>'
:: See [[Analysis Parameters]] for a list of supported analysis parameters in QPR ProcessAnalyzer.
:: The --#GetAnalysis command supports the following analysis types:
:: Flowchart Analysis (0)
:: Variation Analysis in the Chart Mode (1)
:: Path Analysis (3)
:: Event Type Analysis in the Chart Mode (4)
:: Case Analysis (5)
:: Event Analysis (6)
:: Event Type Analysis in the Table Mode (7)
:: Variation Analysis in the Table Mode (8)
:: Duration Analysis (9)
:: Profiling Analysis (10)
:: User Report (11)
:: OperationLog Analysis (12)
:: Flow Analysis (13)
:: Influence Analysis (14)
:: Data Table Analysis (18)
:; 'TargetTable', '<#TableName>'
:: The temporary table to which the analysis is to be stored. Note that only table format analyses can be stored to a temporary table.
:; 'Show', '<Value>'
:: Optional. If TRUE or 1, the analysis is opened after the script is run.
:; 'Title', '<Value>'
:: Optional. The title for the Excel sheet created when Show is TRUE or 1. Default value is the name of the analysis type.
:; 'SheetName', '<Value>'
:: Optional. The name of the Excel sheet created when Show is TRUE or 1. Default value is the name of the analysis type.


: '''Example'''
: The --#GetAnalysis command supports the following analysis types:
: The following example will get an Event analysis, open that analysis with "Analysis Title" as the title on a sheet named "Example Sheet Name", and store the Event analysis results to the "#ExampleTable" data table.
: Case Analysis (5)
: <code>
: Event Analysis (6)
: (SELECT 'AnalysisType', '6') UNION ALL
: Event Type Analysis (7) Note: analysis is in table format only.
: (SELECT 'MaximumCount', '0') UNION ALL
: Variation Analysis (8) Note: analysis is in table format only.
: (SELECT 'FilterId', '3') UNION ALL
: User Report (11)
: (SELECT 'SelectedEventAttributes', '*') UNION ALL
: OperationLog Analysis (12)
: (SELECT 'Show', '1') UNION ALL
: Flow Analysis (13)
: (SELECT 'Title', 'Analysis Title') UNION ALL
: Influence Analysis (14)
: (SELECT 'SheetName', 'Excel Sheet Name') UNION ALL
: Integration Table Analysis (18)
: (SELECT 'TargetTable' '#ExampleTable')
: --#GetAnalysis
: </code>
----
----
 
==== --#ImportCaseData ====
==== --#ImportCaseAttributes ====
: Loads Case Attributes from the data which the preceding SQL statements given as parameters provide.
: Loads Case Attributes from the data which the preceding SQL statements given as parameters provide into the specified model.
 
: '''Parameters for the First Query'''
: The parameters defined in the SQL SELECT statements:<br/>
:; 'ProjectId' or 'ProjectName', '<Value>'
:: 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', '<Value>'
:: 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', '<Value>'
:: Defines what to do with an existing target model case attributes. TRUE or any other Integer than "0" = the existing case attributes in the target model are not deleted before import, FALSE or "0" = the existing case attributes of the target model are deleted before the import. If the target model is set to use another model as the [[Model Properties|Case Attribute Model]], those case attributes are not deleted. Not used when creating a new model. Default value is TRUE.
: '''Parameters for the Second Query'''
:; '<data>'
:: The database query whose results are to be imported.
----
----
==== --#ImportDataTable ====
==== --#ImportDataTable ====
Line 112: Line 65:
: (SELECT 'AnalysisType', '6') UNION ALL
: (SELECT 'AnalysisType', '6') UNION ALL
: (SELECT 'MaximumCount', '0') UNION ALL
: (SELECT 'MaximumCount', '0') UNION ALL
: (SELECT 'FilterId', '3') UNION ALL
: (SELECT 'ViewId', '3') UNION ALL
: (SELECT 'SelectedEventAttributes', '*') UNION ALL
: (SELECT 'SelectedEventAttributes', '*') UNION ALL
: (SELECT 'TargetTable', '#AnalysisResult')
: (SELECT 'TargetTable', '#AnalysisResult')
Line 147: Line 100:
----
----
==== --#ImportEvents ====
==== --#ImportEvents ====
: Loads Events from the data which the preceding SQL statements given as parameters provide into the specified model.
: Loads Events from the data which the preceding SQL statements given as parameters provide.
 
: '''Parameters for the First Query'''
: The parameters defined in the SQL SELECT statements:<br/>
:; 'ProjectId' or 'ProjectName', '<Value>'
:: 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', '<Value>'
:: 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', '<Value>'
:: 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.
: '''Parameters for the Second Query'''
:; '<data>'
:: The database query whose results are to be imported.
----
----
==== --#ImportSalesforceQuery ====
==== --#ImportSalesforceQuery ====
: Extracts data from Salesforce cloud and imports it into a data table as NVARCHAR(MAX) or SQL_VARIANT type data. Note that this command requires the Salesforce username and password to be visible in the script!
: Extracts data from Salesforce cloud and imports it into a data table.
'''Parameters'''
: '''Parameters'''
: The parameters defined in the SQL SELECT statements in the order they are listed below:
: The parameters defined in the SQL SELECT statements in the order they are listed below:
'''Data Destination'''
:; 'TargetTable', '<#TableName>'
:: The temporary table to which the data is to be imported. If not used, define the target using the ProjectId/ProjectName, DataTableId/DataTableName, and Append parameters described below.
:; 'ProjectId' or 'ProjectName', '<Value>'
:; 'ProjectId' or 'ProjectName', '<Value>'
:: The id or the name of the project in which the target data table exists.
:: The id or the name of the project in which the target data table exists.
Line 175: Line 112:
:; 'Append', '<Value>'
:; 'Append', '<Value>'
:: Defines what to do with an existing target data table contents. TRUE or any other Integer than "0" = the existing contents in the target data table are not deleted before import, FALSE or "0" = the existing contents of the target data table are deleted before the import. Not used when creating a new data table.
:: 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.
'''Salesforce Query Parameters'''
:; 'SalesforceUser', '<Value>'
:; 'SalesforceUser', '<Value>'
:: Username for the Salesforce cloud.
:: Username for the Salesforce cloud.
:; 'SalesforcePW', '<Value>'
:; 'SalesforcePW', '<Value>'
:: Password for the Salesforce cloud.
:: Password for the Salesforce cloud.
:; 'SalesforceQueryMode', '<Value>'
:: 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', '<Value>'
:; 'SalesforceQuery', '<Value>'
:: 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.
:: The query to be run in the Salesforce cloud. 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.
:; 'SalesforceQueryRetries', '<Value>'
:; 'SalesforceQueryRetries', '<Value>'
:: Optional. Number of retries to attempt if the Salesforce query doesn't succeed. Default value is 3.
:: Number of retries to attempt if the Salesforce query doesn't succeed. Default value is 3.
:; 'SalesforceQueryRetryWait', '<Value>'
:; 'SalesforceQueryRetryWait', '<Value>'
:: Optional. Number of milliseconds to wait between query retries. Default is 3000 ms.
:: Number of milliseconds to wait between query retries. Default is 3000 ms.
:; 'SalesforceBatchSize', '<Value>'
:; 'SalesforceBatchSize', '<Value>'
:: Optional. The number of rows of data the query returns in one batch. Minimum = 200, Maximum = 2000, Default = 500. See [http://www.salesforce.com/us/developer/docs/api/Content/sforce_api_calls_query.htm Salesforce API] for more information.
:: Optional. The number of rows of data the query returns. 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.


: '''Example'''
: '''Example'''
: The following example will load date data from the "Contact" table in the Salesforce cloud and will put that data into the "ExampleDataTable" data table in the "ExampleProject" project. It will then get the Data Table analysis from the "ExampleDataTable", put that into the "#TABLE" temporary table and then show the contents of that table.
: The following example will load name data from the "Contact" table in the Salesforce cloud and will put that data into the "ExampleDataTable" data table in the "ExampleProject" project.
: <code>
: <code>
: (SELECT 'ProjectName', 'ExampleProject') UNION ALL
: (SELECT 'ProjectName', 'ExampleProject') UNION ALL
: (SELECT 'DataTableName', 'ExampleDataTable') UNION ALL
: (SELECT 'DataTableName', 'ExampleDataTable') UNION ALL
: (SELECT 'Append', '0') UNION ALL
: (SELECT 'Append', '0') UNION ALL
: (SELECT 'SalesforceUser', 'example.user@qpr.com') UNION ALL
: (SELECT 'SalesforceUser', 'example.user@somedomain.com') UNION ALL
: (SELECT 'SalesforcePW', 'examplepassword') UNION ALL
: (SELECT 'SalesforcePW', 'ExamplePassword123') UNION ALL
: (SELECT 'SalesforceQuery', 'SELECT CreatedDate FROM Contact')  
: (SELECT 'SalesforceQuery', 'SELECT FirstName, LastName FROM Contact') UNION ALL
: (SELECT 'SalesforceQueryRetries', '3') UNION ALL
: (SELECT 'SalesforceQueryRetryWait', '3000') UNION ALL
: (SELECT 'SalesforceBatchSize', '200')
: --#ImportSalesforceQuery
: --#ImportSalesforceQuery
: <br/>
: (SELECT 'AnalysisType', '18') UNION ALL
: (SELECT 'ProjectName', 'ExampleProject') UNION ALL
: (SELECT 'MaximumCount', '0') UNION ALL
: (SELECT 'DataTableName', 'ExampleDataTable') UNION ALL
: (SELECT 'TargetTable', '#TABLE')
: --#GetAnalysis
: <br/>
: (SELECT * FROM #TABLE)
: (SELECT 'MaximumCount', '0')
: --#ShowReport
</code>
</code>
----
==== --#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.
: '''Parameters'''
: The parameters defined in the SQL SELECT statements in the order they are listed below.
'''Destination Parameters:'''
:; 'TargetTable', '<#TableName>'
:: If this parameter is given, store the results into a temporary SQL table in ETL sandbox.
If the TargetTable parameter is not given, use the following destination parameters:
:; 'ProjectId' or 'ProjectName', '<Value>'
:: The id or the name of the project in which the target data table exists.
:; 'DataTableId' or 'DataTableName', '<Value>'
:: The id or the name of the existing/new target data table.
:; 'Append', '<Value>'
:: Defines what to do with an existing target data table contents. TRUE or any other Integer than "0" = the existing contents in the target data table are not deleted before import, FALSE or "0" = the existing contents of the target data table are deleted before the import. Not used when creating a new data table.
'''SAP Connection Parameters:'''
:; 'SapUser', '<Username>'
:: SAP user used to connect to SAP. Mandatory. See the [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
:; 'SapPW', '<Password>'
:: Password of the SAP user used to connect to SAP. Mandatory. See the [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
:; 'SapClient', '<Value>'
:: The SAP backend client. Mandatory. See the [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
:; 'SapAppServerHost', '<Hostname or IP>'
:: The hostname or IP of the specific SAP application server, to which all connections shall be opened. Mandatory if SapMessageServerHost is not defined. See the [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
:; 'SapMessageServerHost', '<Hostname or IP>'
:: The hostname or IP of the SAP system’s message server (central instance). Mandatory if SapAppServerHost is not defined. See the [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
:; 'SapSystemNumber', '<Value>'
:: The SAP system’s system number. Mandatory if SapSystemID is not defined. See the [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
:; 'SapSystemId', '<Value>'
:: The SAP system’s three-letter system ID. Mandatory if SapSystemNumber is not defined. See the [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
'''Other SAP Parameters:'''
:; 'SapLanguage', '<Value>'
:: SAP language used. Default value is "EN". Optional. See the [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
:; 'SapPoolSize', '<Number>'
:: The maximum number of RFC connections that this destination will keep in its pool. Default value is "5". Optional. See the [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
:; 'SapMaxPoolSize', '<Value>'
:: In order to prevent an unlimited number of connections to be opened, you can use this parameter. Default value is "10". Optional.  See the [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
:; 'SapIdleTimeout', '<Value>'
:: If a connection has been idle for more than SapIdleTimeout seconds, it will be closed and removed from the connection pool upon checking for idle connections or pools. Default value is "600". Optional.  See the [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
:; 'SapRouter', '<List>'
:: A list of host names and service names / port numbers for the SAPRouter in the following format: /H/hostname/S/portnumber. Optional.  See the [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
:; 'SapLogonGroup', '<Value>'
:: The logon group from which the message server shall select an application server. Optional. See the [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
:; 'SapQueryMode', '<Number>'
:: If this is set to "1", then the query result will have the SAP Table field names as data table column names and actual data rows as rows. If this is set to "3", the query result will get the field descriptions from the SAP query using NO_DATA parameter, i.e. the returned columns are the following (in this order): Field, Type, Description, Length, Offset. Default value is "1". Optional. See the [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
:; 'SapQueryTable', '<Name>'
:: Name of the SAP table to be extracted. Specifies the value for the parameter QUERY_TABLE in tab: 'Import' or function module 'rfc_read_table' in SAP. Mandatory. See the [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
:; 'SapRowcount', '<Value>'
:: The maximum amount of rows to fetch. Specifies the value for parameter ROWCOUNT in tab: 'Import' or function module 'rfc_read_table' in SAP. Optional. See the [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
:; 'SapRowskips', '<Value>'
:: The amount of rows to skip. Specifies the value for parameter ROWSKIPS in tab: 'Import' or function module 'rfc_read_table'. in SAP. Optional. See the [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
:; 'SapWhereClause', '<List>'
:: A comma separated list of where clause elements. Specifies the value for parameter OPTIONS in tab: 'Import' or function module 'rfc_read_table' in SAP. NOTE: maximum length for Where Clause string is 72 characters. Optional. See the [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
:; 'SapFieldNames', '<List>'
:: A comma separated list of field names for columns to be imported. Default value is empty, resulting in all columns being imported. Specifies the value for parameter FIELDNAME in tab: 'Tables' for table 'FIELDS' for function module 'rfc_read_table' in SAP. Optional. See the [http://help.sap.com/saphelp_nw04/helpdata/en/e9/23c80d66d08c4c8c044a3ea11ca90f/content.htm SAP .NET Connector documentation] for more info.
: '''Example'''
: The following script will get the "VBELN", "ERDAT", "ERZET", "ERNAM", "NETWR", and "WAERK" columns from the "VBAK" table in a SAP system and put them into a data table named "SapQueryTableExample".
: <code>
:(SELECT 'ProjectName', 'ImportSapQueryExample') UNION ALL
:(SELECT 'DataTableName', 'SapQueryTableExample') UNION ALL
:(SELECT 'Append', 'TRUE') UNION ALL
:(SELECT 'SapUser', 'exampleuser') UNION ALL
:(SELECT 'SapPW', 'examplepassword') UNION ALL
:(SELECT 'SapClient', '200') UNION ALL
:(SELECT 'SapAppServerHost', '127.0.0.1') UNION ALL
:(SELECT 'SapSystemNumber', '10') UNION ALL
:(SELECT 'SapLanguage', 'EN') UNION ALL
:(SELECT 'SapPoolSize', '5') UNION ALL
:(SELECT 'SapMaxPoolSize', '10') UNION ALL
:(SELECT 'SapIdleTimeout', '600') UNION ALL
:(SELECT 'SapRouter', '/H/127.0.0.1/A/1234/H/') UNION ALL
:(SELECT 'SapLogonGroup', 'GROUPXNAME') UNION ALL
:(SELECT 'SapQueryMode', '1') UNION ALL
:(SELECT 'SapQueryTable', 'VBAK') UNION ALL
:(SELECT 'SapDelimiter', '|') UNION ALL
:(SELECT 'SapRowcount', '0') UNION ALL
:(SELECT 'SapRowskips', '0') UNION ALL
:(SELECT 'SapWhereClause', 'VBELN EQ `0060000039`, OR VBELN EQ `0060000040`') UNION ALL
:(SELECT 'SapFieldNames', 'VBELN,ERDAT,ERZET,ERNAM,NETWR,WAERK')
:--#ImportSapQuery</code>
----
----


==== --#RemoveEvents ====
==== --#RemoveEvents ====
: Removes all events in the target model, but retains Cases, Event Types, and Variations.
: Removes all events in the model, but retains Cases, Event Types, and Variations.
: '''Parameters'''
: The parameters defined in the SQL SELECT statements:<br/>
:; 'ProjectId' or 'ProjectName', '<Value>'
:: The id or the name of the project in which the target model exists. Defaults to the current project.
:; 'ModelId' or 'ModelName', '<Value>'
:: The id or the name of the target model. Defaults to the current model. If ModelId is given, neither ProjectId nor ProjectName are used.
 
: '''Example'''
: The following example will remove all events in the model with Id "22931" in the project with Id "234".
: <code>
: (SELECT 'ProjectId', '234') UNION ALL
: (SELECT 'ModelId', '22931')
: --#RemoveEvents
</code>
----
----
==== --#SendEmail ====
: Sends an e-mail and writes a message to script log whether sending the email was succesful or not. Script execution continues even when the sending isn't succesful.
: '''Parameters'''
: The parameters defined in the SQL SELECT statements:<br/>
'''E-mail Parameters'''
:; 'EmailFrom', '<Address>'
:: Defines the from address for this e-mail message. Mandatory.
:; 'EmailTo', '<Address list>'
:: Defines the recipient(s) for this e-mail message given in a list separated by comma. Mandatory.
:; 'EmailSubject', '<Text>'
:: Defines the subject of the email. Default value is empty. Optional.
:; 'EmailBody', '<Text>'
:: Defines the message body. Default value is empty. Optional.
:; 'EmailCc', '<Address list>'
:: Defines the carbon copy recipient(s) for this e-mail message given in a list separated by comma. Optional.
:; 'EmailBcc', '<Address list>'
:: Defines the blind carbon copy recipient(s) for this e-mail message given in a list separated by comma. Optional.
:; 'EmailIsBodyHtml', '<Value>'
:: 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', '<Address>'
:: Defines the sender's address for this e-mail message. Default value is empty. Optional.
:; 'EmailReplyTo', '<Address list>'
:: Defines the ReplyTo address(es) for the mail message given in a list separated by comma. Optional.
:; 'EmailPriority', '<Value>'
:: Defines the priority of this e-mail message. Possible values are "High", "Normal", and "Low". Default value is "Normal". Optional.
:; 'EmailDeliveryNotification', '<Value>'
:: Defines the delivery notifications for this e-mail message. Possible values are "Delay", "Never", "None", "OnFailure", and "OnSuccess". Default value is "None". Optional.
:; 'EmailBodyEncoding', '<Encoding>'
:: 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', '<Encoding>'
:: Defines the encoding used for the subject content for this e-mail message. Supported encodings are listed in the "Remarks" section at http://msdn.microsoft.com/en-us/library/System.Text.Encoding.aspx. Optional.
'''SMTP Server Parameters'''
:; 'SmtpServer', '<Value>'
:: Defines the hostname or the IP adress of the server. Mandatory for the first occurrence of the SendEmail command during script execution.
:; 'SmtpPort', '<Value>'
:: Defines the port of the SMTP server. Default value is "25". Optional.
:; 'SmtpAuthenticationUsername', '<User name>'
:: 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', '<Password>'
:: 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 ', '<Value>'
:: Defines whether SSL should be enabled for the SMTP connection. TRUE or any other Integer than "0" = SSL is enabled, FALSE or "0" = SSL is not enabled. Default value is "FALSE". Optional.
: '''Example'''
: The following example will send an e-mail message to multiple recipients:
: <code>
: (SELECT 'EmailFrom', 'example.from@address.com') UNION ALL
: (SELECT 'EmailTo', 'recipient.one@address.com,recipient.two@address.com,recipient.three@address.com') UNION ALL
: (SELECT 'EmailSubject', 'Example E-mail') UNION ALL
: (SELECT 'EmailBody', 'QPR ProcessAnalyzer example script started running.') UNION ALL
: (SELECT 'SmtpServer', 'localhost')
: --#SendEmail
</code>
See also [[How to Define the SMTP Server Connection in an On-Site Deployment]].
----
==== --#ShowReport ====
==== --#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.
: 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.
Line 388: Line 154:
:: Optional. The [[Analysis Parameters]] given for the operation. Some suggested parameters to be used:
:: Optional. The [[Analysis Parameters]] given for the operation. Some suggested parameters to be used:
:: 'Title', '<Title of the report>'
:: 'Title', '<Title of the report>'
::: The title of the created report. If not given, "Report" will be used as a default.
::: Name of the created report (used as sheet name in QPR ProcessAnalyzer Excel Client). Any existing sheet with the same title will be overwritten, so a script containing multiple ShowReport commands should use a unique title for each of the ShowReport commands. If not given, "Report" will be used as a default.
:: 'SheetName', '<Name for the sheet>'
::: The name of the Excel sheet to be created.
:: 'MaximumCount', '<Value>'
:: 'MaximumCount', '<Value>'
::: The maximum number of rows to show (0 = all, default = 1000).
::: The maximum number of rows to show (0 = all, default = 1000).
Line 404: Line 168:
:
:
: SELECT * FROM #AnalysisResult;  
: SELECT * FROM #AnalysisResult;  
: (SELECT 'Title', 'Report1') UNION ALL
: (SELECT 'Title', 'Report1') UNION ALL  
: (SELECT 'SheetName', 'Sheet1') UNION ALL
: (SELECT 'MaximumCount', '0')  
: (SELECT 'MaximumCount', '0')  
: --#ShowReport  
: --#ShowReport  
Line 425: Line 188:
</code>
</code>
----
----
== Script Variables ==
The scripts have the following variables available:
* '''@_ProjectId''': the Id of the project in whose context the script is being run. BIGINT.
* '''@_ModelId''': the Id of the model in whose context the script is being run. BIGINT.
* '''@_FilterId''': the Id of the view in whose context the script is being run. BIGINT.
* '''@_QPRProcessAnalyzerVersion''': the QPR Process Analyzer core dll version as string in the format: <major>.<minor>.<build>.<revision>. NVARCHAR(64).
* '''@_ScriptingVersion''': The scripting version number that identifies the version which was used when script was saved. Can be used for indicating, for example, the version for which the script was originally planned. A script created for newer (bigger) scripting version doesn't necessarily work on a PA server supporting older (smaller) version. INT.
* '''@_UserId''': the Id of the user running the script. INT.
* '''@_ScriptId''': Id of the script being run. BIGINT.
* '''@_EngineScriptingVersion''': The scripting version that identifies the functionalities available from QPR ProcessAnalyzer server. A script created for newer (bigger) scripting version doesn't necessarily work on a QPR ProcessAnalyzer server supporting older (smaller) version. INT.
* '''@_DatabaseId''': the Id of the database in use. GUID.
* '''#_ViewSettings''': The Settings shown in the right-hand pane in Excel used to generate the selected view. Note that this doesn't include analysis results or QPR ProcessAnalyzer Server related information, such as FilterId, TotalEventCount, or DatabaseId. Represented as a table two column table variable. The columns are:
** Name: the name of the parameter. NVARCHAR(440).
** Value: the value of the parameter. NVARCHAR(MAX).
* '''#_Selection''': The objects the user has currently selected on the analysis. Supported objects are the event types and transitions in the Flowchart or Path analyses and the Excel cells in the Duration, Profiling, Cases, Variations, Event Types, or Flows analyses. Any filters already applied are included in the selection. The maximum supported amount for the selection is 1000 separate objects and 10000 cells and their values. Represented as a three column table variable. The columns are:
:* Type: the type of the selected object. INT.
:{|
|STYLE="vertical-align: top"|
{| class="wikitable"
! Type
! Description
|-
|0
|Common. Values for the Common Type are represented as a Value-IntValue pair. See the table on the right for descriptions.
|-
|2
|Activity
|-
|6
|Activity Path
|-
|8
|Attribute Value
|-
|10
|Case
|-
|12
|Count
|-
|14
|Duration
|-
|16
|Transition
|-
|18
|Variation
|}
|STYLE="vertical-align: top; padding-left: 20px"|
{| class="wikitable"
! Common Type Value
! Description
|-
|NumberOfActivities
|The amount of activities in the selection.
|-
|NumberOfActivityPaths
|The amount of activity paths in the selection.
|-
|NumberOfAttributeValues
|The amount of attribute values in the selection.
|-
|NumberOfCases
|The amount of cases in the selection.
|-
|NumberOfCounts
|See the "Group By Event Count" entry in the [[Variations]] page.
|-
|NumberOfDurations
|The amount of durations in the selection.
|-
|NumberOfTransitions
|The amount of transitions in the selection.
|-
|NumberOfVariations
|The amount of variations in the selection.
|-
|DurationGranularity
|The duration time unit used in the selection. See the "Group By" entry in the [[Duration Analysis]] page for reference.
|-
|DurationMaximum
|The duration limit in the selection. See the "Duration Limit" entry in the [[Duration Analysis]] page for reference.
|-
|ReversedPaths
|The value is "1" if the "Predecessors" Direction was selected in the [[Path Analysis]], otherwise "0".
|-
|SelectionType
|What was selected. The value for this parameter is shown on the "Value" column instead of the IntValue column.
|}
|}
* IntValue: the integer representation of the selection value (used for object IDs etc). BIGINT.
* Value: the string representation of the selected value. Used for selections that require more complex representation than single integer value. NVARCHAR(MAX).
<br/>
Note that even when a script context hasn't been selected, the variables get their values from a default filter. The default filter is the filter that was last used by the user in the model the user has last opened. If the user hasn't opened any model before, the default filter is taken from the last created model to which the user has access rights.
: '''Example'''
: The following script fragment defines the ProjectId, ModelId, and FilterId parameters by using the script variables:
:<code>SELECT @_ProjectId as ProjectId, @_ModelId as ModelId, @_FilterId as FilterId;</code>
: '''Example'''
: The following script gets the View Settings currently in use in the Settings pane in Excel and shows them as a table in a new Excel sheet:
:<code>(SELECT * FROM #_ViewSettings)
:(SELECT 'SheetName', 'ViewSettings')
:--#ShowReport</code>
: '''Example'''
: The following script gets the current selection on the analysis and shows the data as a table in a new Excel sheet:
:<code>(SELECT * FROM #_Selection)
:(SELECT 'SheetName' , 'Selection')
:--#ShowReport</code>
: '''Example'''
: The following script gets various information about the environment and shows them in a new Excel sheet:
:<code>SELECT  @_QPRProcessAnalyzerVersion as QPRProcessAnalyzerVersion, @_ScriptingVersion as ScriptingVersion, @_EngineScriptingVersion as EngineScriptingVersion, @_UserId as Userid, @_DatabaseId as DatabaseId
:(SELECT 'SheetName', 'Info')
:--#ShowReport</code>


== SQL Command Support ==
== SQL Command Support ==
Line 552: Line 195:
The [http://msdn.microsoft.com/en-us/library/ms176047.aspx Print SQL statement] can be used to generate log entries into the script execution log.
The [http://msdn.microsoft.com/en-us/library/ms176047.aspx Print SQL statement] can be used to generate log entries into the script execution log.


== Running Scripts ==
== Running Load Scripts ==
A script can be run in the following ways:
A load script can be run in two ways:


=== Running a Script from the Ribbon ===
=== Running a Load Script from the Model Properties Dialog ===
# On the QPR ProcessAnalyzer tab of the ribbon, click '''Run'''.
# On the QPR ProcessAnalyzer tab of the ribbon, click '''Project Workspace'''.
# Select the script to be run from the Script Gallery that opens.
# From the model list, select the desired model that contains a load script.
 
# Click '''Properties'''.
=== Running a Script from the Script Manager Dialog ===
# Click '''Run Script'''.
# On the QPR ProcessAnalyzer tab of the ribbon, click '''Run''' > '''Manage Scripts'''.
# From the dialog, select the context in which the script you wish to run exists.
# Select the script you wish to run.
# Click '''Run'''.


=== Running a Script by Importing a .pasql File ===
=== Running a Load Script by Importing a .pasql File ===
# Write the script into a file that has a .pasql file format.
# Write the load script into a file that has a .pasql file format.
# On the QPR ProcessAnalyzer tab of the ribbon, click '''Project Workspace'''.
# On the QPR ProcessAnalyzer tab of the ribbon, click '''Project Workspace'''.
# Click '''Import'''.
# Click '''Import'''.
# Select '''QPR ProcessAnalyzer File''' and click '''Next'''.
# Select '''QPR ProcessAnalyzer File''' and click '''Next'''.
# Click '''Select''' and choose '''QPR ProcessAnalyzer SQL Script File (*.pasql)''' from the file type menu.
# Click '''Select''' and choose '''QPR ProcessAnalyzer SQL Script File (*.pasql)''' from the file type menu.
# Browse to the .pasql file containing the script, select it, and click '''Open'''.
# Browse to the .pasql file containing the load script, select it, and click '''Open'''.
# Click '''Next'''.
# Click '''Next'''.
# Select the import target:
# Select the import target:
#* '''Create New''' will create a new model and set it as the target of the script.
#* '''Create New''' will create a new model and set it as the target of the load script.
#* '''Add to Existing''' will set the target of the script to the selected model.
#* '''Add to Existing''' will set the target of the load script to the selected model.
#: Either way, the script in the .pasql file will be set as the script of the target model.
#: Either way, the script in the .pasql file will be set as the Load Script of the target model.
# Click '''Import'''.
# Click '''Import'''.


== Terminating Scripts ==
== Terminating Load Scripts ==
A script can be terminated by the following ways:
A Load Script can be terminated by the following ways:
*The user running the script can click the '''Cancel''' button when the script is running.
*The user running the script can click the '''Cancel''' button when the script is running.
*The script can use the "--#Exit" command stop script execution.
*The script can use the "--#Exit" command stop script execution.
*A QPR ProcessAnalyzer Administrator user can terminate the script via the Operations Log.
*A QPR ProcessAnalyzer Administrator user can terminate the script via the Operations Log.
*The SQL Server System Administrator can kill the session using the script by using e.g. SQL Server Management Studio.
*The SQL Server System Administrator can kill the session using the script by using e.g. SQL Server Management Studio.
*The Internet Information Services Administrator can recycle the application pool if the script has caused it to hang. Note however, that this may also cause other requests by other users being processed at the same time to be aborted.
*The Internet Information Services Administrator can recycle the application pool if the Load Script has caused it to hang. Note however, that this may also cause other requests by other users being processed at the same time to be aborted.
*The Windows Administrator can kill the w3wp.exe-process processing a problematic script. Note however, that this may also cause other requests by other users being processed at the same time to be aborted.
*The Windows Administrator can kill the w3wp.exe-process processing a problematic script. Note however, that this may also cause other requests by other users being processed at the same time to be aborted.


'''NOTE!'''<br/>
'''NOTE!'''<br/>
Terminating the script will not revert any changes the script has already done in the database before the Cancel button is clicked.
Terminating the Load Script will not revert any changes the script has already done in the database before the Cancel button is clicked.


== Things to Note About Scripts ==
== Things to Note About Load Scripts ==
When writing and using scripts, take the following things into account:
When writing and using Load Scripts, take the following things into account:
* Only those lines in the script that start with "--#" (without the quotes) are treated as QPR ProcessAnalyzer Commands, i.e. if there are leading whitespaces before the command, the line is treated as a comment.
* Only those lines in the script that start with "--#" (without the quotes) are treated as QPR ProcessAnalyzer Commands, i.e. if there are leading whitespaces before the command, the line is treated as a comment.
* If you don't define a value for the MaximumCount parameter, 1000 will be used as default, i.e. only the 1000 first rows from a given table or model will be used.
* If you don't define a value for the MaximumCount parameter, 1000 will be used as default, i.e. only the 1000 first rows from a given table or model will be used.
* When doing more advanced operations with scripts, you may run into the error messages such as: "'''The data types sql_variant and varchar are incompatible in the add operation.'''", "'''Argument data type sql_variant is invalid for argument 1 of like function.'''", "'''Argument data type sql_variant is invalid for argument 1 of left function.'''". This is because [[Case Attribute|case attributes]], [[Event Attribute|event attributes]], and data inside [[Data Table|data tables]] are '''sql_variant''' type data. In order to use them with more advanced operations (e.g. Add), you need to CONVERT or CAST them into some other data type before the operations. See [[#ConvertExample|this example]].
* When doing more advanced operations with Load scripts, you may run into the error messages such as: "'''The data types sql_variant and varchar are incompatible in the add operation.'''", "'''Argument data type sql_variant is invalid for argument 1 of like function.'''", "'''Argument data type sql_variant is invalid for argument 1 of left function.'''". This is because [[Case Attribute|case attributes]], [[Event Attribute|event attributes]], and data inside [[Data Table|data tables]] are '''sql_variant''' type data. In order to use them with more advanced operations (e.g. Add), you need to CONVERT or CAST them into some other data type before the operations. See [[#ConvertExample|this example]].


== Troubleshooting Scripts ==
== Example Load Scripts ==
=== Invalid Object Name ===
* '''"Invalid object name" exception is thrown when running a script with #GetAnalysis and #ImportEvents commands. What causes this?
: 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:
: <code>
: /*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
:<br/>
: /*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
:<br/>
: /*Then we use the ImportEvents */
:(SELECT 'ProjectName', 'ExampleProject') UNION ALL
:(SELECT 'ModelName', 'ExampleModel')
:(SELECT * FROM [#AnalysisResult])
:--#ImportEvents
</code>


== Example Scripts ==
=== Example Load Script: Create a copy of existing model ===
 
The following Load Script will:<br/>
=== Example Script: Create a copy of existing model ===
1. Clear the current contents of the model<br/>
The following script will:<br/>
2. Select all events from another model defined with ViewId = 1234567. (note: change this Id to be an Id from the default Filter (previously called View) of the source model:<br/>
1. Clear the current contents of the target model
* ProjectName ExampleProject => CHANGE THIS to be the project in which the target model exists.
* ModelName ExampleModel => CHANGE THIS to be the name of the target model.
 
2. Select all events from another model defined with FilterId = 1234567. (note: change this Id to be an Id from the default Filter (previously called View) of the source model:<br/>
* AnalysisType 6 => Event Table
* AnalysisType 6 => Event Table
* MaximumCount 0 => Retrieve all events from the model
* MaximumCount 0 => Retrieve all events from the model
* FilterId 1234567 => CHANGE THIS to be the Filter ID / FilterId of the source model from which you want to make a copy
* ViewId 1234567 => CHANGE THIS to be the Filter ID / ViewId of the source model from which you want to make a copy
* SelectedEventAttributes * => Get all Event Attributes
* SelectedEventAttributes * => Get all Event Attributes
* TargetTable #AnalysisResult => Store the result into a temporary SQL table named #AnalysisResult
* TargetTable #AnalysisResult => Store the result into a temporary SQL table named #AnalysisResult
* #GetAnalysis => Execute the query (stores the result into #AnalysisResult)
* #GetAnalysis => Execute the query (stores the result into #AnalysisResult)


3. Import all events to the specified model (#ImportEvents)
3. Import all events to the current model (#ImportEvents)
* ProjectName ExampleProject => CHANGE THIS to be the project in which the target model exists.
* ModelName ExampleModel => CHANGE THIS to be the name of the target model.


4. Select all case attributes from the source model (defined with FilterId = 1234567)
4. Select all case attributes from the source model (defined with ViewId = 1234567)
* AnalysisType 5 => Case Table
* AnalysisType 5 => Case Table
* MaximumCount 0 => Retrieve all cases from the model
* MaximumCount 0 => Retrieve all cases from the model
* FilterId 1234567 => CHANGE THIS to be the Filter ID / FilterId of the source model from which you want to copy case attributes
* ViewId 1234567 => CHANGE THIS to be the Filter ID / ViewId of the source model from which you want to copy case attributes
* SelectedCaseAttributes * => Get all Case Attributes
* SelectedCaseAttributes * => Get all Case Attributes
* TargetTable #AnalysisResult2 => Store the result into a new temporary SQL table named #AnalysisResult2
* TargetTable #AnalysisResult2 => Store the result into a new temporary SQL table named #AnalysisResult2
* #GetAnalysis => Execute the query (stores the result into #AnalysisResult)
* #GetAnalysis => Execute the query (stores the result into #AnalysisResult)


5. Import all case attributes to the specified model (#ImportCaseAttributes)
5. Import all case attributes to the current model (#ImportCaseData)
* ProjectName ExampleProject => CHANGE THIS to be the project in which the target model exists.
* ModelName ExampleModel => CHANGE THIS to be the name of the target model.


<pre>
<pre>
(SELECT 'ProjectName', 'ExampleProject') UNION ALL
(SELECT 'ModelName', 'ExampleModel')
--#RemoveEvents
--#RemoveEvents


(SELECT 'AnalysisType', '6') UNION ALL
(SELECT 'AnalysisType', '6') UNION ALL
(SELECT 'MaximumCount', '0') UNION ALL
(SELECT 'MaximumCount', '0') UNION ALL
(SELECT 'FilterId', '1234567') UNION ALL
(SELECT 'ViewId', '1234567') UNION ALL
(SELECT 'SelectedEventAttributes', '*') UNION ALL
(SELECT 'SelectedEventAttributes', '*') UNION ALL
(SELECT 'TargetTable', '#AnalysisResult')
(SELECT 'TargetTable', '#AnalysisResult')
--#GetAnalysis
--#GetAnalysis


(SELECT 'ProjectName', 'ExampleProject') UNION ALL
SELECT * FROM [#AnalysisResult]
(SELECT 'ModelName', 'ExampleModel')
(SELECT * FROM [#AnalysisResult])
--#ImportEvents
--#ImportEvents


(SELECT 'AnalysisType', '5') UNION ALL
(SELECT 'AnalysisType', '5') UNION ALL
(SELECT 'MaximumCount', '0') UNION ALL
(SELECT 'MaximumCount', '0') UNION ALL
(SELECT 'FilterId', '1234567') UNION ALL
(SELECT 'ViewId', '1234567') UNION ALL
(SELECT 'SelectedCaseAttributes', '*') UNION ALL
(SELECT 'SelectedCaseAttributes', '*') UNION ALL
(SELECT 'TargetTable', '#AnalysisResult2')
(SELECT 'TargetTable', '#AnalysisResult2')
--#GetAnalysis
--#GetAnalysis


(SELECT 'ProjectName', 'ExampleProject') UNION ALL
SELECT * FROM [#AnalysisResult2]
(SELECT 'ModelName', 'ExampleModel')
--#ImportCaseData
(SELECT * FROM [#AnalysisResult2])
--#ImportCaseAttributes
</pre>
</pre>


=== Example Script: Create an extended copy of existing model with new case attributes ===
=== Example Load Script: Create an extended copy of existing model with new case attributes ===
This scripts extends the simple model copying script by creating new case attributes from Case Table report<br/>
This scripts extends the simple model copying script by creating new case attributes from Case Table report<br/>
1. Clear the current contents of the target model
1. Clear the current contents of the model<br/>
* ProjectName ExampleProject => CHANGE THIS to be the project in which the target model exists.
2. Select all events from another model defined with ViewId = 1234567. (note: change this Id to be an Id from the default Filter (previously called View) of the source model:<br/>
* ModelName ExampleModel => CHANGE THIS to be the name of the target model.
2. Select all events from another model defined with FilterId = 1234567. (note: change this Id to be an Id from the default Filter (previously called View) of the source model:<br/>
* AnalysisType 6 => Event Table
* AnalysisType 6 => Event Table
* MaximumCount 0 => Retrieve all events from the model
* MaximumCount 0 => Retrieve all events from the model
* FilterId 1234567 => CHANGE THIS to be the Filter ID / FilterId of the source model from which you want to make a copy
* ViewId 1234567 => CHANGE THIS to be the Filter ID / ViewId of the source model from which you want to make a copy
* SelectedEventAttributes * => Get all Event Attributes
* SelectedEventAttributes * => Get all Event Attributes
* TargetTable #AnalysisResult => Store the result into a temporary SQL table named #AnalysisResult
* TargetTable #AnalysisResult => Store the result into a temporary SQL table named #AnalysisResult
* #GetAnalysis => Execute the query (stores the result into #AnalysisResult)
* #GetAnalysis => Execute the query (stores the result into #AnalysisResult)


3. Import all events to the specified model (#ImportEvents)
3. Import all events to the current model (#ImportEvents)
* ProjectName ExampleProject => CHANGE THIS to be the project in which the target model exists.
* ModelName ExampleModel => CHANGE THIS to be the name of the target model.


4. Select all case attributes from the source model (defined with FilterId = 1234567)
4. Select all case attributes from the source model (defined with ViewId = 1234567)
* AnalysisType 5 => Case Table
* AnalysisType 5 => Case Table
* MaximumCount 0 => Retrieve all cases from the model
* MaximumCount 0 => Retrieve all cases from the model
* FilterId 1234567 => CHANGE THIS to be the Filter ID / FilterId of the source model from which you want to copy case attributes
* ViewId 1234567 => CHANGE THIS to be the Filter ID / ViewId of the source model from which you want to copy case attributes
* SelectedCaseAttributes * => Get all Case Attributes
* SelectedCaseAttributes * => Get all Case Attributes
* SelectedActivityCounts * => Get the counts for all EventTypes
* SelectedActivityCounts * => Get the counts for all EventTypes
Line 723: Line 313:
* #GetAnalysis => Execute the query (stores the result into #AnalysisResult)
* #GetAnalysis => Execute the query (stores the result into #AnalysisResult)


5. Import all case attributes to the specified model (#ImportCaseAttributes)
5. Import all case attributes to the current model (#ImportCaseData)
* ProjectName ExampleProject => CHANGE THIS to be the project in which the target model exists.
* ModelName ExampleModel => CHANGE THIS to be the name of the target model.


<pre>
<pre>
(SELECT 'ProjectName', 'ExampleProject') UNION ALL
(SELECT 'ModelName', 'ExampleModel')
--#RemoveEvents
--#RemoveEvents


(SELECT 'AnalysisType', '6') UNION ALL
(SELECT 'AnalysisType', '6') UNION ALL
(SELECT 'MaximumCount', '0') UNION ALL
(SELECT 'MaximumCount', '0') UNION ALL
(SELECT 'FilterId', '1234567') UNION ALL
(SELECT 'ViewId', '1234567') UNION ALL
(SELECT 'SelectedEventAttributes', '*') UNION ALL
(SELECT 'SelectedEventAttributes', '*') UNION ALL
(SELECT 'TargetTable', '#AnalysisResult')
(SELECT 'TargetTable', '#AnalysisResult')
--#GetAnalysis
--#GetAnalysis


(SELECT 'ProjectName', 'ExampleProject') UNION ALL
SELECT * FROM [#AnalysisResult]
(SELECT 'ModelName', 'ExampleModel')
(SELECT * FROM [#AnalysisResult])
--#ImportEvents
--#ImportEvents


(SELECT 'AnalysisType', '5') UNION ALL
(SELECT 'AnalysisType', '5') UNION ALL
(SELECT 'MaximumCount', '0') UNION ALL
(SELECT 'MaximumCount', '0') UNION ALL
(SELECT 'FilterId', '1234567') UNION ALL
(SELECT 'ViewId', '1234567') UNION ALL
(SELECT 'SelectedCaseAttributes', '*') UNION ALL
(SELECT 'SelectedCaseAttributes', '*') UNION ALL
(SELECT 'SelectedActivityCounts', '*') UNION ALL
(SELECT 'SelectedActivityCounts', '*') UNION ALL
Line 758: Line 342:
--#GetAnalysis
--#GetAnalysis


(SELECT 'ProjectName', 'ExampleProject') UNION ALL
SELECT * FROM [#AnalysisResult2]
(SELECT 'ModelName', 'ExampleModel')
--#ImportCaseData
(SELECT * FROM [#AnalysisResult2])
--#ImportCaseAttributes
</pre>
</pre>


=== Example Script: Create a copy of events and switch the ABPD dimension from original EventType to Event Attribute 'Organization' ===
=== Example Load Script: Create a copy of events and switch the ABPD dimension from original EventType to Event Attribute 'Organization' ===
The following script will:<br/>
The following Load Script will:<br/>
1. Clear the current contents of the target model
1. Clear the current contents of the model<br/>
* ProjectName ExampleProject => CHANGE THIS to be the project in which the target model exists.
2. Select all events from another model defined with ViewId = 1234567. (note: change this Id to be an Id from the default Filter (previously called View) of the source model:<br/>
* ModelName ExampleModel => CHANGE THIS to be the name of the target model.
2. Select all events from another model defined with FilterId = 1234567. (note: change this Id to be an Id from the default Filter (previously called View) of the source model:<br/>
* AnalysisType 6 => Event Table
* AnalysisType 6 => Event Table
* MaximumCount 0 => Retrieve all events from the model
* MaximumCount 0 => Retrieve all events from the model
* FilterId 1234567 => CHANGE THIS to be the Filter ID / FilterId of the source model from which you want to make a copy
* ViewId 1234567 => CHANGE THIS to be the Filter ID / ViewId of the source model from which you want to make a copy
* SelectedEventAttributes * => Get all Event Attributes
* SelectedEventAttributes * => Get all Event Attributes
* TargetTable #AnalysisResult => Store the result into a temporary SQL table named #AnalysisResult
* TargetTable #AnalysisResult => Store the result into a temporary SQL table named #AnalysisResult
* #GetAnalysis => Execute the query (stores the result into #AnalysisResult)
* #GetAnalysis => Execute the query (stores the result into #AnalysisResult)


3. Import all events to the specified model (#ImportEvents)
3. Import all events to the current model (#ImportEvents)
* ProjectName ExampleProject => CHANGE THIS to be the project in which the target model exists.
* ModelName ExampleModel => CHANGE THIS to be the name of the target model.
* SELECT [Case], [Organization], [Start Time], * FROM [#AnalysisResult] => Import the event by selecting the column [Organization] as the Event Type. Note: CHANGE this column to the desired dimension for ABPD analysis  
* SELECT [Case], [Organization], [Start Time], * FROM [#AnalysisResult] => Import the event by selecting the column [Organization] as the Event Type. Note: CHANGE this column to the desired dimension for ABPD analysis  


<pre>
<pre>
(SELECT 'ProjectName', 'ExampleProject') UNION ALL
(SELECT 'ModelName', 'ExampleModel')
--#RemoveEvents
--#RemoveEvents


(SELECT 'AnalysisType', '6') UNION ALL
(SELECT 'AnalysisType', '6') UNION ALL
(SELECT 'MaximumCount', '0') UNION ALL
(SELECT 'MaximumCount', '0') UNION ALL
(SELECT 'FilterId', '1234567') UNION ALL
(SELECT 'ViewId', '1234567') UNION ALL
(SELECT 'SelectedEventAttributes', '*') UNION ALL
(SELECT 'SelectedEventAttributes', '*') UNION ALL
(SELECT 'TargetTable', '#AnalysisResult')
(SELECT 'TargetTable', '#AnalysisResult')
--#GetAnalysis
--#GetAnalysis


(SELECT 'ProjectName', 'ExampleProject') UNION ALL
SELECT [Case], [Organization], [Start Time], * FROM [#AnalysisResult]
(SELECT 'ModelName', 'ExampleModel')
(SELECT [Case], [Organization], [Start Time], * FROM [#AnalysisResult])
--#ImportEvents
--#ImportEvents
</pre>
</pre>


=== Example Script: Create a copy of events and combine some event types to a new event type ===
=== Example Load Script: Create a copy of events and combine some event types to a new event type ===
The following script will:<br/>
The following Load Script will:<br/>
1. Clear the current contents of the target model
1. Clear the current contents of the model<br/>
* ProjectName ExampleProject => CHANGE THIS to be the project in which the target model exists.
2. Select all events from another model defined with ViewId = 1234567. (note: change this Id to be an Id from the default Filter (previously called View) of the source model:<br/>
* ModelName ExampleModel => CHANGE THIS to be the name of the target model.
2. Select all events from another model defined with FilterId = 1234567. (note: change this Id to be an Id from the default Filter (previously called View) of the source model:<br/>
* AnalysisType 6 => Event Table
* AnalysisType 6 => Event Table
* MaximumCount 0 => Retrieve all events from the model
* MaximumCount 0 => Retrieve all events from the model
* FilterId 1234567 => CHANGE THIS to be the Filter ID / FilterId of the source model from which you want to make a copy
* ViewId 1234567 => CHANGE THIS to be the Filter ID / ViewId of the source model from which you want to make a copy
* SelectedEventAttributes * => Get all Event Attributes
* SelectedEventAttributes * => Get all Event Attributes
* TargetTable #AnalysisResult => Store the result into a temporary SQL table named #AnalysisResult
* TargetTable #AnalysisResult => Store the result into a temporary SQL table named #AnalysisResult
* #GetAnalysis => Execute the query (stores the result into #AnalysisResult)
* #GetAnalysis => Execute the query (stores the result into #AnalysisResult)


3. Import all events to the specified model (#ImportEvents)
3. Import all events to the current model (#ImportEvents)
* ProjectName ExampleProject => CHANGE THIS to be the project in which the target model exists.
* ModelName ExampleModel => CHANGE THIS to be the name of the target model.
* SELECT [Case], 'COMBINED', [Start Time] FROM [#AnalysisResult] WHERE [Event Type] IN ('Sales Order', 'Shipment')
* SELECT [Case], 'COMBINED', [Start Time] FROM [#AnalysisResult] WHERE [Event Type] IN ('Sales Order', 'Shipment')
=> Select those event type that should be combined and use the new EventType name for them<br/>
=> Select those event type that should be combined and use the new EventType name for them<br/>
Line 824: Line 394:


<pre>
<pre>
(SELECT 'ProjectName', 'ExampleProject') UNION ALL
(SELECT 'ModelName', 'ExampleModel')
--#RemoveEvents
--#RemoveEvents


(SELECT 'AnalysisType', '6') UNION ALL
(SELECT 'AnalysisType', '6') UNION ALL
(SELECT 'MaximumCount', '0') UNION ALL
(SELECT 'MaximumCount', '0') UNION ALL
(SELECT 'FilterId', '1234567') UNION ALL
(SELECT 'ViewId', '1234567') UNION ALL
(SELECT 'SelectedEventAttributes', '*') UNION ALL
(SELECT 'SelectedEventAttributes', '*') UNION ALL
(SELECT 'TargetTable', '#AnalysisResult')
(SELECT 'TargetTable', '#AnalysisResult')
--#GetAnalysis
--#GetAnalysis


(SELECT 'ProjectName', 'ExampleProject') UNION ALL
SELECT [Case], 'COMBINED', [Start Time], * FROM [#AnalysisResult] WHERE [Event Type] IN ('Sales Order', 'Shipment')
(SELECT 'ModelName', 'ExampleModel')
UNION ALL
(SELECT [Case], 'COMBINED', [Start Time], * FROM [#AnalysisResult] WHERE [Event Type] IN ('Sales Order', 'Shipment')) UNION ALL
SELECT [Case], [Event Type], [Start Time], * FROM [#AnalysisResult] WHERE [Event Type] NOT IN ( 'Sales Order', 'Shipment')
(SELECT [Case], [Event Type], [Start Time], * FROM [#AnalysisResult] WHERE [Event Type] NOT IN ( 'Sales Order', 'Shipment'))
--#ImportEvents
--#ImportEvents
</pre>
</pre>


<div id="ConvertExample"></div>
<div id="ConvertExample"></div>
=== Example Script: Create a copy of events and define new event types based on old event types and an event attribute ===
=== Example Load Script: Create a copy of events and define new event types based on old event types and an event attribute ===
The following script will:<br/>
The following Load Script will:<br/>
1. Clear the current contents of the target model
1. Clear the current contents of the model<br/>
* ProjectName ExampleProject => CHANGE THIS to be the project in which the target model exists.
2. Select all events from another model defined with ViewId = 1234567. (note: change this Id to be an Id from the default Filter (previously called View) of the source model:<br/>
* ModelName ExampleModel => CHANGE THIS to be the name of the target model.
2. Select all events from another model defined with FilterId = 1234567. (note: change this Id to be an Id from the default Filter (previously called View) of the source model:<br/>
* AnalysisType 6 => Event Table
* AnalysisType 6 => Event Table
* MaximumCount 0 => Retrieve all events from the model
* MaximumCount 0 => Retrieve all events from the model
* FilterId 1234567 => CHANGE THIS to be the Filter ID / FilterId of the source model from which you want to make a copy
* ViewId 1234567 => CHANGE THIS to be the Filter ID / ViewId of the source model from which you want to make a copy
* SelectedEventAttributes * => Get all Event Attributes
* SelectedEventAttributes * => Get all Event Attributes
* TargetTable #AnalysisResult => Store the result into a temporary SQL table named #AnalysisResult
* TargetTable #AnalysisResult => Store the result into a temporary SQL table named #AnalysisResult
* #GetAnalysis => Execute the query (stores the result into #AnalysisResult)
* #GetAnalysis => Execute the query (stores the result into #AnalysisResult)


3. Import all events to the specified model (#ImportEvents)
3. Import all events to the current model (#ImportEvents)
* ProjectName ExampleProject => CHANGE THIS to be the project in which the target model exists.
* ModelName ExampleModel => CHANGE THIS to be the name of the target model.
* SELECT [Case], convert(varchar(255),[Event Type]) + '_' + convert(varchar(255),[SAP_User]), [Start Time], * FROM [#AnalysisResult]
* SELECT [Case], convert(varchar(255),[Event Type]) + '_' + convert(varchar(255),[SAP_User]), [Start Time], * FROM [#AnalysisResult]
=> Create the new EventType by combining original Event Type, a string '_' and event attribute SAP_User<br/>
=> Create the new EventType by combining original Event Type, a string '_' and event attribute SAP_User<br/>
<pre>
<pre>
(SELECT 'ProjectName', 'ExampleProject') UNION ALL
(SELECT 'ModelName', 'ExampleModel')
--#RemoveEvents
--#RemoveEvents


(SELECT 'AnalysisType', '6') UNION ALL
(SELECT 'AnalysisType', '6') UNION ALL
(SELECT 'MaximumCount', '0') UNION ALL
(SELECT 'MaximumCount', '0') UNION ALL
(SELECT 'FilterId', '1234567') UNION ALL
(SELECT 'ViewId', '1234567') UNION ALL
(SELECT 'SelectedEventAttributes', '*') UNION ALL
(SELECT 'SelectedEventAttributes', '*') UNION ALL
(SELECT 'TargetTable', '#AnalysisResult')
(SELECT 'TargetTable', '#AnalysisResult')
--#GetAnalysis
--#GetAnalysis


(SELECT 'ProjectName', 'ExampleProject') UNION ALL
SELECT [Case], convert(varchar(255),[Event Type]) + '_' + convert(varchar(255),[SAP_User]), [Start Time], * FROM [#AnalysisResult]
(SELECT 'ModelName', 'ExampleModel')
(SELECT [Case], convert(varchar(255),[Event Type]) + '_' + convert(varchar(255),[SAP_User]), [Start Time], * FROM [#AnalysisResult])
--#ImportEvents
--#ImportEvents
</pre>
</pre>


=== Example Script: calculate the amount of events within same case with same timestamp ===
=== Example Load Script: calculate the amount of events within same case with same timestamp ===
The following script will:<br/>
The following Load Script will:<br/>
1.. Select all events from another model defined with FilterId = 1234567. (note: change this Id to be an Id from the default Filter (previously called View) of the source model:<br/>
1.. Select all events from another model defined with ViewId = 1234567. (note: change this Id to be an Id from the default Filter (previously called View) of the source model:<br/>
* AnalysisType 6 => Event Table
* AnalysisType 6 => Event Table
* MaximumCount 0 => Retrieve all events from the model
* MaximumCount 0 => Retrieve all events from the model
* FilterId 1234567 => CHANGE THIS to be the Filter ID / FilterId of the source model from which you want to make a copy
* ViewId 1234567 => CHANGE THIS to be the Filter ID / ViewId of the source model from which you want to make a copy
* SelectedEventAttributes * => Get all Event Attributes
* SelectedEventAttributes * => Get all Event Attributes
* TargetTable #AnalysisResult => Store the result into a temporary SQL table named #AnalysisResult
* TargetTable #AnalysisResult => Store the result into a temporary SQL table named #AnalysisResult
Line 901: Line 460:
(SELECT 'AnalysisType', '6') UNION ALL
(SELECT 'AnalysisType', '6') UNION ALL
(SELECT 'MaximumCount', '0') UNION ALL
(SELECT 'MaximumCount', '0') UNION ALL
(SELECT 'FilterId', '10') UNION ALL
(SELECT 'ViewId', '10') UNION ALL
(SELECT 'SelectedEventAttributes', '*') UNION ALL
(SELECT 'SelectedEventAttributes', '*') UNION ALL
(SELECT 'TargetTable', '#AnalysisResult')
(SELECT 'TargetTable', '#AnalysisResult')
Line 912: Line 471:
</pre>
</pre>


=== Example Script: Create a new model from operation log ===
=== Example Load Script: Create a new model from operation log ===
The following script will read the operation log of QPR ProcessAnalyzer and create process model based on those log entries.
The following Load Script will read the operation log of QPR ProcessAnalyzer and create process model based on those log entries.
Comments:
Comments:
- AnalysisType 12 => Operation Log
- AnalysisType 12 => Operation Log
- MaximumCount 10000 => Retrieve only the 10000 most recent operations
- MaximumCount 10000 => Retrieve only the 10000 most recent operations
- Import all events to the specified model (#ImportEvents)
* ProjectName ExampleProject => CHANGE THIS to be the project in which the target model exists.
* ModelName ExampleModel => CHANGE THIS to be the name of the target model.


<pre>
<pre>
(SELECT 'ProjectName', 'ExampleProject') UNION ALL
(SELECT 'ModelName', 'ExampleModel')
--#RemoveEvents
--#RemoveEvents


Line 931: Line 485:
--#GetAnalysis
--#GetAnalysis


(SELECT 'ProjectName', 'ExampleProject') UNION ALL
(SELECT 'ModelName', 'ExampleModel')
(
(
   SELECT  
   SELECT  
Line 1,009: Line 561:
HAVING
HAVING
   [User Id] <> 0
   [User Id] <> 0
--#ImportCaseAttributes
--#ImportCaseData
</pre>
</pre>


[[Category:ETL]]
[[Category:ETL]]
[[Category:API]]
[[Category:API]]

Revision as of 09:45, 24 October 2013

It is possible to load raw data into QPR ProcessAnalyzer and do the data transformation and loading into QPR ProcessAnalyzer Service via Load Scripts using temporary database tables, so that the resulting transformed data can be used for analyses in QPR ProcessAnalyzer.

A user with the ManageIntegrations and RunScripts permissions can define a Load Script in the Model Properties dialog. The Load Script consists of SQL statements and QPR ProcessAnalyzer commands that take the preceding SQL statements as parameters.

Supported QPR ProcessAnalyzer Commands in Load Scripts

--#Exit

Stops the execution of the script and gives a message to the user.
Parameters
The parameters defined in the SQL SELECT statements:
'Exit', '<Value>'
Defines whether to stop the script execution. 1 = stop execution, 0 = do not stop execution.
'MessageText', '<Text>'
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.
Example
The following example stops the script execution and gives a message.
SELECT ('Exit', '1') UNION ALL
SELECT ('MessageText', 'Data from SAP not valid. Script execution will be terminated. Check source data')
--#Exit


--#GetAnalysis

Creates an analysis from the data which the preceding SQL statements given as parameters provide. The analysis parameters have to be defined in the SQL SELECT statements as follows:
'<Analysis Parameter>', '<Value>'
See Analysis Parameters for a list of supported analysis parameters in QPR ProcessAnalyzer.
The --#GetAnalysis command supports the following analysis types:
Case Analysis (5)
Event Analysis (6)
Event Type Analysis (7) Note: analysis is in table format only.
Variation Analysis (8) Note: analysis is in table format only.
User Report (11)
OperationLog Analysis (12)
Flow Analysis (13)
Influence Analysis (14)
Integration Table Analysis (18)

--#ImportCaseData

Loads Case Attributes from the data which the preceding SQL statements given as parameters provide.

--#ImportDataTable

Imports data to a Data Table.
Parameters
The parameters defined in the SQL SELECT statements in the order they are listed below:
'ProjectId' or 'ProjectName', '<Value>'
The id or the name of the project in which the target data table exists.
'DataTableId' or 'DataTableName', '<Value>'
The id or the name of the existing/new target data table.
'Append', '<Value>'
Defines what to do with an existing target data table contents. TRUE or any other Integer than "0" = the existing contents in the target data table are not deleted before import, FALSE or "0" = the existing contents of the target data table are deleted before the import. Not used when creating a new data table.
''
The database query whose results are to be imported.
Example
The following example will load data from a model and put it into the "AnalysisResult" table and then add that data to the "ExampleTable" data table.
SELECT 'START
--#WriteLog
(SELECT 'AnalysisType', '6') UNION ALL
(SELECT 'MaximumCount', '0') UNION ALL
(SELECT 'ViewId', '3') UNION ALL
(SELECT 'SelectedEventAttributes', '*') UNION ALL
(SELECT 'TargetTable', '#AnalysisResult')
--#GetAnalysis
SELECT 'DataLoaded'
--#WriteLog
SELECT count(*) from [#AnalysisResult]
--#WriteLog
(SELECT 'ProjectId', '1') UNION ALL
(SELECT 'DataTableName', 'ExampleTable') UNION ALL
(SELECT 'Append', '1')
(SELECT * FROM [#AnalysisResult])
--#ImportDataTable

Example
The following example will load data from the "ExampleTable" data table in the "ExampleProject" project, put that data into the "CSV1" table and then show the contents of the "CSV" table. In effect, it shows the contents of the "ExampleTable" data table.
(SELECT 'AnalysisType', '18') UNION ALL
(SELECT 'ProjectName', 'ExampleProject') UNION ALL
(SELECT 'MaximumCount', '0') UNION ALL
(SELECT 'DataTableName', 'ExampleTable') UNION ALL
(SELECT 'TargetTable', '#CSV1')
--#GetAnalysis
(SELECT * FROM #CSV1)
(SELECT 'Title', 'CSV Table') UNION ALL
(SELECT 'MaximumCount', '0')
--#ShowReport


--#ImportEvents

Loads Events from the data which the preceding SQL statements given as parameters provide.

--#ImportSalesforceQuery

Extracts data from Salesforce cloud and imports it into a data table.
Parameters
The parameters defined in the SQL SELECT statements in the order they are listed below:
'ProjectId' or 'ProjectName', '<Value>'
The id or the name of the project in which the target data table exists.
'DataTableId' or 'DataTableName', '<Value>'
The id or the name of the existing/new target data table.
'Append', '<Value>'
Defines what to do with an existing target data table contents. TRUE or any other Integer than "0" = the existing contents in the target data table are not deleted before import, FALSE or "0" = the existing contents of the target data table are deleted before the import. Not used when creating a new data table.
'SalesforceUser', '<Value>'
Username for the Salesforce cloud.
'SalesforcePW', '<Value>'
Password for the Salesforce cloud.
'SalesforceQuery', '<Value>'
The query to be run in the Salesforce cloud. See Salesforce API and SOQL Reference for more information.
'SalesforceQueryRetries', '<Value>'
Number of retries to attempt if the Salesforce query doesn't succeed. Default value is 3.
'SalesforceQueryRetryWait', '<Value>'
Number of milliseconds to wait between query retries. Default is 3000 ms.
'SalesforceBatchSize', '<Value>'
Optional. The number of rows of data the query returns. Minimum = 200, Maximum = 2000, Default = 500. See Salesforce API for more information.
Example
The following example will load name data from the "Contact" table in the Salesforce cloud and will put that data into the "ExampleDataTable" data table in the "ExampleProject" project.
(SELECT 'ProjectName', 'ExampleProject') UNION ALL
(SELECT 'DataTableName', 'ExampleDataTable') UNION ALL
(SELECT 'Append', '0') UNION ALL
(SELECT 'SalesforceUser', 'example.user@somedomain.com') UNION ALL
(SELECT 'SalesforcePW', 'ExamplePassword123') UNION ALL
(SELECT 'SalesforceQuery', 'SELECT FirstName, LastName FROM Contact') UNION ALL
(SELECT 'SalesforceQueryRetries', '3') UNION ALL
(SELECT 'SalesforceQueryRetryWait', '3000') UNION ALL
(SELECT 'SalesforceBatchSize', '200')
--#ImportSalesforceQuery


--#RemoveEvents

Removes all events in the model, but retains Cases, Event Types, and Variations.

--#ShowReport

Creates a new excel sheet containing a table that contains the results of the user specified SQL query. The result column names are the field names of the SQL query and the rows are the actual data rows of the SQL query. The report can be used to see, for example, the events that would be loaded into QPR ProcessAnalyzer before actually loading them. If the events have problems that cause errors when loaded it is useful to be able to see the row data in a report.
Parameters
The parameters defined in the SQL SELECT statements:
''
Mandatory. The database query whose results are to be returned.
'<Analysis Parameter>', '<Value>'
Optional. The Analysis Parameters given for the operation. Some suggested parameters to be used:
'Title', '<Title of the report>'
Name of the created report (used as sheet name in QPR ProcessAnalyzer Excel Client). Any existing sheet with the same title will be overwritten, so a script containing multiple ShowReport commands should use a unique title for each of the ShowReport commands. If not given, "Report" will be used as a default.
'MaximumCount', '<Value>'
The maximum number of rows to show (0 = all, default = 1000).
Example
The following example opens the data table identified by data table name "SqlTable" and project name "Test" as a report.
(SELECT 'AnalysisType', '18') UNION ALL
(SELECT 'ProjectName', 'Test') UNION ALL
(SELECT 'DataTableName', 'SqlTable') UNION ALL
(SELECT 'TargetTable', '#AnalysisResult')
--#GetAnalysis
SELECT * FROM #AnalysisResult;
(SELECT 'Title', 'Report1') UNION ALL
(SELECT 'MaximumCount', '0')
--#ShowReport


--#WriteLog

Adds the first column values from the preceding SQL statements to the log that is shown after the whole script execution is completed.
In addition to the WriteLog command, you can also use the Print SQL statement to generate log entries into the script execution log. The difference to the WriteLog command is that the Print statement can use also variables.
Example
The following example will write "Script started", "Example", "Print Example" into the log.
SELECT 'Script started'
SELECT 'Example'
--#WriteLog
PRINT 'Print Example'


SQL Command Support

When transforming data in QPR ProcessAnalyzer Pro (i.e. when connected to the QPR ProcessAnalyzer Service), only temporary tables (#) should be used. Note that global temporary tables (##) should never be used in the SQL scripts, and using them is not allowed. When using QPR ProcessAnalyzer Xpress, these limitations do not apply.

Print

The Print SQL statement can be used to generate log entries into the script execution log.

Running Load Scripts

A load script can be run in two ways:

Running a Load Script from the Model Properties Dialog

  1. On the QPR ProcessAnalyzer tab of the ribbon, click Project Workspace.
  2. From the model list, select the desired model that contains a load script.
  3. Click Properties.
  4. Click Run Script.

Running a Load Script by Importing a .pasql File

  1. Write the load script into a file that has a .pasql file format.
  2. On the QPR ProcessAnalyzer tab of the ribbon, click Project Workspace.
  3. Click Import.
  4. Select QPR ProcessAnalyzer File and click Next.
  5. Click Select and choose QPR ProcessAnalyzer SQL Script File (*.pasql) from the file type menu.
  6. Browse to the .pasql file containing the load script, select it, and click Open.
  7. Click Next.
  8. Select the import target:
    • Create New will create a new model and set it as the target of the load script.
    • Add to Existing will set the target of the load script to the selected model.
    Either way, the script in the .pasql file will be set as the Load Script of the target model.
  9. Click Import.

Terminating Load Scripts

A Load Script can be terminated by the following ways:

  • The user running the script can click the Cancel button when the script is running.
  • The script can use the "--#Exit" command stop script execution.
  • A QPR ProcessAnalyzer Administrator user can terminate the script via the Operations Log.
  • The SQL Server System Administrator can kill the session using the script by using e.g. SQL Server Management Studio.
  • The Internet Information Services Administrator can recycle the application pool if the Load Script has caused it to hang. Note however, that this may also cause other requests by other users being processed at the same time to be aborted.
  • The Windows Administrator can kill the w3wp.exe-process processing a problematic script. Note however, that this may also cause other requests by other users being processed at the same time to be aborted.

NOTE!
Terminating the Load Script will not revert any changes the script has already done in the database before the Cancel button is clicked.

Things to Note About Load Scripts

When writing and using Load Scripts, take the following things into account:

  • Only those lines in the script that start with "--#" (without the quotes) are treated as QPR ProcessAnalyzer Commands, i.e. if there are leading whitespaces before the command, the line is treated as a comment.
  • If you don't define a value for the MaximumCount parameter, 1000 will be used as default, i.e. only the 1000 first rows from a given table or model will be used.
  • When doing more advanced operations with Load scripts, you may run into the error messages such as: "The data types sql_variant and varchar are incompatible in the add operation.", "Argument data type sql_variant is invalid for argument 1 of like function.", "Argument data type sql_variant is invalid for argument 1 of left function.". This is because case attributes, event attributes, and data inside data tables are sql_variant type data. In order to use them with more advanced operations (e.g. Add), you need to CONVERT or CAST them into some other data type before the operations. See this example.

Example Load Scripts

Example Load Script: Create a copy of existing model

The following Load Script will:
1. Clear the current contents of the model
2. Select all events from another model defined with ViewId = 1234567. (note: change this Id to be an Id from the default Filter (previously called View) of the source model:

  • AnalysisType 6 => Event Table
  • MaximumCount 0 => Retrieve all events from the model
  • ViewId 1234567 => CHANGE THIS to be the Filter ID / ViewId of the source model from which you want to make a copy
  • SelectedEventAttributes * => Get all Event Attributes
  • TargetTable #AnalysisResult => Store the result into a temporary SQL table named #AnalysisResult
  • #GetAnalysis => Execute the query (stores the result into #AnalysisResult)

3. Import all events to the current model (#ImportEvents)

4. Select all case attributes from the source model (defined with ViewId = 1234567)

  • AnalysisType 5 => Case Table
  • MaximumCount 0 => Retrieve all cases from the model
  • ViewId 1234567 => CHANGE THIS to be the Filter ID / ViewId of the source model from which you want to copy case attributes
  • SelectedCaseAttributes * => Get all Case Attributes
  • TargetTable #AnalysisResult2 => Store the result into a new temporary SQL table named #AnalysisResult2
  • #GetAnalysis => Execute the query (stores the result into #AnalysisResult)

5. Import all case attributes to the current model (#ImportCaseData)

--#RemoveEvents

(SELECT 'AnalysisType', '6') UNION ALL
(SELECT 'MaximumCount', '0') UNION ALL
(SELECT 'ViewId', '1234567') UNION ALL
(SELECT 'SelectedEventAttributes', '*') UNION ALL
(SELECT 'TargetTable', '#AnalysisResult')
--#GetAnalysis

SELECT * FROM [#AnalysisResult]
--#ImportEvents

(SELECT 'AnalysisType', '5') UNION ALL
(SELECT 'MaximumCount', '0') UNION ALL
(SELECT 'ViewId', '1234567') UNION ALL
(SELECT 'SelectedCaseAttributes', '*') UNION ALL
(SELECT 'TargetTable', '#AnalysisResult2')
--#GetAnalysis

SELECT * FROM [#AnalysisResult2]
--#ImportCaseData

Example Load Script: Create an extended copy of existing model with new case attributes

This scripts extends the simple model copying script by creating new case attributes from Case Table report
1. Clear the current contents of the model
2. Select all events from another model defined with ViewId = 1234567. (note: change this Id to be an Id from the default Filter (previously called View) of the source model:

  • AnalysisType 6 => Event Table
  • MaximumCount 0 => Retrieve all events from the model
  • ViewId 1234567 => CHANGE THIS to be the Filter ID / ViewId of the source model from which you want to make a copy
  • SelectedEventAttributes * => Get all Event Attributes
  • TargetTable #AnalysisResult => Store the result into a temporary SQL table named #AnalysisResult
  • #GetAnalysis => Execute the query (stores the result into #AnalysisResult)

3. Import all events to the current model (#ImportEvents)

4. Select all case attributes from the source model (defined with ViewId = 1234567)

  • AnalysisType 5 => Case Table
  • MaximumCount 0 => Retrieve all cases from the model
  • ViewId 1234567 => CHANGE THIS to be the Filter ID / ViewId of the source model from which you want to copy case attributes
  • SelectedCaseAttributes * => Get all Case Attributes
  • SelectedActivityCounts * => Get the counts for all EventTypes
  • SelectedEventAttributes * => Get the values for all EventAttributes consolidated to Case level
  • ShowDurations 255 => Retrieve all duration columns
  • ShowStarts 7 => Retrieve all Starts columns
  • ShowEnds 7 => Retrieve all Starts columns
  • ShowVariationIds => Retrive the Variation ID for each case
  • ShowVariationPaths => Retrieve the ordered list of Event Type Strings for each case
  • TargetTable #AnalysisResult2 => Store the result into a new temporary SQL table named #AnalysisResult2
  • #GetAnalysis => Execute the query (stores the result into #AnalysisResult)

5. Import all case attributes to the current model (#ImportCaseData)

--#RemoveEvents

(SELECT 'AnalysisType', '6') UNION ALL
(SELECT 'MaximumCount', '0') UNION ALL
(SELECT 'ViewId', '1234567') UNION ALL
(SELECT 'SelectedEventAttributes', '*') UNION ALL
(SELECT 'TargetTable', '#AnalysisResult')
--#GetAnalysis

SELECT * FROM [#AnalysisResult]
--#ImportEvents

(SELECT 'AnalysisType', '5') UNION ALL
(SELECT 'MaximumCount', '0') UNION ALL
(SELECT 'ViewId', '1234567') UNION ALL
(SELECT 'SelectedCaseAttributes', '*') UNION ALL
(SELECT 'SelectedActivityCounts', '*') UNION ALL
(SELECT 'SelectedEventAttributes', '*') UNION ALL
(SELECT 'ShowDurations', '255') UNION ALL
(SELECT 'ShowStarts', '7') UNION ALL
(SELECT 'ShowEnds', '7') UNION ALL
(SELECT 'ShowVariationIds', 'True') UNION ALL
(SELECT 'ShowVariationPaths', 'True') UNION ALL
(SELECT 'TargetTable', '#AnalysisResult2')
--#GetAnalysis

SELECT * FROM [#AnalysisResult2]
--#ImportCaseData

Example Load Script: Create a copy of events and switch the ABPD dimension from original EventType to Event Attribute 'Organization'

The following Load Script will:
1. Clear the current contents of the model
2. Select all events from another model defined with ViewId = 1234567. (note: change this Id to be an Id from the default Filter (previously called View) of the source model:

  • AnalysisType 6 => Event Table
  • MaximumCount 0 => Retrieve all events from the model
  • ViewId 1234567 => CHANGE THIS to be the Filter ID / ViewId of the source model from which you want to make a copy
  • SelectedEventAttributes * => Get all Event Attributes
  • TargetTable #AnalysisResult => Store the result into a temporary SQL table named #AnalysisResult
  • #GetAnalysis => Execute the query (stores the result into #AnalysisResult)

3. Import all events to the current model (#ImportEvents)

  • SELECT [Case], [Organization], [Start Time], * FROM [#AnalysisResult] => Import the event by selecting the column [Organization] as the Event Type. Note: CHANGE this column to the desired dimension for ABPD analysis
--#RemoveEvents

(SELECT 'AnalysisType', '6') UNION ALL
(SELECT 'MaximumCount', '0') UNION ALL
(SELECT 'ViewId', '1234567') UNION ALL
(SELECT 'SelectedEventAttributes', '*') UNION ALL
(SELECT 'TargetTable', '#AnalysisResult')
--#GetAnalysis

SELECT [Case], [Organization], [Start Time], * FROM [#AnalysisResult]
--#ImportEvents

Example Load Script: Create a copy of events and combine some event types to a new event type

The following Load Script will:
1. Clear the current contents of the model
2. Select all events from another model defined with ViewId = 1234567. (note: change this Id to be an Id from the default Filter (previously called View) of the source model:

  • AnalysisType 6 => Event Table
  • MaximumCount 0 => Retrieve all events from the model
  • ViewId 1234567 => CHANGE THIS to be the Filter ID / ViewId of the source model from which you want to make a copy
  • SelectedEventAttributes * => Get all Event Attributes
  • TargetTable #AnalysisResult => Store the result into a temporary SQL table named #AnalysisResult
  • #GetAnalysis => Execute the query (stores the result into #AnalysisResult)

3. Import all events to the current model (#ImportEvents)

  • SELECT [Case], 'COMBINED', [Start Time] FROM [#AnalysisResult] WHERE [Event Type] IN ('Sales Order', 'Shipment')

=> Select those event type that should be combined and use the new EventType name for them
=> This example replaces 'Sales Order' and 'Shipment' with new EventType name 'COMBINED'

  • UNION ALL => Use this statement to build the events from several sub queries
  • SELECT [Case], [Event Type], [Start Time] FROM [#AnalysisResult] WHERE [Event Type] NOT IN ( 'Sales Order', 'Shipment')

=> Select all other Event Types and include them as they are, ie. no change to these events

--#RemoveEvents

(SELECT 'AnalysisType', '6') UNION ALL
(SELECT 'MaximumCount', '0') UNION ALL
(SELECT 'ViewId', '1234567') UNION ALL
(SELECT 'SelectedEventAttributes', '*') UNION ALL
(SELECT 'TargetTable', '#AnalysisResult')
--#GetAnalysis

SELECT [Case], 'COMBINED', [Start Time], * FROM [#AnalysisResult] WHERE [Event Type] IN ('Sales Order', 'Shipment')
UNION ALL
SELECT [Case], [Event Type], [Start Time], * FROM [#AnalysisResult] WHERE [Event Type] NOT IN ( 'Sales Order', 'Shipment')
--#ImportEvents

Example Load Script: Create a copy of events and define new event types based on old event types and an event attribute

The following Load Script will:
1. Clear the current contents of the model
2. Select all events from another model defined with ViewId = 1234567. (note: change this Id to be an Id from the default Filter (previously called View) of the source model:

  • AnalysisType 6 => Event Table
  • MaximumCount 0 => Retrieve all events from the model
  • ViewId 1234567 => CHANGE THIS to be the Filter ID / ViewId of the source model from which you want to make a copy
  • SelectedEventAttributes * => Get all Event Attributes
  • TargetTable #AnalysisResult => Store the result into a temporary SQL table named #AnalysisResult
  • #GetAnalysis => Execute the query (stores the result into #AnalysisResult)

3. Import all events to the current model (#ImportEvents)

  • SELECT [Case], convert(varchar(255),[Event Type]) + '_' + convert(varchar(255),[SAP_User]), [Start Time], * FROM [#AnalysisResult]

=> Create the new EventType by combining original Event Type, a string '_' and event attribute SAP_User

--#RemoveEvents

(SELECT 'AnalysisType', '6') UNION ALL
(SELECT 'MaximumCount', '0') UNION ALL
(SELECT 'ViewId', '1234567') UNION ALL
(SELECT 'SelectedEventAttributes', '*') UNION ALL
(SELECT 'TargetTable', '#AnalysisResult')
--#GetAnalysis

SELECT [Case], convert(varchar(255),[Event Type]) + '_' + convert(varchar(255),[SAP_User]), [Start Time], * FROM [#AnalysisResult]
--#ImportEvents

Example Load Script: calculate the amount of events within same case with same timestamp

The following Load Script will:
1.. Select all events from another model defined with ViewId = 1234567. (note: change this Id to be an Id from the default Filter (previously called View) of the source model:

  • AnalysisType 6 => Event Table
  • MaximumCount 0 => Retrieve all events from the model
  • ViewId 1234567 => CHANGE THIS to be the Filter ID / ViewId of the source model from which you want to make a copy
  • SelectedEventAttributes * => Get all Event Attributes
  • TargetTable #AnalysisResult => Store the result into a temporary SQL table named #AnalysisResult
  • #GetAnalysis => Execute the query (stores the result into #AnalysisResult)

2. Calculate the amount of events within same case with same timestamp SELECT count(*) FROM [#AnalysisResult] AS AR1, [#AnalysisResult] AS AR2 => Return the count(*) as the result of the query WHERE AR1.[Case] = AR2.[Case] AND AR1.[Event Type] <> AR2.[Event Type] AND AR1.[Start Time] = AR2.[Start Time] => Case & Start Time are same in both events, Event Type is different --#WriteLog => show the result to user


(SELECT 'AnalysisType', '6') UNION ALL
(SELECT 'MaximumCount', '0') UNION ALL
(SELECT 'ViewId', '10') UNION ALL
(SELECT 'SelectedEventAttributes', '*') UNION ALL
(SELECT 'TargetTable', '#AnalysisResult')
--#GetAnalysis

SELECT count(*) FROM [#AnalysisResult] AS AR1, [#AnalysisResult] AS AR2 
WHERE AR1.[Case] = AR2.[Case] AND AR1.[Event Type] <> AR2.[Event Type] AND AR1.[Start Time] = AR2.[Start Time]
--#WriteLog

Example Load Script: Create a new model from operation log

The following Load Script will read the operation log of QPR ProcessAnalyzer and create process model based on those log entries. Comments: - AnalysisType 12 => Operation Log - MaximumCount 10000 => Retrieve only the 10000 most recent operations

--#RemoveEvents

(SELECT 'AnalysisType', '12') UNION ALL
(SELECT 'MaximumCount', '10000') UNION ALL
(SELECT 'TargetTable', '#AnalysisResult')
--#GetAnalysis

(
  SELECT 
    [Session Id], 'InitializeConnection', DATEADD(ms, 3, [Start Time]), [Model Id], [Model Name],
    (CASE WHEN ([Message] LIKE 'Exception of type:%') THEN
	  'Exception'
	ELSE
	  NULL
	END) AS [Error], 
	[Message], [Additional Data]
  FROM 
    #AnalysisResult
  WHERE
    [Name] IN (
	  'SqlCore.InitializeConnection'
	)
)
UNION ALL
(
  SELECT 
    [Session Id], 'InitializeSessionManager', [Start Time], [Model Id], [Model Name],
    (CASE WHEN ([Message] LIKE 'Exception of type:%') THEN
	  'Exception'
	ELSE
	  NULL
	END) AS [Error], 
	[Message], [Additional Data]
  FROM 
    #AnalysisResult
  WHERE
    [Name] IN (
	  'SingletonSessionManager.InitializeSessionManager'
	)
)
UNION ALL
(
  SELECT 
    [Session Id], 'Start:' + [Name], [Start Time], [Model Id], [Model Name], NULL AS [Error], NULL AS [Message], [Additional Data]
  FROM 
    #AnalysisResult
  WHERE
    [Name] NOT IN (
	  'SingletonSessionManager.InitializeSessionManager',
	  'SqlCore.InitializeConnection',
	  'SqlCore.Dispose'
	)
)
UNION ALL
(
  SELECT 
    [Session Id], 'End:' + [Name], DATEADD(ms, 3, [End Time]), [Model Id], [Model Name],
    (CASE WHEN ([Message] LIKE 'Exception of type%') THEN
	  'Exception'
	ELSE
	  NULL
	END) AS [Error], 
	[Message], NULL AS [Additional Data]
  FROM 
    #AnalysisResult
  WHERE
    [End Time] IS NOT NULL
    AND [Name] NOT IN (
	  'SingletonSessionManager.InitializeSessionManager',
	  'SqlCore.InitializeConnection',
	  'SqlCore.Dispose'
	)
)
--#ImportEvents

SELECT 
  [Session Id], [User Id], [User Name]
FROM 
  #AnalysisResult
GROUP BY
  [Session Id], [User Id], [User Name]
HAVING
  [User Id] <> 0
--#ImportCaseData