Copyright © TIBCO Software Inc. All Rights Reserved
Copyright © TIBCO Software Inc. All Rights Reserved


Chapter 5 Configuring an Adapter Instance : Adapter Services

Adapter Services
This tab provides options for adding and configuring adapter services:
Publisher
Publisher sends messages from Lotus Notes to applications configured for the TIBCO environment. Publisher extracts data from the fields of Lotus Notes documents in the database and publishes them on configured subject names.
Click Add Publisher and then specify values for the fields listed in Table 14.
 
Table 14 Publisher Options 
A service name must use alphanumeric characters. An underscore (_) character can be used. The entire instance name must be less than 80 characters. The space character cannot be used in an instance name. A service name cannot use substitution variables.
You can view the type and attributes of the class by double-clicking the Classes folder under AESchemas > ae > lotusnotes > metadatafile.schemamodel. For more information about schema, see the TIBCO Designer User’s Guide.
If Update is selected, the operation will be either Insert or Update.
If Upsert is selected, the operation will be either Insert or Upsert.
Click the FetchAgents button to list Lotus Notes agents that are defined in the Lotus Notes database. The agent specified in this field is invoked by the adapter after publishing the document.
Guidelines for Saving the Schema by Another Name
Within a project, all schema classes of Publishers are located in the /AESchemas/ae/lotusnotes/lnmetadata.schemamodel/classes folder, even if the services belong to different adapter instances.
Figure 23 Schema Classes Location
To avoid ambiguity, save the schema by a different name under the following circumstances:
A schema class is generated with a schema name by default. If the schema name for two Publishers is the same, the corresponding schema class for both will be the same.
The changes made to one schema class will affect the other schema class with the same schema name. To avoid loss of data in one or both the schemas, save one of them by a different name.
Specify different names in the Save As field of these services and create entries corresponding to each service in the Events View of the form.
Running Publisher
Publisher gets messages from a Lotus Notes application and sends the message to the TIBCO environment. Publisher is triggered by standard publisher agents. See Configuring Agents about creating agents in Lotus Domino Designer.
Subscriber
Subscriber sends messages from the applications configured for the TIBCO environment to the Lotus Notes. Click Add Subscriber and then specify values for the fields listed in Table 15.
 
Table 15 Subscriber Options 
A service name must use alphanumeric characters. An underscore (_) character can be used. The entire instance name must be less than 80 characters. The space character cannot be used in an instance name. A service name cannot use substitution variables.
Enable Key fields On Insert
When the checkbox is selected, the values of the key fields in the document will be checked for duplication. For the document, if the values of the key fields are new to the document in the database, an insert operation will be performed. This ensures that no new document will be inserted if the values of the key fields are the same.
Click the Fetch Agents button to get the list of Lotus Notes agents defined in the Lotus Notes database. The agent specified in this field is invoked by the adapter after subscribing the document.
Guidelines for Saving the Schema by Another Name
Within a project, all schema classes of Subscribers are located in the /AESchemas/ae/lotusnotes/lnmetadatasub.schemamodel/classes folder, even if the services belong to different adapter instances.
To avoid ambiguity, save the schema by a different name under the following circumstances:
A schema class is generated with a schema name by default. If the schema name for two services is the same, the corresponding schema class for both will be the same unless a different name is specified in the Save As field.
The changes made to one schema class will affect the other schema class if they have the same schema name. To avoid loss of data in one or both the schemas, save one of them by another name.
Guidelines for Setting Type
There are two approaches for the runtime adapter to use a Subscriber:
Normal—The runtime adapter uses the username and password specified in the LotusNotes Connection shared resource of the adapter instance to connect to the Lotus Notes application.
Withlogin—The runtime adapter uses credentials of the dynamically logged in user instead of the default parameters provided in the LotusNotes Connection shared resource to connect to the Lotus Notes application.
To configure a Subscriber with dynamic login, you also need a Login Service and a Logout Service.
Running Subscriber
Subscriber receives messages from the TIBCO environment and performs insert, update, delete, or upsert operation in the Lotus Notes database.
Subscriber uses ADAPTER_OPCODE to learn what kind of operation is to be performed. There are two ways to run a Subscriber:
with Publisher: If a Subscriber communicates with a Publisher within TIBCO ActiveMatrix environment, the Subscriber detects the value of ADAPTER_OPCODE from the Publisher at runtime.
with TIBCO ActiveMatrix BusinessWorks: If a Subscriber gets messages from TIBCO ActiveMatrix BusinessWorks, the Subscriber reads the ADAPTER_OPCODE field specified in the activity. See Configuring SOAP Activity for Subscriber for more information.
RPC Server
RPC Server responds to messages from applications configured for the TIBCO environment. Click Add RPC Server and then specify values for the fields listed in Table 16.
 
Table 16 RPC Server Options 
A service name must use alphanumeric characters. An underscore (_) character can be used. The entire instance name must be less than 80 characters. The space character cannot be used in an instance name. A service name cannot use substitution variables.
The AE Schema that is automatically generated from the selected BO when the adapter configuration is saved. The class reference for query operation is LOTUS_NOTES_RPC.
query  Updates the required response service to the pre-defined LOTUS_NOTESRPC schema, available in the repository.
insert  Associates the schema generated by the Request-Response Service to perform an insert operation in the Lotus Notes database.
update  Associates the schema generated by the Request-Response Service to perform an update operation in the Lotus Notes database.
delete  Associates the schema generated by the Request-Response Service to perform a delete operation in the Lotus Notes database.
upsert  Associates the schema generated by the Request-Response Service to perform a upsert operation in the Lotus Notes database.
Available only for operation type Insert. When the checkbox is selected, the key fields will take effect to avoid data absence and duplication; otherwise, the new document will be inserted.
Guidelines for Setting Type
There are two types of how a RPC Server can be used by the runtime adapter:
Normal—The runtime adapter uses the username and password specified in the LotusNotes Connection shared resource of the adapter instance to connect to the Lotus Notes application.
Withlogin—The runtime adapter uses the credentials of the dynamically logged-in user instead of the default parameters provided in the LotusNotes Connection shared resource of the adapter instance to connect to the Lotus Notes application. The sessionID returned by the Login Service needs to be attached as user closure.
To configure a RPC Server with dynamic login, you also need a Login Service and a Logout Service.
Running RPC Server
RPC Server receives requests from the TIBCO environment, performs insert, update, delete, upsert, or query operation in the Lotus Notes database, and then returns the response to the TIBCO environment.
The way to run a RPC Server varies with the operation type to be performed.
Insert, Update, Delete, Upsert
For operation types insert, update, delete, and upsert, TIBCO ActiveMatrix BusinessWorks provides input of the request that will be retrieved by RPC Server later.
See Configuring SOAP Activity for RPC Server for more information about how to use the activity.
Query
For the operation type query, there are several ways to provide input of the request that will be retrieved by the RPC Server later.
Detailed information about how to perform the query is defined in a client request form document, which can be found under the Request Response Invocation View folder in a TIBCO-enabled Lotus Notes database.
In this case, a TIB InitiateClientRequest agent is required to initiate the client request.
Configure a SOAP Request Reply activity and manually enter the detailed information about how to perform the query in the Activity Input panel.
See Configuring SOAP Activity for RPC Server for more information about how to use the activity.
RPC Client fetches detailed query information from a client request form document defined in Lotus Notes database. SOAP Request Reply activity gets query information from RPC Client.
Similar to the first approach, a TIB InitiateClientRequest agent is required to initiate the client request.
See Configuring SOAP Activity for RPC Server for more information about how to use the activity.
RPC Client
RPC Client responds to the messages from applications configured for the TIBCO environment. To add a Request-Response Invocation Service, click Add RPC Client and then specify values for the fields listed in Table 17.
The Request-Response Invocation Request Document Editor facilitates users with a friendly GUI when they are performing the configuration in TIBCO Business Studio. Users can apply the configuration in two ways:
–or–
 
Table 17 RPC Client Options 
A service name must use alphanumeric characters. An underscore (_) character can be used. The entire instance name must be less than 80 characters. The space character cannot be used in an instance name. A service name cannot use substitution variables.
This name is the same as the Request Name of a client-request-enabled document from the Request Response Invocation View folder in Lotus Notes database.
The AE Schema that is automatically generated from the selected BO when the adapter configuration is saved. The default value is LOTUS_NOTES_RPC.
Type of query operation. It can be query, view, FTSearch, or RunAgent.
When communicating with a Request-Response Service whose operation type is query, specify detailed query information with this option.
The agent to be invoked. With this option, you can configure to invoke Lotus agents at Request-Response Service side. This field corresponds to the Agent Name field in the client-request-enabled document.
Do not set the target field to All selected documents when defining the target agent in Lotus Domino Designer.
Result Customized
Configure whether the query result will be customized. This option corresponds to the Result Policy field in the client-request-enabled document.
Result Form Priority
Configure which decides the form of the result document first, local configuration or the form attribute of each record of the query result. This option corresponds to the Result Policy field in the client-request-enabled document. It is applicable only when the Result Customized checkbox is selected.
The form name of the result documents. It corresponds to the Result Form field in the client-request-enabled document. This field functions when the Result Customized checkbox is selected and the Result Form Priority is set to Client. At runtime, when you select Server, although the corresponding Requested Fields remains active, the Requested Fields does not take effect.
The field names of the result documents. It corresponds to the Requested Fields field in the client-request-enabled document. Click the Get Fields button next to this field to set the requested fields.
Click this button to fetch a client-request-enabled document, whose Request Name is the same as the service name, from the Request Response Invocation View folder in Lotus Notes database.
—The first matching document with Request Status as UnProcessed will be fetched. And only one document can be fetched.
—If there are no UnProcessed matching documents, clicking this button creates a new document with the service name and you can edit it in the Request-Response Invocation Request Document Editor.
Click this button to save the document in the Request Response Invocation View folder as UnProcessed.
Running RPC Client
RPC Client gets a request from a Lotus Notes application and sends the request through the TIBCO environment, then returns the response back to the application. In TIBCO ActiveMatrix Adapter Service Engine for Lotus Notes, RPC Client carries detailed information of a RPC Server query operation.
RPC Client is triggered by TIB InitiateClientRequest agents. See Configuring Agents about creating agents in Lotus Domino Designer.
Login Service
When the type of how a Subscriber or a RPC Server is to be used by the runtime adapter is withlogin, you need to configure a Login Service and a Logout Service.
Login Service responds to login requests from applications configured for the TIBCO environment. Click Add Login and then specify values for the fields listed in Table 18.
 
A service name must use alphanumeric characters. An underscore (_) character can be used. The entire instance name must be less than 80 characters. The space character cannot be used in an instance name. A service name cannot use substitution variables.
Running Login Service
Login Service is used with Subscriber and RPC Server for the dynamic login feature.
Logout Service
When the type of how a Subscriber or RPC Server is to be used by the runtime adapter is set to withlogin, you need to configure a Login Service and a Logout Service.
The Logout Service responds to logout requests from applications configured for the TIBCO environment. The dynamically logged in user can be logged out of the Lotus Notes Application by sending a request to the Logout Service specifying the sessionID. Click Add Logout and then specify values for the fields listed in Table 19.
 
A service name must use alphanumeric characters. An underscore (_) character can be used. The entire instance name must be less than 80 characters. The space character cannot be used in an instance name. A service name cannot use substitution variables.
The AE Schema that is automatically generated from the selected BO when the adapter configuration is saved. The default value is LOGOUT_RPC.
Running Logout Service
Logout Service is used with Subscriber and RPC Server for the dynamic login feature.

Copyright © TIBCO Software Inc. All Rights Reserved
Copyright © TIBCO Software Inc. All Rights Reserved