Copyright © TIBCO Software Inc. All Rights Reserved

Request-response Service Fields

The following tabs are available:

•	Configuration Tab

•	Transport Tab

•	Schema View Tab

•	Schema Tab

Configuration Tab

The Configuration tab contains the fields listed in Table 17, Field Description of Configuration Tab (Sheet 1 of 3).

Table 17 Field Description of Configuration Tab

Field	Description
Name	You can use the default name or replace it with a name of your choice. • 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 global variables.
Description	Provide information about the service that you want stored in the project. The field is optional.
Transport Type	Select the transport to be used by the runtime adapter, JMS or TIBCO Rendezvous. After selecting the transport, the transport-specific configuration fields display. The transport can be configured to use a trusted store and identity resource for use in SSL (Secure Sockets Layer) configurations. TIBCO Rendezvous sessions and JMS topics have an SSL configuration field that uses a dialog to perform SSL configuration. To enable and configure SSL, in the Project panel, expand the Advanced folder, then expand the Sessions folder. Select the TIBCO Rendezvous session or JMS topic and click the Use SSL? checkbox. The SSL configuration options are explained in the online help associated with the session dialog. Click the question mark to display the online help.
LDAP Operations	Specify the operations that this service supports. At least one operation must be selected. Select: • Insert — To add an entry. • Update — To update an existing entry. • Delete — To remove an entry. • Upsert — To update an entry if it already exists. If the entry does not exist, running this operation will insert it. • Modify DN — To move an entry from one location to another by changing the RDN. • Validate Object — To validate the object class of a requested entry against the configured object class for all operations. • Lookup — To find an entry. • Authenticate — To validate a user DN with a specific password. • Search — To find entries that match a search criteria. The search filter defines criteria that an entry must match to be returned from a search. The basic component of a search filter is an attribute value assertion of the form: attribute operator value For example: (|(sn=Smith)(sn=Miller)) matches entries with the surname Smith or the surname Miller. TIBCO ActiveMatrix Adapter for LDAP supports standard LDAP search. Therefore, if your search filter is LDAP compatible, the adapter will be able to successfully execute the action. For more details on search filters and their syntax, see the following RFC at http://www.ietf.org/rfc/rfc1558.txt If you select this field, the Limit Search Results field is displayed. • Limit Search Results — If you select this check box, the Enter The Number Of Entries field is displayed. • Enter The Number Of Entries— Specify the number of entries that the adapter should search. The default is 2,147,483,647, the maximum 32-bit integer value. LDAP Adapter supports an unlimited search size. • Extended Search — If you select this check box, the adapter returns all the entries found in the search without checking for the configured objectclasses that the entry belongs to.
Chase Referrals	Check this checkbox to specify that if a referral is encountered during an operation, the referral should be followed. When you browse the DIT tree, the adapter palette will not follow a referral and only entries on the configured server will be displayed. The referring server returns an LDAP URL in the following format: ({ldap|ldaps}://host[:port]/DN). Depending on the URL used, the following referral chasing scenarios are possible: • If the URL is ldaps://, then referral chasing uses SSL. • If the URL is ldap://, then referral chasing does not use SSL. If the bind to the original server is SSL-EXTERNAL and the referral URL is ldap://, then the bind to referred server will be anonymous. Referrals are not supported for the publication service. Chasing referrals for a selected operation will work only if the authentication information used for connecting to the servers is identical for all servers.
Referral Hop Count	This field specifies the number of servers that must be followed if a referral is encountered. If there are more referral servers than the number specified in this field, these servers will not be in the purview of the specified operation. This field is available only if you check the Chase Referrals checkbox.

For a limited search, since Microsoft Active Directory and Microsoft Active Directory Application Mode support 1,000 records as their maximum page size, even though you specify a larger number of entries than 1,000, for the limit search, you can only get at most 1,000 records returned. Meanwhile, the adapter shows a "Size Limited Exceeded" error message. If you see "Size Limited Exceeded" error message, you can use the range retrieval option for retrieving records.

Transport Tab

The Transport tab contains the fields listed in Table 18, Field Description of Transport Tab (Sheet 1 of 4)

Table 18 Field Description of Transport Tab

Field	Description
Message Subject	This field displays only if the TIBCO Rendezvous item is selected in the Transport Type drop-down list (under the Configuration tab). By default, a service uses a message subject that is generated using the Domain and Deployment global variables, the adapter acronym, the adapter instance name and the service name. If you use this default subject, make sure the values for Domain and Deployment are not empty. You can type a TIBCO Rendezvous subject name different from the default in this field. See TIBCO Rendezvous Concepts for information about specifying subject names.
Destination	This field displays only if the JMS item is selected in the Transport Type drop-down list (under the Configuration tab). By default a service uses a dynamic destination that is generated using the Domain and Deployment global variables, the adapter acronym, the adapter instance name, and the service name. If you use this default dynamic destination, make sure the values for Domain and Deployment are not empty. You can override the default dynamic destination by specifying the static destination in this field. The static destination must be defined on the JMS server before it can be used by the runtime adapter. See TIBCO Enterprise Message Service User’s Guide for information about destinations.
Quality of Service	If TIBCO Rendezvous is selected as the transport type, select: • Certified Guarantees that every certified message reaches its intended recipient in the order sent. The message can be sent across network boundaries, and if a network fails, delivery attempts continue until delivery succeeds or until the message's time limit expires. This is often called certified message delivery. If certified message delivery is used, data is stored in a ledger file. The size of the ledger depends on several factors, the most important of which is the retention rate of stored data. That is, the ledger grows fastest in response to the cumulative length of undeliverable messages. You must ensure that sufficient disk space is available for the expected size of the ledger. • Distributed Queue Distributed queue includes a group of cooperating transport objects, each in a separate process. Each transport object is called a member. To balance the transmission load among servers, the adapter can use distributed queues for one-of-n delivery of messages to a group of servers. Each member of a distributed queue listens for the same subject using the TIBCO Rendezvous Distributed Queue listener objects. Even though many members listen for each inbound message (or task), only one member processes the message. For details on distributed queues, see TIBCO Rendezvous Concepts. Load balancing for the processing of TIBCO Rendezvous certified messages is supported by using distributed queuing. The messages from TIBCO Rendezvous are distributed equally among all instances that belong to the same group. This distributes the message load over several adapter instances. However, the order in which messages are sent to the application is not guaranteed. • Reliable Ensures that each multicast or broadcast message is received as long as the physical network and packet recipients are working, and that the loss of a message is detected. This choice can compensate for brief network failures because it can retransmit a message on request if the first attempt failed. This choice is appropriate when message delivery is expected but some loss can be tolerated.
Wire Format	Services must use the same wire format to exchange data. • ActiveEnterprise Message (TIBCO Rendezvous only) Control information for validation is sent in the message. If no control information is included, an exception is returned to the subscriber. ActiveEnterprise standard wire format provides class information and packing rules for the TIBCO Adapter SDK set of data types. This format allows ActiveEnterprise components to perform extra validation on messages sent or received. See TIBCO Adapter SDK Programmer’s Guide for details about the control information generated and sent with ActiveEnterprise messages. • XML Message (TIBCO Rendezvous and JMS) The XML Message wire format conforms to specifically constructed and fully compliant XML Schema (XSD) based on the existing definition of the ActiveEnterprise schema.
Connection Factory Type	• Topic (JMS only) A message published to a topic is broadcast to one or more subscribers. All messages published to the topic are received by all services that have subscribed to the topic. This messaging model is known as publish-subscribe. • Queue (JMS only) A message sent to a queue is consumed by one and only one receiver. Each message has only one receiver though multiple receivers may connect to the queue. The first receiver to access the queue gets the message. The other receivers do not. This messaging model is known as point-to-point.
Delivery Mode	For a request-response service, a message is marked as durable or non-durable. This field is available only if JMS transport is selected. • Durable If a request-response service is marked durable, it indicates that messages need to be resent on the configured topic or queue, if the JMS server goes down. • Non-durable If a request-response service is marked non-durable, it indicates that messages will not be resent on the configured topic or queue, if the JMS server goes down.
Session Reference	Every adapter can have one or more sessions configured for it. Sessions encapsulate stateful connections to TIBCO Rendezvous and other messaging sources. The session object shown in this field is initially supplied by the adapter, depending on the Quality of Service selected. You can change the session by browsing for it in the project panel.
Endpoint Reference	You can drag a different endpoint, browse for another endpoint resource, go to the referenced endpoint to edit its properties or delete the endpoint. Endpoint reference objects are explained in TIBCO Designer Palette Reference.

The semantics for these fields are more complex than the explanation given here. See TIBCO Enterprise Message Service User’s Guide for more information.

Schema View Tab

The Schema View tab contains the fields listed in Table 19, Field Description of Schema View Tab (Sheet 1 of 3).

Table 19 Field Description of Schema View Tab

Field	Description
Base DN	Displays the selected Base DN (Distinguished Name) of a specified node. To display the Base DN, click the Browse DIT... button and then select the required node from the DIT. When the length of an object class name that is fetched from the Base DN field exceeds 128 characters, the ActiveEnterprise schema created with this name affects the runtime functionality. When you click the Apply button, a dialog box (Figure 12) is displayed that prompts you to enter a shorter name that can be stored in the schema. The name you enter must be unique and less than 128 characters. If the service has been configured with a long schema name, the dialog box will not display if a service has already been configured for the same object class.
Select Object Classes From	There are two methods you can use to select an object class: • Sample Entry — You can specify a sample entry so that the object class for that entry is populated in the Objectclasses field. • LDAP Schema — You can specify an object class by selecting it from the LDAP schema on the ldap server.
Sample Entry	This field is available only if you select the Sample Entry radio button for the Select Object Classes From field. In your LDAP server, you can specify an entry from the schema you will use for this service. The service will only handle entries with identical object classes. To specify a sample entry for the schema, click the Browse DIT... button and then select the required node from the DIT. This generates the class reference needed for the service, in the Objectclasses field.
LDAP Schema Classes	This field is available only if you select the LDAP Schema radio button for the Select Object Classes From field. To select the LDAP schema classes for the service, click the Browse Schema button and select the object classes from the Available Objectclasses list. This generates the class reference needed for the service, in the Objectclasses field.
Maximum Number Of Entries	Click the Browse DIT... button for the Base DN or Sample Entry fields to access the Maximum Number of Entries field. This field is available in the Select Base DN and Select Sample Entry for Schema dialog boxes. Specify the maximum number of entries that you want to restrict the service to. The DIT expands only if the number of entries is equal to, or less than the value you specify. You cannot specify a value greater than 50000 as the maximum number of entries. If you need to select a node within a subtree that has more than 50000 entries, you must specify the DN, in the DN (Base DN/Sample Entry) box. You may come across the following exceptions: The size of the result exceeds server specific limit and The Number of Descendants for this Node are more than the requested number. Additionally, if you are using the Oracle Directory Server Enterprise Edition, you may come across the exception: The administrative limit on the maximum number of entries to return was exceeded. To proceed, you will need to log on to the server and change the value for the search size limit: • For the Oracle Directory Server Enterprise Edition, click the Configuration tab. Select Database Settings and click the LDBM Plugin Settings tab. Change the value of the Look-through limit entry. While you are in the Configuration tab, select the root of the tree, and click the Performance tab. Change the value for the Size Limit entry too. For further details, see the documentation shipped with the server you are using.
Objectclasses	Displays the object class of the entry specified in the Base DN, or Sample Entry fields, if these have been specified. Otherwise, the value from the LDAP Schema Classes field is displayed. You cannot edit this field.
Handle Any Subset of Configured Object Classes	This field is available if the object class displayed in the Objectclass field is a composite object class. If you select the check box, changes made to any element of the composite object class will be used by the request-response service.

Schema Tab

The Schema tab contains the fields listed in Table 20, Field Description of Schema Tab.

Table 20 Field Description of Schema Tab

Field	Description
Class Reference	Displays the reference to the ActiveEnterprise schema that corresponds to the object class that was configured under the Schema View tab.

Copyright © TIBCO Software Inc. All Rights Reserved