27.2 Metrics Web Service API

This section provides details about the methods available with the Metrics web service.

All of the methods throw MetricsServiceException and RemoteException. To improve readability, the throws clause has been omitted from the method signatures.

27.2.1 Team Manager Methods

This section provides reference information for each method available to team managers.

getClaimedFlowTimeCalendarDays

Syntax: Here’s the method signature:

double getClaimedFlowTimeCalendarDays(String processId, String processVersion, Date startCompletionTime, Date endCompletionTime, String teamDN,Map filters)

getClaimedFlowTimeWorkingDays

Syntax: Here is the method signature:

MetricsResultset getClaimedFlowTimeWorkingDays(String processId, String processVersion, Date startCompletionTime, Date endCompletionTime,String teamDN, Map filters)

getToClaimedFlowTimeCalendarDays

Syntax: Here is the method signature:

 double getToClaimFlowTimeCalendarDays(String processId, String processVersion, Date startCompletionTime, Date endCompletionTime, String teamDN,Map filters)

getToClaimedFlowTimeWorkingDays

Syntax: Here is the method signature:

  MetricsResultset getToClaimFlowTimeWorkingDays(String processId, String processVersion, Date startCompletionTime, Date endCompletionTime,String teamDN, Map filters)   

getClaimedInventory

Syntax: Here is the method signature:

 double getClaimedInventory(String processId, String processVersion, Date startCompletionTime, Date endCompletionTime, String teamDN, Map filters)

getClaimedThroughputCalendarDays

Syntax: Here is the method signature:

  double getClaimedThroughputCalendarDays(String processId, String processVersion, Date startCompletionTime, Date endCompletionTime, String teamDN Map filters)

getClaimedThroughputWorkingDays

Syntax: Here is the method signature:

    MetricsResultset getClaimedThroughputWorkingDays(String processId, String processVersion, Date startCompletionTime, Date endCompletionTime, String teamDN, Map filters)

getTeamLongestRunning

Syntax: Here is the method signature:

MetricsResultset getTeamLongestRunning(String processId, String processVersion, String teamDN, Map filters)

getTeamLongestClaimed

Syntax: Here is the method signature:

MetricsResultset getTeamLongestClaimed(String processId, String processVersion, String teamDN, Map filters) 

getTeamFlowHistory

Syntax: Here is the method signature:

MetricsResultset getTeamFlowHistory(List requestIds)

getTeamHistoryForInitiators

Syntax: Here is the method signature:

MetricsResultset getTeamHistoryForInitiators(String teamDN, Map filters)

getTeamHistoryForRecipients

Syntax: Here is the method signature:

MetricsResultset getTeamHistoryForRecipients(String teamDN, Map filters)

getTeamRunningTime

Syntax: Here is the method signature:

double getTeamRunningTime(String processId, String processVersion, String teamDN, Map filters)

getTeamDecisionCount

Syntax: Here is the method signature:

int getTeamDecisionCount(String processId, String processVersion, String teamDN, Map filters)

getTeamInitiatedCount

Syntax: Here is the method signature:

 int getTeamInitiatedCount(String processId, String processVersion, String teamDN, Map filters)

getTeamRecipientCount

Syntax: Here is the method signature:

 int getTeamRecipientCount(String processId, String processVersion, String teamDN, Map filters)

27.2.2 Provisioning Application Administrator Methods

This section provides reference information for each method available to the Provisioning Application Administrator.

getActivityFlowTimeCalendarDays

Syntax: Here is the method signature:

double getActivityFlowTimeCalendarDays(String processId, String processVer, String activityId, Date startTime, Date completeTime, Map filters)

getActivityFlowTimeWorkingDays

Syntax: Here is the method signature:

    MetricsResultset getActivityFlowTimeWorkingDays(String processId, String processVer, String activityId, Date startTime, Date completeTime, Map filters)

getActivityInventory

Syntax: Here is the method signature:

double getActivityInventory(String processId, String processVersion, String activityId, Date startTime, Date completeTime, Map filters)

getActivityThroughputCalendarDays

Syntax: Here is the method signature:

double getActivityThroughputCalendarDays(String processId, String processVersion, String activityId, Date startTime, Date completiontime, Map filters)

getActivityThroughputWorkingDays

Syntax: Here is the method signature:

 MetricsResultset getActivityThroughputWorkingDays(String processId, String processVersion, String activityId, Date startTime, Date completiontime,    Map filters)

getInventory

Syntax: Here is the method signature:

double getInventory(String processId, String processVersion, Date startTime, Date completeTime, Map filters)

getLongestClaimed

Syntax: Here is the method signature:

 MetricsResultset getLongestClaimed(String processId, String processVersion, Map filters)

getLongestRunning

Syntax: Here is the method signature:

MetricsResultset getLongestRunning(String processId, String processVersion, Map filters)

getFlowCount

Syntax: Here is the method signature:

int getFlowCount(String processId, String processVersion, Map filters)

getFlowHistory

Syntax: Here is the method signature:

MetricsResultset getFlowHistory(List requestIds)

getFlowHistoryForInitiators

Syntax: Here is the method signature:

    MetricsResultset getFlowHistoryForInitiators(List initiators, Map filters)

getFlowHistoryForRecipients

Syntax: Here is the method signature:

MetricsResultset getFlowHistoryForRecipients(List recipients, Map filters)

getRunningTime

Syntax: Here is the method signature:

 double getRunningTime(String processId, String processVersion, Map filters)

getThroughputCalendarDays

Syntax: Here is the method signature:

double getThroughputCalendarDays(String processId, String processVersion, Date startTime, Date completiontime, Map filters)

getThroughputWorkingDays

Syntax: Here is the method signature:

MetricsResultset getActivityThroughputWorkingDays(String processId, String processVersion, String activityId, Date startTime, Date completiontime,    Map filters)

27.2.3 Utility Methods

This section provides reference information for each utility method. Both team managers and administrators can call these methods.

getVersion

Syntax: Here is the method signature:

VersionVO getVersion()

getAllProvisioningFlows

Syntax: Here is the method signature:

MetricsResultset getAllProvisioningFlows()

getUserActivityOnlyFlow

Syntax: Here is the method signature:

BasicModelVO getUserActivityOnlyFlow(String processId, String processVer)

getTeams

Syntax: Here is the method signature:

MetricsResultset getTeams()

getTeamMembers

Syntax: Here is the method signature:

MetricsResultset getTeamMembers(String teamDN)