Setting deployment properties for a runtime environment, WebSphere Adapter for Enterprise Content Management

IBM BPM, V8.0.1, All platforms > Authoring services in Integration Designer > Services and service-related functions > Access external services with adapters > Configure and using adapters > IBM WebSphere Adapters > Enterprise Content Management > Configure the module for deployment > Configure the module for inbound processing > Setting deployment properties and generating the service
Setting deployment properties for a runtime environment

The connection properties are initialized to the values that the wizard used, to find objects in the enterprise system. From this screen, you can modify the user information for the module.

This task is performed using the Specify the Service Generation and Deployment Properties window of the external service wizard.

To generate artifacts for your module, follow this procedure:

Procedure

Optional: In the Specify the Service Generation and Deployment Properties window, click Edit Operations to modify the name, or add a description to the operation to be generated.
Figure 1. Specifying the service generation and deployment properties window

In Deployment Properties, specify how you want the adapter to connect to the CMIS server by selecting any one of these authentication methods.

To use a J2C authentication alias, click Using an existing JAAS alias (recommended) and type the name of the alias in the J2C authentication data entry field.
You can either specify an existing authentication alias or create one at any time before deploying the module. The name is case-sensitive and includes the node name.
To use the security properties from the managed connection properties, click Using security properties from the activation specification and enter the following information:

In the User name field, type the user name to connect to the CMIS server.
In the Password field, type the password to connect to the CMIS server.
The security properties are not encrypted and stored as plain text.

To use any other method of authenticating to the CMIS server, click Other.

In the Deploy connector project field, specify whether to include the adapter files in the module. Select one of the following values:

With module for use by single application: With the adapter files embedded in the module, you can deploy the module to any application server. Use an embedded adapter when you have a single module using the adapter or if multiple modules need to run different versions of the adapter. Using an embedded adapter enables you to upgrade the adapter in a single module without the risk of destabilizing other modules by changing their adapter version.
On server for use by multiple applications: If you do not include the adapter files in a module, install them as a stand-alone adapter on each application server where you want to run the module. Use a stand-alone adapter when multiple modules can use the same version of the adapter and you want to administer the adapter in a central location. A stand-alone adapter can also reduce the resources required by running a single adapter instance for multiple modules.

If you selected the On server for use by multiple applications value in the previous step, specify how you want to set the connection properties at run time.

If you manually created and configured an activation specification on the server or if you have deployed an application that connects to the same CMIS server using the activation specification properties, you can reuse the activation specification by specifying the name of its Java™ Naming and Directory Interface (JNDI) data source:

From the Connection settings list, select Use predefined connection properties.
In the JNDI Lookup Name field, type the name of the JNDI data source for an existing managed connection factory or activation specification.

Click Next.

If this is the first application that connects to the database with a specific user name and password, or if you want to administer the user name and password separately from other applications, select Specify connection properties.

In Connection Properties, review and if necessary, change the values of the required connection properties. The fields are initialized with the connection information you specified when you started the wizard.

In CMIS connection information, change the values of the required connection properties.

In the Connection field, select the connection protocol from the following options: http or https.
In the Server field, specify the server name or IP address of the CMIS end point.
In the Port number field, select the appropriate port number or enter the port number.
In the Path field, specify the context root.
In the Object service endpoint URL field, you can update the URL to perform ID-based Create, Retrieve, Update, Delete operations on Objects in a Content Management Repository. The default content in this field is the CMIS server URL followed by /ObjectService.

For example, http://filenet-p8:9081/fncmis/ObjectService
In the Navigation service endpoint URL field, you can update the URL used to traverse the folder hierarchy in a Content Management Repository, and to locate Documents that are checked out. The default content in this field is the CMIS server URL followed by /NavigationService

For example, http://FileNet-p8:9081/fncmis/NavigationService

In FileNet P8 connection information for subscriptions management, review and if necessary, change the values of the required connection properties. The fields are initialized with the FileNet connection information you specified when you started the wizard.

In the Endpoint URI field, you can update the URI of the end point.

For example, http://FileNet-p8-CDL:9080/wsi/FNCEWS40MTOM
In the JAAS stanza field, enter the JAAS stanza details.

For example, FileNetP8WSI
In the User name field, enter your Administrator (user name) information. You must have Administrator privileges to create and update subscriptions.
In the Password field, enter the password for your FileNet Content Engine connection.

In Event folders information, specify the folder details.

The Events Folder field is automatically populated by with the appropriate event.
In the Failed event folder field, enter the folder name designated for failed events, during the FileNet Content Engine configuration. Ensure that this folder exists on the CMIS server instance.
Example: /FailedEventFolder

Optional: Specify advanced properties by clicking Advanced. Expand each of the advanced sections to review the properties.

Event polling configuration

In the Interval between polling periods (milliseconds) field, type the number of milliseconds that the adapter waits between polling periods.
In the Maximum events in polling period field, type the number of events to deliver in each polling period.
To specify the time interval between attempts to connect to the CMIS server if a connection fails, set Time between retries in case of system connection failure (in milliseconds) to a value in milliseconds.
To specify the number of connection exceptions during the inbound operation, set Maximum number of retries in case of system connection failure to a value greater than or equal to 0.
Select the Stop the adapter when an error is encountered while polling check box, to stop polling when a polling error occurs. If you do not select this option, the adapter logs an exception and continues to run.
Select the Retry EIS connection on startup check box, if you want the adapter to continue trying to connect to a system to which it could not connect during startup.

Select the calendar based scheduling option to create calendar based polling for inbound activities.
You can schedule your business activities, when you create a new calendar in IBM Integration Designer. The option of working with the calendar based scheduling feature is only possible with IBM Integration Designer as the tooling environment. The following figure helps you to schedule a calendar polling option.
Figure 2. Polling based on business calendar

You can either select a blank calendar or create a new calendar for a module or library.
When you select a blank calendar, you will not be able to set predefined time intervals. You have to define your time intervals. When you create a calendar using a predefined template, you can define time intervals for each template.

To select an existing calendar for a module or library, click Browse. In the Select a Business Calendar window, you can search for existing calendar files ( *cal) in the IBM Integration Designer workspace.

In the Filter by name field, type the calendar name or name pattern. The calenders matching the pattern are displayed in the Matching business calendars area.
Select a calendar and click OK to return to the external service wizard.

To create a new calendar entry for a module or library, click New. The Create a business calendar window is displayed.

In the Module or library field, click Browse to select an existing calendar module or click New to create a module for the new calendar.
In the Folder field, click Browse to select an existing folder or create a new folder for the calendar.
In the Name field, enter a name for the new calendar.

To create a non template calendar, click Finish. Or
To generate the calendar based on a predefined template, click Next. In the Use a template window, select the Create a calendar using one of the templates check box and click Finish.

The new business calendar is created and available in the Business Integration view. Once you complete the wizard, you can view or modify the calendar schedules in the Business Integration view using the Business Calendar Editor. You can modify the intervals and exceptions, or add new entries for these elements. For more details about working with business calendars, see Business calendars.

You must deploy the Business Calendar module to the same IBM BPM or WebSphere Enterprise Service Bus instance, along with the inbound application. If you do not map these two connections to the same server instance, the inbound application using the business calendar will by default, poll as there is no calendar configured.

Event delivery configuration
Figure 3. Event delivery configuration property

In the Type of delivery field, select the delivery method.
If you want to ensure that events are delivered only once and to only one export, select Ensure assured-once event delivery . Although this option might reduce performance, it prevents duplicate or missing events.
By default, the adapter processes all events that it finds when it polls. If you do not want it to process events that have timestamps later than the current time, select Do not process events that have a time stamp in the future.
To set the number of attempts to connect to the CMIS server if a connection fails, specify a value in the Retry limit for failed events field.
To set the number of connections for event delivery during the inbound operation, specify a value greater than or equal to 1 for the Minimum and Maximum fields. Any value less than 1 is treated as 1 by the adapter.

Processing methods for illegal XML characters
Figure 4. Processing methods for illegal XML characters property

From the Illegal XML character processing drop-down list, select one of the options that correspond to your requirement:

Do not validate illegal XML characters, if you want to work with the default adapter behavior.
If you select the Do not validate illegal XML characters option, the adapter displays an exception as the Enterprise Content Management server does not support illegal characters.
Throw exception if contents in the BO contains illegal XML characters, if you want to proceed after you get an exception message, and log the illegal XML characters in the trace file, at runtime.
Discard all illegal XML characters and related logs, if you want the adapter to discard the illegal XML characters, and log the characters in the trace file, at runtime.

In the Bidi properties area, select Bidi transformation. Set the ordering schema, text direction, symmetric swapping, character shaping, and numeric shaping properties to control how bidirectional transformation is performed.
Event persistence properties
Figure 5. Event persistence properties

To ensure that events are delivered once, and only once, to the export in the case of a failure, set the event persistence fields.

Select the Auto create event table check box, to create the event persistence table automatically.
In the Event recovery table name field, enter the name of the table used by the adapter for event persistence processing.
In the Event recovery data source (JNDI) name field, enter the JNDI name of the data source used by event persistence processing to obtain the JDBC database connection. The data source must be created in IBM BPM.
In the User name field, enter your database user name.
In the Password field, enter your password.
In the Database schema name field, enter the name of the database used by event persistence processing.

Logging and tracing
Figure 6. Logging and tracking property

If you have multiple instances of the adapter, enter a value in the Adapter ID that is unique for this instance.
You can select the Disguise user data as 'XXX' in log and trace files check box to prevent sensitive user data from being written to log and trace files.

Click Next.

Results
The Specify the Location Properties window is displayed.

What to do next
Continue working in the wizard. The next step is to specify the location properties for artifacts.

Setting deployment properties and generating the service

Related concepts:

User authentication

Related reference:

Resource adapter properties
Globalization