Show TOC

Procedure documentationBuilding an Administration UI with the BPM API Locate this document in the navigation structure

 

With the Business Process Management (BPM) application programming interfaces (APIs), you can customize and enhance the way you use business processes and execute tasks.

This document describes how you use the BPM APIs to build your administration UI.

For a detailed description of the BPM public APIs, see http://help.sap.com/javadocs/.

Prerequisites

You have added the necessary dependencies to development component tc/bpem/facade/ear (public part api) in software component BPEM-FACADE.

Procedure

  1. Get process definition.

    Returns the ProcessDefinition of the ProcessInstance specified by the given id.

    Syntax Syntax

    1. ProcessDefinition getProcessDefintion(URI processInstanceId)throws BPMException
    End of the code.

  2. Get running process instances.

    Returns a Set of the running ProcessInstances of the given ProcessDefintion.

    Syntax Syntax

    1. Set<ProcessInstance> getRunningProcessInstances(URI processDefinition)throws BPMException
    End of the code.

  3. Generate process visualization URL.

    Returns an absolute URL to the Process Visualization for the given process instance ID.

    Syntax Syntax

    1. URL generateProcessInstanceVisualizationURL(URI processInstanceId)throws BPMException
    End of the code.

  4. Get task abstract by parent.

    Returns the set of instances of TaskAbstract for a given process instance.

    Syntax Syntax

    1. Set<TaskAbstract> getTaskAbstractsByParent(URI processInstanceId,Set<Status> statuses)throws BPMException
    End of the code.

  5. Nominate.

    Triggers the nominate task action.

    Syntax Syntax

    1. void nominate(URI taskInstanceId,IUser newOwner)throws BPMException
    End of the code.

  6. Set priority.

    Sets the priority of the given task to a new value.

    Syntax Syntax

    1. void setPriority(URI taskInstanceId,Priority prioriy)throws BPMException
    End of the code.

  7. Get process instance for task instance ID.

    Returns the parent process instance for the given task instance ID.

    Syntax Syntax

    1. ProcessInstance getProcessInstanceForTaskInstanceId(URI taskInstanceId)throws BPMException
    End of the code.