Adding TaskManager Endpoints

Summary of steps
Add a TaskManager endpoint using the Java API

You can programmatically add a TaskManager endpoint to a service by using the LiveCycle Java API. By adding a TaskManager endpoint to a service, you enable a Workspace user to invoke the service. That is, a user working in Workspace can invoke a process that has a corresponding TaskManager endpoint.

Note: You cannot add a TaskManager endpoint by using web services.

Summary of steps

To add a TaskManager endpoint to a service, perform the following tasks:

Include project files.
Create an EndpointRegistryClient object.
Create a category for the endpoint.
Set TaskManager endpoint attributes.
Create a TaskManager endpoint.
Enable the endpoint.

Include project files

Include the necessary files in your development project. If you are creating a client application by using Java, include the necessary JAR files. If you are using web services, make sure that you include the proxy files.

The following JAR files must be added to your project’s class path:

adobe-livecycle-client.jar
adobe-usermanager-client.jar
adobe-utilities.jar (required if LiveCycle is deployed on JBoss Application Server)
jbossall-client.jar (required if LiveCycle is deployed on JBoss Application Server)

For information about the location of these JAR files, see Including LiveCycle Java library files.

Create an EndpointRegistry Client object

Before you can programmatically add a TaskManager endpoint, you must create an EndpointRegistryClient object.

Create a category for the endpoint

Categories are used to organize services within Workspace. That is, a Workspace user can invoke a service that has a TaskManager endpoint by selecting a category within Workspace. When creating a TaskManager endpoint, you can either reference an existing category or programmatically create a new category.

Note: This section creates a new category as part of adding a TaskManager endpoint to a service.

Set TaskManager endpoint attributes

To create a TaskManager endpoint for a service, specify the following values:

Connector identifier: Specifies the type of endpoint that is created. To create a TaskManager endpoint, specify TaskManagerConnector.
Description: Specifies the description of the endpoint.
Name: Specifies the name of the endpoint.
Service identifier: Specifies the service to which the endpoint belongs.
Category: Specifies a category identifier value that is associated with the TaskManager endpoint.
Operation name: Typically, when creating a TaskManager endpoint for a service that originated from a process created in Workbench, the name of the operation is invoke.

Create a TaskManager endpoint

After you set a TaskManager endpoint attributes, you can create a TaskManager endpoint for a service.

Enable the endpoint

After you create a new endpoint, you must enable it. When the endpoint is enabled, it can be used to invoke the service from within Workspace. After you enable the endpoint, you can view it within Administration Console.

Add a TaskManager endpoint using the Java API

Add a TaskManager endpoint by using the Java API:

Include project files.

Include client JAR files, such as adobe-livecycle-client.jar, in your Java project’s class path.
Create an EndpointRegistry Client object.
- Create a ServiceClientFactory object that contains connection properties.
- Create an EndpointRegistryClient object by using its constructor and passing the ServiceClientFactory object.
Create a category for the endpoint.
- Create a CreateEndpointCategoryInfo object by using its constructor and passing the following values:
  - A string value that specifies the identifier value of the category
  - A string value that specifies the description of the category
- Create the category by invoking the EndpointRegistryClient object’s createEndpointCategory method and passing the CreateEndpointCategoryInfo object. This method returns an EndpointCategory object that represents the new category.
Set TaskManager endpoint attributes.
- Create a CreateEndpointInfo object by using its constructor.
- Specify the connector identifier value by invoking the CreateEndpointInfo object’s setConnectorId method and passing the string value TaskManagerConnector.
- Specify the description of the endpoint by invoking the CreateEndpointInfo object’s setDescription method and passing a string value that describes the endpoint.
- Specify the name of the endpoint by invoking the CreateEndpointInfo object’s setName method and passing a string value that specifies the name.
- Specify the service to which the endpoint belongs by invoking the CreateEndpointInfo object’s setServiceId method and passing a string value that specifies the service name.
- Specify the category to which the endpoint belongs by invoking the CreateEndpointInfo object’s setCategoryId method and passing a string value that specifies the category identifier value. You can invoke the EndpointCategory object’s getId method to get the identifier value of this category.
- Specify the operation that is invoked by invoking the CreateEndpointInfo object’s setOperationName method and passing a string value that specifies the operation name. Typically, when creating a TaskManager endpoint for a service that originated from a process created in Workbench, the name of the operation is invoke.
Create a TaskManager endpoint.

Create the endpoint by invoking the EndpointRegistryClient object’s createEndpoint method and passing the CreateEndpointInfo object. This method returns an Endpoint object that represents the new TaskManager endpoint.
Enable the endpoint.

Enable the endpoint by invoking the EndpointRegistryClient object’s enable method and passing the Endpoint object that was returned by the createEndpoint method.