Defining Analyses
Learn to define analyses in CRM.Designer.
To define an analysis in CRM.Designer:
- Select an analysis or create a new one. For further details, see Designing Configuration Units.
- Specify the following:
- Based on Query: Defines which query is executed for the analysis. This query is read-only if it is stored in the Aurea CRM database. It is recommended to store your queries in the Aurea CRM database (default). For further details, see Storing Queries. Click Update to load the latest version of the query.
- Max. Count of Bars: Defines how many bars (or pie segments) are contained in the analysis. If the selected category results in more values than defined in the Max. Count of Bars, the bars with the smallest values are grouped into an "other" value (unless otherwise specified in the definition for the category, i.e. NoOther option checked).
- CRM Processes: Assign one or more CRM processes to the analysis. For further details, see Roles & CRM Processes.
- Description: Add an internal description only visible in CRM.Designer.
- Readonly in update.web: If checked, users cannot edit the analysis in Aurea CRM.Web.
-
Invisible in web-lists: If checked, users cannot select the
analysis in Aurea CRM.Web.Note: Use the Read-only and Invisible settings for analyses called via menu actions etc. Alternatively, you can use the
Analysis.Rights
Web Configuration parameter to determine whether users can execute and/or edit predefined analyses. For further details, see Analysis.Rights. - Type/Value fixed: If checked, the user cannot change the predefined result columns in Aurea CRM.Web.
- All Column on X-Categories: Check to display an additional column containing the sum total for additional categories. For further details, see Using an Additional Category on the x-Axis.
- No Sum Line: Hides the sum total row in the analysis results.
- Query: Defines where the query is searched depending on the format type. For further details, see Format Types for Queries and Analyses. Set it to "All" for predefined analyses.
- Define the category (x-axis), value (y-axis) and filter fields for the analysis. The
fields are taken from the selected query's output fields.
-
Category fields (x-axis): Check CriteriaField for
all fields you want to use to aggregate data by (e.g.
Country). These fields can be selected from the Category
drop-down list and used for drill-down.
Category fields can be of type character, date, catalog or Boolean. If you select a date field, the data is not grouped by its exact value. The date range is sliced into a fixed amount of result rows, each containing a date range of the same size.
Specify additional settings if applicable. For further details, see Settings for Category Fields.
-
Value fields (y-axis): Check ValueField for all
fields that can be aggregated (e.g. Total Prod. Value).
Only numeric fields can be selected.
Specify additional settings if applicable. For further details, see Settings for Value Fields.
-
Filter fields: Check AdditionalCriteria for fields
used to filter the analysis result (e.g. Completion Date).
Filter fields can be of type character, date or catalog.
Specify additional settings if applicable. For further details, see Settings for Filter Fields.
-
Category fields (x-axis): Check CriteriaField for
all fields you want to use to aggregate data by (e.g.
Country). These fields can be selected from the Category
drop-down list and used for drill-down.
- Specify defaults:
- CriteriaDefault: Select the default category field.
- Weight: Select the (percentage) field used for weighted values (defined by the WeightedField option).
-
Currency: If your analysis contains currency-dependent
value fields (defined by the DependentOnCurrency option),
select a currency field. The currency specified in this field is used for the
analysis. If the selected currency field contains another than the destination
currency, values are converted using the currency conversion rate stored in the
Aurea CRM database.
If the query contains more than one currency field, you can select different currency fields. These fields depend on the record containing the currency-dependent field. Select the AlternateCurrencyField option for a field of that info area. For example, the
SalesFunnel
analysis defined in UPDATE_DEFAULT has currency fields and currency dependent-fields in the Opportunity record and in the Opportunity Product record. The currency field in the Opportunity Product record is defined as AlternateCurrencyField and is used for currency-dependent value fields instead of the Opportunities currency field. Do not use more than one currency in an opportunity.
- Configure the list view of the analysis result.
For each field you want to display in the results list define the following:
- List-Nr.: The position of the column in the list.
- List-Width: The column width in percent.
If undefined, no results list is available (menu item Display Details hidden).
- Define the default result columns for the analysis in the Default
Values area:
- Select the aggregation type (Sum, Count, Average, Minimum, Maximum).
- Select the desired value.
- Click
(Add).
The sum total row at the bottom of the results column in Aurea CRM.Web displays the total result according to the selected aggregation type (e.g. the sum total for "Sum", the highest maximum value for "Maximum" etc.
In the sum total row each result record is taken into account only once even if it is used in several result rows, i.e. if a category field from a child record is used. Example in UPDATE_DEFAULT:
SalesFunnel
analysis - for Count (Opportunity) per Y5-Product Group the sum total does not necessarily have to correspond to the sum of the values of this column.Note: The sum total row is not available in the drill-through details view.Note: Default values are also used if Type/Value fixed is set for the analysis, or the displayed analysis in Aurea CRM.Web has no controller.Note: If you remove a field you use as default value from the query, the reference is lost: - Define additional values (calculations, parameters) if applicable. For further details, see Additional Values.
- Click Save.
To display an analysis in Aurea CRM.Web, create a menu action or include the analysis in a form e.g. a dashboard (
AnalysisResult
widget). For further details, see AnalysisRun and Forms.