Retrieving a Domino document

Using the Retrieve Activity, you can retrieve a document from a Domino® database. Each retrieved document is uniquely identified by its UniversalID or NotesID. The retrieval is done based on the input, that is, either the UniversalID or the NotesID.

Using the retrieve activity

  1. Right-click Orchestration in the Project pane and click New Orchestration to create or open an orchestration. The orchestration pane is displayed.
  2. Select the Activities tab and expand the Domino folder.
  3. Drag Retrieve Activity from the Domino folder onto the orchestration. A graphical representation of the orchestration along with the Checklist is displayed.
  4. The Checklist pane lists the tasks(Summary, Pick Endpoint, Configure, Map inputs, Map outputs) that you must perform to complete the configuration of the outbound activity.
  5. Click Pick Endpoint, and then select a Domino endpoint.

    For instructions on creating or editing a Domino endpoint, see Creating or editing an endpoint for a Domino activity.

  6. Click Configure from the Checklist. The Configure pane is displayed.
    • Click Browse to select an existing database from the Browse Domino databases pane. The Browse Domino databases display all the databases for the selected endpoint.
    • Click Next to select an existing form from the Browse Domino Forms pane. The Browse Domino Forms displays all the forms present in the selected database of the Domino server.
      Note: The Next button is enabled only after you select the database name.
    • Fields with canonical names accept fields that may have canonical names such as John Smith/IBM/COUNTRY as values, which are separated by commas. Specify the canonical names in this field if you want to convert the values in these fields to internet mail addresses, such as johnsmith@country.ibm.com. Some of the field name examples are To, From, CC, Chair, Required Attendees, and so on.

Specifying the map inputs for the retrieve activity

The input parameter for Retrieve activity is either UniversalID or NotesID. When both are given, UniversalID is used to retrieve the Domino document.
  1. Click Map Input from the Checklist pane.
    The input parameters for the specific Domino activity are displayed under the To Activity pane. Some of the common input parameters are defined in the following table.
    Parameter Name Description
    UniversalID The UniversalID parameter is a read/write property that uniquely identifies a document across all replicas of a database. In character format, the unique ID parameter is a 32-character combination of hexadecimal digits (0-9, A-F). The UniversalID is also known as the unique ID or UNID. The data type is string.
    NotesID The Notes® ID of a document is a read only property and has a hexadecimal value of up to 8 characters, which uniquely identifies a document within a particular database. The Notes ID represents the location of a document within a specific database file. So the documents that are replicas of one another generally have different Notes IDs. A Notes ID does not change, unless the document is deleted.
    Note: You must map the input parameters of the activity.

For Form Types that are same across multiple databases, you can now specify the database name as part of the optional parameters in map inputs, wherein the same orchestration can be used to perform outbound operations on different databases. To do this, you must specify the database name in the databaseName optional parameter (described in Table 1). If the databaseName parameter is populated with a value, the outbound operation is performed on the database specified in the databaseName parameter. If there is no value specified, the database name that is specified during configuration is used to perform the outbound operation.

Optional parameters
The optional input parameter is described in the following table:
Table 1. Optional parameters
Parameter name Description
databaseName databaseName is the name of the database from which the document is retrieved. If a value is set for this parameter, then the value of the database in the configure panel is overwritten. This parameter is useful when documents with the same structure (Form) must be retrieved from multiple databases, using the same orchestration.
The Domino connector also supports dynamic endpoint connection to a different Domino server. During run time, if you want to dynamically connect to a Domino server other than the one that is configured in the endpoint page, add the new optional parameters in dominoConnectionProperties of map inputs. The parameters of dominoConnectionProperties are described in the following table:
Table 2. Optional connection parameters
Parameters Description
dominoConnectionProperties parameters
hostName Specifies the host name or IP address of the machine on which Domino server is running.
diiopPort Specifies the Domino Internet Inter-ORB Protocol (DIIOP) port that allows Java™ applets or applications to access Domino data remotely using CORBA. The default value is 63148.
username Specifies the user name to connect to the Domino server.
password Specifies the password that is associated with the user name to connect to the Domino server.
connectionPool parameters
minimumConnections Specifies the lowest number of Domino server connections that the Integration Appliance keeps open in the connection pool. Entering 0 (zero) is supported. The default value is 5.
maximumConnections Specifies the maximum number of Domino server connections that the Integration Appliance can keep open in the connection pool. Entering 0 (zero) means the maximum number of connections is unbounded. The default value is 25.
maxIdleTime Specifies the amount of time in minutes that a Domino server connection can be open in an idle state before being closed by the Integration Appliance. Entering 0 (zero) means that the connections are closed when they are returned to the pool —no idle time. The default value is 120 minutes.
maxWait Specifies the amount of time in seconds that the Integration Appliance waits for a connection when all the connections in the pool are exhausted. If no connection is obtained after the wait time, an exception is thrown. The default value is 300 seconds.
reclaimConnections Specifies the interval at which the connector checks for idle connections. Idle connections are reclaimed until the minimum number of connections is reached, as specified in the Minimum Connections parameter. The default value is 5 minute.

Specifying the map outputs for the retrieve activity

  1. Click Map output from the Checklist pane.

    The output parameters for the Domino activity are displayed under the From Activity pane.

    Note: You can map the output parameters of the activity that is based on your requirement.
    Note: Dynamically added fields present in the Domino document and not generated in the map input/output structures are handled by the Domino connector. While retrieving documents using this activity, the data for these fields are available in the map outputs section under AdditionalFields.



Feedback | Notices


Timestamp icon Last updated: Thursday, December 17, 2015


http://pic.dhe.ibm.com/infocenter/wci/v7r0m0/topic/com.ibm.wci.doc/Domino_retrieve_outactivity.html