Agent Detected Items Prioritization by Segment

The pricefx_acc_ag_get_prioritize_segments tool groups the items that an Agent detected by a customer or product segment, for example customer segment or product group. For each segment, the tool returns the total impact and its share of the Agent's total impact, so you can see where most of the impact is.

You can identify the Agent using one of: agentId, agentUniqueName, or agentLabel.
You must provide at least one of: customerDimension or productDimension.
Optional controls include topRows (how many ranked rows to return) and impactMeasureSelector (Revenue, Profit, Costs, Trends, Benchmark, Others).

Tool Name – pricefx_acc_ag_get_prioritize_segments

Title – Agent Detected Items Prioritization by Segment

Type – Private

Access Profile: Configurator

This tool is only available with the Accelerate Agents 1.7.

Permissions

The tool is available only to the Configurator access profile when tool access control is on.

You can use the tool for an Agent only if you have one of the following: an Agent business role (Agent Manager, Agent Contributor, or Agent Analyst); one of the user roles MANAGE_ACTIONS, ADMINISTER_ACTIONS, or a MODULECATEGORY_CFO or MODULECATEGORY_MO role; or membership in a user group that can edit or view the Agent's details.

Parameters

Parameter	Required	Description
`agentId`	Yes, if `agentUniqueName` and `agentLabel` are not given	Agent ID.
`agentUniqueName`	Yes, if `agentId` and `agentLabel` are not given	Agent unique name. Not case-sensitive. Spaces are ignored.
`agentLabel`	Yes, if `agentId` and `agentUniqueName` are not given	Text that the Agent label contains. Not case-sensitive. Spaces are ignored. If several Agents match, the tool uses the most recently updated one.
`customerDimension`	Yes, if `productDimension` is not given	Customer field to group by, for example Customer Segment. Matches the field name exactly or part of the field label, not case-sensitive.
`productDimension`	Yes, if `customerDimension` is not given	Product field to group by, for example Product Group. Matched the same way as `customerDimension`.
`topRows`	No	Maximum number of segments to return, up to 10. The default is 10.
`impactMeasureSelector`	No	Impact type to show: Revenue, Profit, Costs, Trends, Target, Benchmark, or Others. Not case-sensitive. The default is all impact types of the Agent.

Output

The tool returns a table with one row per segment, ranked by share of impact, largest first. Each row has these columns, named by the labels in the Agent's Detected Items:

Column	Description
Dimension columns	Segment values, for example Germany.
Measure columns	Sum of each measure of the Agent for the segment.
<Measure> (Impact)	Sum of each selected impact for the segment.
Total of <Measure> (Impact)	Sum of the impact over all segments.
Percentage of <Measure> (Impact)	Share of the segment in the total impact, as a fraction: 0.25 means 25%.

Errors

Situation	Error Message
No Agent identifier is given	`No identifier provided. Please provide typedId, name or label of the Agent.`
No dimension is given	`No dimension provided. Please provide dimensions of the Agent.`
No Agent matches	`Agent not found.`
You do not have access to the Agent	`You don’t have permission to perform any actions on this agent.`
`impactMeasureSelector` is not a supported type	`Agents do not support the impact metric X. Use one of: Revenue, Profit, Costs, Trends, Benchmark, Others`
The Agent has no impact of the selected type	`The Agent 'X' does not have impact type 'Y', it only has: {...}`
The Agent has no impact definitions	`No impact data. Please check Agent Action Definition.`
No dimension matches an Agent field	`Dimensions [...] are not available in the Agent. Please check Agent Scope Definition.`

Permissions

Parameters

Output

Errors

See Also