SWAPI – KpiListQuery

Use this command to obtain a list of Kpi’s in SuccessWare®21.

Request

<?xml version="1.0" encoding="UTF-8"?>

</SessionRequest>

Response

<?xml version="1.0" encoding="UTF-8"?>

<Name>string</Name>

<Category>string</Category>

<Description>string</Description>

<DefaultFormat>string</DefaultFormat>

<SWRequirements>string</SWRequirements>

<CalcType>string</CalcType>

<BaseTable>string</BaseTable>

<CanDrillDown>boolean</CanDrillDown>

<CanTotal>boolean</CanTotal>

<GroupByList>string</GroupByList>

</KpiListQueryRecord>

</KpiListQueryData>

</KpiListQueryResponse>

· KpiID – The Kpi’s unique ID

· Name – The Kpi name

· Category – The Kpi category

· Description – The Kpi description

· DefaultFormat – How the Kpi’s value should be formatted (displayed) to the user

· SWRequirements – What processes are required to be performed in SuccessWare®21 for the Kpi to produce meaningful results

· CalcType – The type of calculation (COUNT, SUM, RATIO, etc.)

· BaseTable – The SuccessWare®21 base table the Kpi uses

· CanDrillDown – TRUE if users can drill down into the detailed data that makes up the Kpi’s value

· CanTotal – If FALSE do not sum this column of Kpi’s in a report

· GroupByList – A comma separated list of group by names for the Kpi

Example

<?xml version="1.0" encoding="UTF-8"?>

</SessionRequest>

<?xml version="1.0" encoding="UTF-8"?>

<Name>Jobs Completed</Name>

<Description>The number of completed jobs</Description>

<SWRequirements>Complete Jobs</SWRequirements>

<CalcType>COUNT</CalcType>

<GroupByList>City, Dept Code (Job), Dept Name (Job), Job Class, Job Taken By (Full Name), Job Taken By (User ID), Job Type, Job Type (Code), Lead Source (Code) (Project), Lead Source (Project), Lead Source Type (Project), Primary Technician (Code), Primary Technician (Fir Las), Primary Technician (FLas), Primary Technician (Las Fir), Primary Technician (LasF), Reporting Job Class, Reporting Job Class (Code), Reporting Sales Source, Reporting Sales Source (Code), Sales Person (Project) (Code), Sales Person (Project) (Fir Las), Sales Person (Project) (FLas), Sales Person (Project) (Las Fir), Sales Person (Project) (LasF), State, Zip Code, Zone</GroupByList>

</KpiListQueryRecord>

<Name>Jobs that were Callbacks</Name>

<Description>This is the total number of completed jobs that have a checkmark in the Callback field in the Job Summary form.</Description>

<SWRequirements>Complete Job, Complete Job Summary form for Jobs</SWRequirements>

<CalcType>COUNT</CalcType>

</KpiListQueryRecord>

</KpiListQueryData>

</KpiListQueryResponse>