Using the GP APIs (SAP Library - SAP NetWeaver Composition Environment Library)

Using the GP APIs

With the Guided Procedures (GP) application programming interfaces (APIs), you can customize and enhance your composite applications.

To use the GP APIs, you must add to your project design time, build-time and runtime dependencies to development component caf/eu/gp/api (public part external) in software component GP-CORE.

For a detailed description of the GP public APIs, you can refer to:

● The Javadocs on SAP Developer Network(SDN).

For more information, see http://www.sdn.sap.com/irj/sdn/javadocs.

● The documentation available in SAP Library.

The table below lists some of the most frequently used factory classes and manager interfaces that help you build your composite.

Factory Classes and Interfaces in GP APIs

Name and Package	Description	Related Documentation
com.sap.caf.eu.gp.process.api.GPProcessFactory
com.sap.caf.eu.gp.process.rt.api. IGPRuntimeManager	Used to start and stop processes, assign process roles, manage runtime attachments.	Starting and Terminating Processes Using the GP API Managing Runtime Activities Using the GP API Completing Actions Using the GP API Managing Runtime Attachments Using the GP API
com.sap.caf.eu.gp.process.dt.api. IGPDesigntimeManager	Used to retrieve information about GP development objects.	Starting and Terminating Processes Using the GP API
com.sap.caf.eu.gp.process.dt.api. IGPDesigntimeUpdateManager	Used to modify GP development objects.	Modeling and Configuring Workflows Using the GP API
com.sap.caf.eu.gp.process.rt.api. IGPNotificationManager	Used to retrieve and update process notifications at runtime.	Managing Process Notifications Using the GP API
com.sap.caf.eu.gp.co.type.api.GPCallableObjectTypeFactory
com.sap.caf.eu.gp.co.type.api. IGPCallableObjectTypeManager	Used to create an instance of a callable object type, specifying attributes such as type of runtime container, permissions, name, and so on.	Implementing and Registering Callable Object Types
com.sap.caf.eu.gp.rtview.api.GPRTViewFactory
com.sap.caf.eu.gp.rtview.api. IGPRTViewManager	Used to create, configure and register custom runtime view configurations.	Creating Custom Runtime Views Using the GP API
com.sap.caf.eu.gp.rtcontent.api.GPRTContentFactory
com.sap.caf.eu.gp.rtcontent.api. IGPRTContentManager	Used to create content components and events for the custom runtime views.	Creating Custom Runtime Views Using the GP API
com.sap.caf.eu.gp.wdcomponent.api.GPWDComponentFactory
com.sap.caf.eu.gp.wdcomponent.api. IGPWDComponentManager	Used to create and register Web Dynpro components for the custom runtime views.	Creating Custom Runtime Views Using the GP API
com.sap.caf.eu.gp.bo.api.GPBusinessObjectFactory
com.sap.caf.eu.gp.bo.api. IGPBusinessObjectUtilityManager	Used to create aspects of business objects and endpoints for business object providers.	Exposing Business Object Data in the GP Context
com.sap.caf.eu.gp.scheduling.api.GPScheduleFactory
com.sap.caf.eu.gp.scheduling.api. IGPScheduleService	Used to create and configure tasks and schedules for process initiation.	Scheduling Process Initiation Using the GP API
com.sap.caf.eu.gp.forms.api.InteractiveFormsFacade
com.sap.caf.eu.gp.forms.api. IFormProcessor	Used to create form instances.	Using the Forms API
com.sap.caf.eu.gp.forms.api. IFormTemplateManager	Used to retrieve information about form templates.	Using the Forms API