Difference between revisions of "QPR ProcessAnalyzer Analysis Parameters"

From QPR ProcessAnalyzer Wiki
Jump to: navigation, search
 
Line 29: Line 29:
 
:: 24 = Script Report
 
:: 24 = Script Report
 
:: 25 = Run Script. Using this analysis type will forward the used parameters to the RunScript function. The analysis result will then be what the RunScript function returns as a result.
 
:: 25 = Run Script. Using this analysis type will forward the used parameters to the RunScript function. The analysis result will then be what the RunScript function returns as a result.
:: 26 = Event Type Analysis in the Trends mode
 
:: 27 = Influence Analysis - Process Path
 
:: 28 = Profiling Analysis in the Trends mode
 
 
:: 29 = Duration Influence Analysis
 
:: 29 = Duration Influence Analysis
 
:: 30 = Filter Report. If ModelId is defined, returns the filters of the model specified by the id. Otherwise returns all filters available for the user. The result is a table that contains the following columns:
 
:: 30 = Filter Report. If ModelId is defined, returns the filters of the model specified by the id. Otherwise returns all filters available for the user. The result is a table that contains the following columns:

Latest revision as of 07:19, 16 August 2019

QPR ProcessAnalyzer supports the analysis parameters listed below:

AbsolutePath
AcceptIfAnyMatches
AddGroups
AdditionalData
AddRelationToIdeaId
AddRoles
AddToExistingFilters
AnalysisType
A number representing the type of the analysis:
0 = Flowchart Analysis
1 = Variation Analysis in the Chart mode
3 = Path Analysis
4 = Event Type Analysis in the Chart mode
5 = Case Analysis
6 = Event Analysis
7 = Event Type Analysis in the Table mode
8 = Variation Analysis in the Table mode
9 = Duration Analysis
10 = Profiling Analysis
11 = User Right Report
12 = Operation Log
13 = Flow Analysis
14 = Influence Analysis - Case Attributes
18 = Data Table Analysis
21 = Model Report
22 = Project Report
23 = Data Table Report
24 = Script Report
25 = Run Script. Using this analysis type will forward the used parameters to the RunScript function. The analysis result will then be what the RunScript function returns as a result.
29 = Duration Influence Analysis
30 = Filter Report. If ModelId is defined, returns the filters of the model specified by the id. Otherwise returns all filters available for the user. The result is a table that contains the following columns:
Name: Name of the filter.
Id: Id of the filter.
ModelId: id of the model that filter belongs to.
ModelName: name of the model that filter belongs to.
Publish Mode: publish mode of the filter.
Case Sample Size: case sample size of the filter.
Created On: Time stamp when the filter was created.
Created By: User who created the filter or empty if the user doesn't have permission to see the user.
Bookmarks: Number of bookmarks created for the filter.
Filter Rules: Number of filter rules in the filter.
Opens: Number of times any analysis was done for the filter.
Last Modified On: Time stamp when the filter was last modified.
Last Modified By: User who last modified the filter or empty if the user doesn't have permission to see the user.
31 = Filter Rule Report. If ModelId is defined, returns the filter rules of the model specified by the id. Otherwise returns all filter rules of all filters available for the user. If FilterId is defined, returns the filter rules of the filter specified by the id. Otherwise returns all filter rules of all filters available for the user. If IncludeFullParameters is true, the result will contain the two additional columns ParametersFull and ParametersIdFull. The result is a table that contains the following columns:
Filter Id: id of the filter that filter rule belongs to.
Filter Rule Id: id of the filter rule.
Type: filter rule type.
Order: order of the filter rule.
Parameters: truncated filter rule parameters in a "pretty" format (ids converted to names).
ParametersFull: all filter rule parameters in a "pretty" format (ids converted to names) (Included only if IncludeFullParameters = True).
ParametersIdFull: all filter rule parameters in un "ugly" format (ids not converted to names) (Included only if IncludeFullParameters = True).
Depth: hierarchy depth of the filter rule.
Parent Filter Rule Id: id of the parent filter rule.
Analysis: string showing the analysis type from which that filter rule was created.
Created On: Time stamp when that filter rule was created.
Created By: User who created the filter rule or empty if the user doesn't have permission to see the user.
Original Filter Id: id of the original filter (filter for which that filter rule was originally created).
Original Filter: name of the original filter.
Original Filter Description: description of the original filter.
32 = Script Log Report. Available for users with Administrator rights. Contains information from the Script Logs. The result is a table that has the following columns:
Id: Id of the log entry
Script Id: Script id
Type: Log entry type
Start Time: Start time of the operation
End Time: End time of the operation
User Id: Id of the user who did the script operation
User Name: Name of the user who did the script operation
Result: Result of the operation, null/empty if the operation succeeded, exception text otherwise
Log: operation log
Additional data: additional parameters related to the log event
33 = KPI Expression Analysis
FilterId: Filter Id to use
Configuration: KPI Expression Analysis configuration as JSON
BenchmarkCaseAttributeTypeName
BenchmarkCaseAttributeValue
BenchmarkEndEventAttributeTypeName
BenchmarkEndEventAttributeValue
BenchmarkEventAttributeTypeName
BenchmarkEventAttributeValue
BenchmarkSettings
Canceled
CaseAttributeMaximumCount
CombinePaths
ComparisonBenchmark
Defines if the flowchart benchmarking is done in the Comparison Mode. Default value is TRUE when running from a script.
Compress
ConfidencePercentage
CostType
A number representing the Cost Settings:
0 = Total
1 = Average
CreateChildModel
CSVDelimiter
CSVHeaderIncluded
CSVQualifier
CSVStartImportFromLine
CSVTimeFormat
DatabaseId
DataTableId
The unique id of a user-created Data Table in the QPR ProcessAnalyzer Service.
DataTableName
The name of a user-created Data Table.
The ProjectName + DataTableName combination can be used to identify a Data Table in the QPR ProcessAnalyzer Service.
DeletedModelsOnly
For the Model Report analysis, when this parameter and the "IncludeDeletedProjects" parameter are set to True, the analysis contains information about deleted models available for the user (including models in the recycle bin).
DeleteFromDatabase
Direction
A number defining the direction of the Path Analysis:
0 = Predecessors
1 = Successors
DontShowAttributes
DrilldownSelection
Duration
DurationType
A number representing the duration calculation method in Flowchart Analysis:
0 = Median
1 = Average
See also IncludeDurations.
DurationWeightedByCost
A boolean value controlling whether or not the duration calculation will be weighted using the costs of the event type or flow as the weight.
EnableMinimumFlowVolume
ExcludeAttributesInRelatedModels
ExpandedPaths
FileName
FileType
FilterId
Uses the filter identified by the filter ID given as parameter.
FilterName
The ModelId + FilterName combination uses the filter identified by filter's name in the model identified by the ModelId parameter value.
The ProjectName + ModelName + FilterName combination uses the filter identified by filter's name in the model identified by model name. The model is located in the project identified by project name.
FlowchartDetails
FormatValuesAsText
GetAll
This parameter can be used, for example, in the Script Report analysis type. If the parameter is set to True, the analysis contains information about all the scripts available for the user, including the deleted scripts.
GlobalRoles
Granularity
A number defining how durations are grouped in the Duration Analysis:
1 = Second
60 = Minute
3600 = Hour
86400 = Day
604800 = Week
2629800 = Month
7889400 = Quarter
31557600 = Year
GroupBy
GroupsOnly
HopIndex
IncludeDeletedProjects
This parameter can be used, for example, in the analysis types Model Report, Project Report and Data Table Report. If the parameter is set to True, the analysis contains information about all the models/projects/data tables available for the user including the deleted ones. For Model Report, the parameter "DeletedModelsOnly" also needs to be set to True to show the deleted models (including models in the recycle bin).
IncludeDurations
A boolean value controlling whether or not to display the time it took to move from one event to another. See also DurationType.
IncludeEventIds
This parameter is used in Event Analysis (AnalysisType = 6). If the parameter is set to True, Event ID is shown in the second column in Event Analysis.
IncludeFilterRules
IncludeFullParameters
Used with Filter Rule Report analysis. A boolean value controlling whether the ParametersFull of ParametersIdFull columns are included in the Filter Rule Report analysis results.
IncludeGroupsForUsers
IncludeHiddenReports
IncludeLayout
IncludeNonDeletedProjects
IncludePrettyExpressionParameters
IncludeRoles
IncludeStatistics
IncludeTotals
InlineBenchmarkAttributes
LocalRoles
LogOnName
MaxChildNodeCount
The number of maximum child nodes for the Root Event Type in Path Analysis.
MaximumCount
Defines the maximum number of rows used in the analysis. If 0, all rows will be used. If not defined, 1000 is used as default.
MaximumDuration
A number defining the Duration Limit in Duration Analysis.
MaxStartTime
Used with Script Log Report and Operation Log Analysis analysis types. A date time parameter which specifies the latest start time in the log entries. Format is ISO8601: yyyy-mm-ddThh:mm:ss.fff. The maximum year is 2030 and the minimum year is 1970. 'fff' stands for fractions of seconds and it is given in 3ms accuracy and the last digit must be 0, 3 or 7. Optional. Default value is no latest start time limit.
MaxTextLength
Used with Operation Log Analysis analysis type. Integer. The maximum number of characters to return from the 'Name', 'Session Id', 'User Name', 'Model Name', 'Message', and 'Additional Data' fields. If 0 (default), all characters are returned.
Messages
MinTransitionUsagePercentage
Defines the minimum volume of flows from the total amount of flows. Only those flows and event types with the minimum volume or greater will be drawn on the flow chart. For example, a "0" value will result in all flows and event types to be drawn on the flow chart. Controlled by the 'Minimum Flow Volume' setting in Flowchart Analysis.
MinStartTime
Used with the Script Log Report and Operation Log Analysis analysis types. A date time parameter which specifies the earliest start time in the log entries. Format is ISO8601: yyyy-mm-ddThh:mm:ss.fff. The maximum year is 2030 and the minimum year is 1970. 'fff' stands for fractions of seconds and it is given in 3ms accuracy and the last digit must be 0, 3 or 7.
  • For Script Log Report analysis type: Mandatory if ScriptIds parameter is not defined.
  • For Operation Log Analysis analysis type: Optional. Default value is no earliest start time limit.
ModelId
Uses the default filter of the model identified by the parameter value.
The ModelId + FilterName combination uses the filter identified by filter's name in the model identified by the ModelId parameter value.
ModelIdUsed
ModelName
Uses the default filter of the model that exists in the same project as the model for which the script is being run.
The ProjectName + ModelName + FilterName combination uses the filter identified by filter's name in the model identified by model name. The model is located in the project identified by project name.
ModelObjectsOnly
NonDeletedModelsOnly
NumberOfSubsets
The number of subsets used in Influence Analysis.
ObjectType
ObjectTypeMask
OnlyUsersOfModel
OnlyUsersOfProject
OperationName
Overwrite
PathType
A number defining the path type in Path Analysis:
0 = First Occurrence Only
1 = All Occurrences
PivotSheetName
Defining a value to this parameter in the A1 comments cell and rerunning the analysis will create a new sheet containing a pivot table based on the analysis data.
ProcessAnalysisType
ProcessingLog
ProjectId
ProjectName
The ProjectName + ModelName + FilterName combination uses the filter identified by filter's name in the model identified by model name. The model is located in the project identified by project name.
The ProjectName + DataTableName combination can be used to identify a Data Table in the QPR ProcessAnalyzer Service.
PublicReportsOnly
PublicViewsOnly
QueryFeeds
Recurse
RemoveGroups
RemoveRoles
ReportId
Refers to bookmark parameters. If the bookmark is not bound to any filter, the default filter of the model where the bookmark is stored, is used.
RootEventType
Id of the Root Event Type in Path Analysis.
RunLoadScript
SaveAsReport
SelectedActivityCounts
SelectedAttributeType
Id of the case or event attribute for which the Profiling Analysis Trend table is created.
SelectedCaseAttributes
Either "*" (all) or the id of the case attribute. For example:
(SELECT 'SelectedCaseAttributes', '*') UNION ALL This will select all case attributes.
(SELECT 'SelectedCaseAttributes', '552211') UNION ALL This will select the "Account Manager" case attribute for which the id in the database is "552211".
SelectedCaseAttributeValues
The values of the case attributes in the format: [id],[value1],[value2],[valueX]
These values need to be in escaped format, see Escaping for Attribute Values for more information.
For example:
(SELECT 'SelectedCaseAttributeValues ', '552207,value1,value2') This will select two case attribute values for which the id in the database is "552207".
(SELECT 'SelectedCaseAttributeValues ', '552207,value\,with comma') This will select one case attribute value for which the id in the database is "552207".
SelectedEndEventAttributeValues
The values of the end event attributes in the format: [id],[value1],[value2],[valueX]
These values need to be in escaped format, see Escaping for Attribute Values for more information.
SelectedEventAttributes
Either "*" (all) or the id of the event attribute. For example:
(SELECT 'SelectedEventAttributes', '*') UNION ALL This will select all event attributes.
(SELECT 'SelectedCaseAttributes', '552207') UNION ALL This will select the "SAP_User" event attribute for which the id in the database is "552207".
SelectedEventAttributeValues
The values of the event attributes in the format: [id],[value1],[value2],[valueX]
These values need to be in escaped format, see Escaping for Attribute Values for more information.
SheetName
ShowAmountForEventType
A boolean value controlling whether or not to display how many cases (including percentage of total cases) goes through a particular event in Flowchart Analysis.
ShowAmountForFlow
A boolean value controlling whether or not to display how many cases (including percentage of total cases) goes through a particular flow in Flowchart Analysis.
ShowCostForEventType
A boolean value controlling whether or not to display the cost for Event Types in Flowchart Analysis.
ShowCostForFlow
A boolean value controlling whether or not to display the cost for Flows in Flowchart Analysis.
ShowDurations
ShowEnds
A sum value controlling whether to show the EndWeekday = 1, EndMonth = 2, and EndYear = 4 in Case Analysis. For example, if you want to show the EndMonth and EndYear, use 6.
ShownAttributeMaximumRowCount
The maximum number of attribute values to show in Event Types in Flowchart Analysis.
ShownCaseAttributes
ShownEventAttributes
ShowOpenOnly
ShowOthersGroup
A boolean value defining whether or not to group and display all the values that are left out when MaximumCount is used.
ShowPermissions
ShowRelativeStart
ShowStarts
A sum value controlling whether to show the StartWeekday = 1, StartMonth = 2, and StartYear = 4 in Case Analysis. For example, if you want to show the StartMonth and StartYear, use 6.
ShowUserDetails
ShowUserModels
ShowVariations
SQLConnectionString
SQLStatement
TargetModelId
TargetTable
TestData
TestType
Title
Used with the ShowReport script command. 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.
TransitionType
A number representing the selected Transition Type:
0 = Unique Only
1 = All Occurrences
TreeExpansionDepth
A number defining the maximum number of events shown in the child nodes in Path Analysis.
TrendCaseTimeStampType
Used with Profiling Analysis Trends. Selects which time stamp is used to place the occurrences to the selected Period Level:
CaseStartTime = the time stamp of the first event of a case in the current filter.
CaseEndTime = the time stamp of the last event of a case in the current filter.
FirstEventTypeOccurrence = the time stamp of the first occurrence of the selected event type within a case.
CaseCustomAttributeValue = the time stamp of the value of the case attribute specified by 'TrendSelectedTimeStampAttribute' (see below) parameter converted to a datetime using the CONVERT SQL function with the 'yyyy-mm-dd hh:mi:ss.mmm' format, for example: convert(datetime, '2015-12-31', 21). Therefore, if the case attribute has numeric values or a different datetime format, it may result in weird dates being displayed on the analysis result columns.
TrendSelectedTimeStampAttribute
Used when TrendCaseTimeStampType=CaseCustomAttributeValue. Specifies the case attribute the value of which is converted to a datetime.
TrendSelectedTimeStampEventType
Used when TrendCaseTimeStampType=FirstEventTypeOccurrence. Specifies the event type for getting the time stamp of the first occurrence.
UsersOnly
UsersRelatedToModel
Values
VisibleReportsOnly
VisibleViewsOnly

Viewing Analysis Parameter in QPR ProcessAnalyzer Excel Client

For information about analysis results and parameter values can be seen in QPR ProcessAnalyzer Excel client analyses by hovering the mouse pointer over the A1 cell of each analysis. AnalysisParameters.png

The following information is shown in the A1 cell:

  • Analysis name
  • Processing time (total): The total analysis processing time in seconds including Excel client processing.
  • Processing time (core): The analysis query processing time in seconds.
  • Created: analysis creation time
  • User: User name and Id
  • Project: project name and Id (Shown when analysis is performed on model data or analysis is DataTable analysis.)
  • Model: Model name and Id (Shown when analysis is performed on model data.)
  • Model created: model creation time (Shown when analysis is performed on model data.)
  • Model/Cache object counts (Shown when analysis is performed on model data.)
  • Cases: <number of cases in model> Total, <number of filtered cases> After Filter Rules, <number of cases after sampling> Sampled, <number of visible cases> Visible (Shown when analysis is performed on model data.)
  • Events: <number of events in model> Total, <number of events after sampling> Sampled, <number of visible events> Visible (Shown when analysis is performed on model data.)
  • Event Types: <number of event types in model> Total, <number of event types after sampling> Sampled, <number of visible event types> Visible (Shown when analysis is performed on model data.)
  • Filter: Filter name and Id (Shown when analysis is performed on model data.)
  • Filter rules in hierarchical order (Shown when analysis is performed on model data.)
  • Other non-model bound analysis: Idea Feed, Models, Operation Log, User Permissions, Model Report, Project Report, Data Table Report, Script Report
  • List of analysis parameters as Key=Value pairs