Funnel charts could be generated inside page, card, arrange and tab definitions.
Figure 1 - Funnel chart in a page
None.
Use a funnel chart when you want to represent stages in a process along with the values per stage.
Follow the steps below to add a funnel chart to a page.
Define a funnel chart in the client model file using the following format.
//-------------Declarative Syntax--------------
funnelchart <funnel_chart_name> for <entity_name> {
...
}
<funnel_chart_name> - identity of the funnel chart, always use a meaningful identifier.
<entity_name> - The entity or the summary the funnel chart is based on, see examples below:
//---------------Example Code------------------
funnelchart OrderTypeFunnelChart for OrderTypeSummary {
...
}
Add the funnel chart to a page, card, arrange, tab. A funnel chart gets it's vales from a data source which is either an entityset or an array.
//---------------Declarative Syntax------------------
page <page_name> {
funnelchart <funnel_chart_name> using <entityset_for_funnel_chart>;
}
<entityset_for_funnel_chart> - This is the entityset that serves as the data source from which the funnel chart gets its values. The entityset must be based on the same entity that was used to define the funnel chart.
//---------------Example Code Method 1------------------
page FunnelChart using OrdersSet {
funnelchart OrderCategoriesFunnelChart using OrderCategoriesSet;
}
//---------------Declarative Syntax------------------
page <page_name> using <entityset_for_page> {
funnelchart <funnel_chart_name>;
}
This method is useful if the purpose of the page is to display a funnel chart of records. In such instances it is not mandatory to define an entityset for the funnel chart since it gets its values from the <entityset_for_page>.
//--------------- Example Code Method 2 -----------------
page FunnelChart using OrderCategoriesSet {
funnelchart OrderCategoriesFunnelChart;
}
//---------------Declarative Syntax------------------
page <page_name> using <entityset_for_page> {
funnelchart <funnel_chart_name>(<funnel_chart_array>);
}
<funnel_chart_array> - This is the array or reference defined in the related projection file.
Most of the time an array or reference is connected to a parent record and needs to be updated when the parent record is changed. In such instances the funnel chart needs to be bound to the control which has the parent record, for example a selector or a list. The binding is done using the bind keyword.
//---------------Declarative Syntax------------------ page <page_name> using <entityset_for_page> { selector <selector_name>; funnelchart <funnel_chart_name>(<funnel_chart_array>) bind <selector_name>; }//--------------Example Code Method 3-------------- page Form using OrdersSet { selector OrdersSelector; funnelchart OrderItemsFunnelChart(OrderItemsArray) bind OrdersSelector; }
//---------------Declarative Syntax------------------
page <page_name> {
list <funnel_chart_name> using <function_set>;
}
<function_set> - This is the function defined in the related projection file that returns an entity collection. Function should return the same type entity collection as the funnel chart is based on. Function parameters can get values from several places like the current record of the page, global context, search context, etc.
//-------------- Example Code Method 4 ------------
page Form using ServiceInvoiceSet {
selector ServiceInvoiceSelector;
list ServiceInvoiceLineList using GetInvoiceLines(InvoiceNo, context.Company)
}
The below code snippets would show how funnel chart could be integrated to a card (Only referenced funnel chart could be generated).
(Parent-Child relationship [1-M])
//---------------Example Code------------------
card CardName for SomeEntity {
funnelchart FunnelChartName(ChildArrayName);
}
Set one or more properties for the funnel chart such as label, collapsed, centerlabel etc. For a complete funnel chart of the properties and how to set them see the Properties section below.
Content for a funnel chart can be added in the form of argument, value and commands
The below code snippet is the very least amount of properties required to generate a funnel chart.
//---------------Example Code------------------
funnelchart FunnelChartName for SomeEntity {
label = "This is my funnel chart title";
argument ArgumentFieldName;
value ValueFieldName;
}
The argument keyword is one of the two main field attributes required to generate a funnel chart. Argument field being the data source field that provides arguments for series points (i.e. the field that you are applying the GROUP BY clause).
//---------------Example Code------------------
funnelchart FunnelChartName for SomeEntity {
argument ArgumentFieldName;
}
The value keyword is one of the two main field attributes required to generate a funnel chart. value field being the data source field that provides values for series points (i.e. the field which has an Aggregate Function).
//---------------Example Code------------------
funnelchart FunnelChartName for SomeEntity {
value ValueFieldName;
}
The keyword topn is used to limit the number of visible slices in the funnel chart according to different conditions. There are 3 modes in topn;
Is used to limit the number of slices by specifying the number slices to be shown.
//---------------Example Code------------------
funnelchart FunnelChartName for SomeEntity {
label = "This is my funnel chart title";
argument ArgumentFieldName;
value ValueFieldName;
topn = Count(3);
}
The above condition would make the funnel chart to only show top 3 slices along with others slice.
Is used to limit the number of slices by specifying a minimum value.
//---------------Example Code------------------
funnelchart FunnelChartName for SomeEntity {
label = "This is my funnel chart title";
argument ArgumentFieldName;
value ValueFieldName;
topn = ThresholdValue(100);
}
The above condition would make the funnel chart to only show slices that has a value greater than or equal to 100.
Is used to limit the number of slices by specifying a minimum percentage of the total
//---------------Example Code------------------
funnelchart FunnelChartName for SomeEntity {
label = "This is my funnel chart title";
argument ArgumentFieldName;
value ValueFieldName;
topn = ThresholdPercent(20);
}
The above condition would make the funnel chart to only show slices that has a percentage greater than or equal to 20 of the total.
In all of the 3 modes others slice would be shown along with slices which satisfied the given criteria. others slice represents the sum of all the other slices which didn’t satisfy the condition.
Slices could be colored using the emphasis property
//---------------Example Code------------------
funnelchart FunnelChartName for SomeEntity {
label = "This is my funnel chart title";
argument ArgumentFieldName;
value ValueFieldName;
emphasis Complementary1 = [ArgumentFieldName = "Something"];
emphasis Complementary3 = [ValueFieldName = "Something"];
}
The emphasis property has predefined set of colors to choose from.
Could evaluate the condition from either ArgumentFieldName or ValueFieldName.
Slices could be filled with patterns using the pattern property.
//---------------Example Code------------------
funnelchart FunnelChartName for SomeEntity {
label = "This is my funnel chart title";
argument ArgumentFieldName;
value ValueFieldName;
pattern fillpattern1 = [ArgumentFieldName = "Something"];
pattern fillpattern2 = [ValueFieldName = "Something"];
}
pattern has predefined set of constants to choose from.
Could evaluate the condition from either ArgumentFieldName or ValueFieldName.
The details property can be used to navigate to details of a funnel chart.
//---------------Declarative Syntax------------------
page <page_name> {
funnelchart <funnel_chart_name> using <entityset_for_funnel_chart>{
details = <detail_page_name>(arguments)
}
}
The arguments are the primary and foreign keys needed to query the record.
//---------------Example Code------------------
page ActivityPage using ActivityChartEntityset {
title = "Activity Chart";
funnelchart ActivityFunnelChart {
details = ActivityDetailsPage(ActivityType);
}
}
funnelchart ActivityFunnelChart for ActivityChartSummary {
argument ActivityType;
value Count;
}
Below is a list of properties that can be used to customize the control.
collapsed | centerlabel | details | filter | label | visible
This section is still under construction. The completed version will be available in IFS Applications 10 Update 8.