Notes DB - Configuration (Magic xpi 3.x)
The Notes DB connector lets you access the IBM Lotus Notes database. It supports XML interfaces only, and cannot be used as a trigger.
When you click the Configuration button in the Component Properties dialog box the Notes DB Configuration dialog box appears. The dialog box contains the following properties:
|
|
Connection
|
Resource Name
|
The name of the resource, previously defined in the Resource Repository, that you selected in the Component Properties dialog box's Settings tab.
|
Operation
|
Operation
|
A combo box with the following options:
-
Query (default)
-
Add
-
Update
-
Delete
-
Global Query – The result of running the general query is a list of documents. In Lotus Notes every entity is a document. For example: an email is a document and a contact is a document, so both can be part of a global query result even though their fields are totally different. Because of that, it is not possible to generate a general schema that represents all Notes documents. When using the Global Query option, it is the user's responsibility to generate a schema based on the expected documents result.
You first select the operation and based on the operation select either a view in case of Query, or a form in case of Add, Update, and Delete. In Global Query neither of these options is available.
Note:
|
Multiple operations are not available in this version of Magic xpi.
|
|
Form/View
|
Click to open the Views List, for Query operations, or the Forms List for Add, Update or Delete operations.
|
Attachments Support
|
For Global Query operations, select one of the following from the drop-down list:
-
No – No attachment is returned.
-
Part of result XML – Attachments are returned as a base64 block.
-
Save to Directory – The attachments are saved to a specified folder.
Since version: V3.1
|
Result
|
Store result in
|
Defines where you want to store the resulting XML file. Select one of the following from the drop-down list:
-
File – Select a file to hold the object data that is returned by Notes DB. Click to open the Expression Editor or click and enter the file path where this information is to be stored.
-
Variable (default is C.UserBlob) – Select a variable to hold the object data that is returned by Notes DB. Click to open the Variables List. Select a variable where this information is to be stored.
|
The Notes DB Configuration dialog box contains the following additional button:
|
|
Refresh XSD
|
Refreshes the current schema.
When you click Refresh XSD, the current schema is overwritten. A message dialog opens, and clicking OK confirms the update and the overwrite. Clicking Cancel exits the process without updating the schema.
|
To use the Notes DB component:
-
From the Project menu, select Resources to open the Resource Repository. Here, you should define a Notes DB resource. This allows you to create the required connections to Notes databases. For more information on how to do this, click here. You cannot continue with the next step until you have done this.
-
Click the Component Properties dialog box's Settings tab. In the Resource Name field, select one of the resources that you previously defined in the Resource Repository.
-
Click Configuration to open the Notes DB Configuration dialog box. Enter the relevant information.
-
Click OK to save the information and to exit the Notes DB Configuration dialog box, or click Cancel to exit without saving.
-
Click OK to save the information and to exit the Component Properties dialog box, or click Cancel to exit without saving.
Notes DB - Mapping
Notes DB - Error Handling