JDBC-Based SmartMapper Service

The JDBC-Based Service accesses a JDBC database to manage cross-referencing data. This service runs inside a TIBCO ActiveMatrix BusinessWorks engine and uses a JDBC driver to read and write data to a database.

Three databases are supported, MySQL, SQL Server, and Oracle. Besides if you want to use MySQL or Oracle, you are required to add the official drivers. See TIBCO ActiveMatrix BusinessWorks Plug-in for SmartMapper Installation for more details.

Note: If you assign two (or more) SmartMapper ER Models to the same database, you are required to configure each to use a different user account to prevent the tables from collision.

Configuration Tab

The Configuration tab contains the following fields.

Field Module Property? Description
Name No The name to be displayed as the label for the storage service.
Active No Select the check box to set this storage service as active, only one storage service can be active among many.

JDBC Settings Tab

The JDBC Settings tab contains the following fields.

Field Module Property? Description
Database No The database type. Select the database that you want to use as the storage from the list.
JDBC Driver Class Yes The fully-qualified java class name of the JDBC driver. The class name is given automatically when you select your database type.
Note: Only three driver names are supported in JDBC-Based SmartMapper Service:
  • For MySQL databases: com.mysql.jdbc.Driver
  • For Oracle databases: oracle.jdbc.OracleDriver
  • For SQLServer databases: com.microsoft.sqlserver.jdbc.SQLServerDriver
JDBC URL String Yes The appropriate URL string for the driver.
User Yes The database user name.
Password Yes The database password.
Connection Pool Size Yes This value determines the maximum number of connections available in the pool. TIBCO ActiveMatrix BusinessWorks Plug-in for SmartMapper database access always uses connection pooling.
Login Timeout (sec) Yes The amount of time in seconds before the login attempt times out.
Test Connection No The validation of the database connection. Click Test Connection to validate the specified database connection.
Sync ER Model w/DB No

The synchronization process creates new database tables. The database user specified in the User field needs to have 'create table' privileges.

At run time, the SmartMapper activity does not create any new database tables and hence you are not required to have those privileges for running the activities.

Currently, TIBCO ActiveMatrix BusinessWorks Plug-in for SmartMapper requires that the user who runs activities is the same user who has done the synchronization and created the tables.

See Synchronizing SmartMapper ER Model regarding the Synchronization.

Caching Tab

The Caching tab contains the following fields.

Field Module Property? Description
Enable Caching No Select to enable caching. Clear to disable caching.
Cache Type No Select a caching type from the list. Two types are available:
  • LOCAL: stores the caching data to a local memory.
  • ACTIVESPACES: stores the caching data using TIBCO ActiveSpaces.
Note: To use TIBCO ActiveSpaces caching, ensure TIBCO ActiveSpaces is installed. Besides, add corresponding ActiveSpaces libraries to your system environment variables, see Adding ActiveSpaces Library into Environment Variables for more details.
The following fields are available when Local is selected in the Cache Type field.
Maximum Number Of Entries Yes The maximum number of entity instances to be stored in the cache.

If the number of entity instances exceeds the specified number, the excess cache entries are culled from the cache using a least-recently-used algorithm.

Note: The value must be a positive integer, and it is not accurately equal to the numbers of the returned data generally.
Cache Synchronization Interval (sec) Yes The time interval, in seconds, that cache housekeeping is performed.
Note: The value must be a positive integer.
The following fields are available when ActiveSpaces is selected in the Cache Type field.
Metaspace Name Yes Specify the name of the metaspace to connect to.
Discovery URL Yes Specify the discovery URL to use to discover each metaspace.
Note: Do not use the Rendezvous protocol in the discovery URL.
Listen URL Yes Specify the URL to use to listen for the incoming connections from new members to the metaspace.
Relationship Capacity Yes Specify the maximum number of relationship instances per seeder for the space.

If the number of relationship instances exceeds the specified number, the relationship instances that are not frequently used are deleted.

Note: When the value is -1, the capacity is set to infinite.
Replication All No Specify whether to replicate all the relationship data or not. Selecting this check box means that all the relationship data are replicated on all the seeders.
Distribution Role No Select the distribution role for a newly joined member from the following options:
  • SEEDER: the new member plays an active role in maintaining the space by providing CPU and RAM.
  • LEECH: the new member plays a passive role which has access to space data but provides no resources.
Note: If you want to use LEECH as distribution role, make sure there is an as-agent that already joined metaspace, or a "No Enough SEEDER" error occurs.
Export No Generates an XML file, which includes the ActiveSpaces parameters of all the entities and relationships in this ER Model.