Concurrent Processing Framework

Configuring CPF

The following sections describe how to configure the CPF.

• Configure any CPF Configuration Properties.
• Add the administration users to the CPF_ADMIN User Group.

Adding Modules

The following sections describe how to manage users, groups and permissions the CPF.

• Add a new Module.
• Configure any Module Configuration Properties documented in the plug-ins readme.
• Configure any Business Application Configuration Properties documented in the plug-ins readme.
• Add the module administration users to the Module Admin User Groups.
• Add users to the Module User Groups documented in the plug-ins readme.
• Add any User Group Permission documented in the plug-ins readme.

Security

The following sections describe how to manage users, groups and permissions the CPF.

• View and manage User Accounts.
• View and manage [User Groups](#User Group).
• View and manage User Group Permission.

Monitoring

The following sections describe how to monitor the CPF.

• View Module Status.
• View and manage Batch Jobs.
• View Dashboard Statistics.
• View Workers, Module Status and Worker Executing Group List.
• View Log Files

Module Overview

The business application plug-ins are deployed to CPF as Maven Modules. For each plug-in a new Module is created in the admin application that specifies a module name and maven module id.

The CPF then automatically downloads the Maven Module from the maven servers when the module is started. TheCPF caches modules in the local Maven Repository Cache Directory. More details on plug-in modules can be viewed in the Plug-in Developers Guide.

In addition to the module administration pages described here the following pages describe how to manage items related to a module.

• Business Application
• Configuration Property
• Dashboard Statistics
• Business Application Jobs
• Module User Groups
• Module Admin User Groups
• User Group Permissions
• Module Configuration Properties

NOTE The user must be in the ADMIN, ADMINMODULE[MODULE_NAME]_ADMIN, or ADMINMODULE[MODULE_NAME]_SECURITY groups to manage modules. Module admins will only see modules they are admins for.

Module List

The modules page contains a scrolling table of the modules. The contents of this table can be filtered by typing at least 3 characters in search box. The table will show modules where the name, maven module id, status, or start time contain those characters characters (ignoring case).

1. Open the CPF Admin Application (e.g http://localhost/cpf/admin/).
2. Click the 'Modules' menu item.

View Module

Modules can be viewed using the following steps.

1. Open the Module List page.
2. Scroll or search for the module.
3. Click the link in the Name column.

Add Module

New modules can be added using the following steps

NOTE The user must be in the ADMIN group to add modules.

1. Open the Module List page.
2. Click Add button.
3. Edit the field values.
   1. Enter a Module Name.
      • Must be unique across all module names.
      • Can only contain the characters a-z, 0-9, or _.
      • Automatically converted to upper case.
      • Must not be one of the reserved words CPF, VIEW, EDIT, ADD, DELETE, APP, ADMIN, DEFAULT, COPY, CLONE, MODULE, GROUP.
   2. Enter the Maven Module Id.
   3. Select if the module is to be enabled.
4. Click the Save button to create the module, Clear Fields to undo any changes, or Cancel to return to the previous page.

Delete Module

A module can be deleted using the following steps.

NOTE The user must be in the ADMIN group to delete modules.

NOTE This will permanently delete the module, module configuration properties and module user groups. It will not delete any jobs for business applications in the module. Any uncompleted jobs will not complete unless the module is added again. To update a module to a new version edit the module rather than deleting and adding a new module.

1. Open the Module List or View Module page.
2. Click trash button in the Actions field for the module to delete.
3. Click the OK button on the confirm delete dialog to delete the module, or Cancel to return to the page.

Edit Module

Modules can be edited using the following steps. only the Maven Module Id and enabled flag can be edited.

NOTE The user must be in the ADMIN group to edit modules.

NOTE Editing a module will cause an immediate restart of the module on the master and all workers.

1. Open the View Module page.
2. Click the Edit button.
3. Edit the field values.
   1. Enter the Maven Module Id.
   2. Select if the user is to be enabled.
4. Click the Save button to save changes, Revert to Saved to undo any changes, or Cancel to return to previous page.

Start Module

A module can be started using the following steps.

NOTE The user must be in the ADMIN group to start modules.

NOTE Starting a module will cause an immediate start of the module on the master and all workers.

1. Open the Module List or View Module page.
2. Click restart button in the 'Actions' field for the module to start.
3. Click the OK button on the confirm dialog to start the module, or Cancel to return to the page.

Restart Module

A module can be restarted using the following steps.

NOTE The user must be in the ADMIN group to restart modules.

NOTE Restarting a module will cause an immediate restart of the module on the master and all workers.

1. Open the Module List or View Module page.
2. Click restart button in the 'Actions' field for the module to restart.
3. Click the OK button on the confirm dialog to restart the module, or Cancel to return to the page.

Stop Module

A module can be stopped using the following steps.

NOTE The user must be in the ADMIN group to stop modules.

NOTE Stopping a module will cause an immediate stop of the module on the master and all workers.

1. Open the Module List or View Module page.
2. Click stop button in the 'Actions' field for the module to stop.
3. Click the OK button on the confirm dialog to stop the module, or Cancel to return to the page.

Business Application Overview

Each CPF Module can contain one or more business application. This page describes how to manage those business applications.

In addition to the business application administration pages described here the following sections describe how to manage items related to a business application.

• Dashboard Statistics
• Config Properties
• Batch Jobs

NOTE: The user must be in the ADMIN, or ADMINMODULE[MODULE_NAME]_ADMIN groups to manage business applications. Module admins will only see business applications they are module admins for.

hasRole('ROLE_BCGOV_INTERNAL')

hasAnyRole('ROLE_BCGOV_INTERNAL','ROLE_BCGOV_BUSINESS')

hasRole('ROLE_BCGOV_INTERNAL') or hasRole('ROLE_BCGOV_BUSINESS')

hasRoleRegex('ROLE_BCGOV_.*')

Business Application List

The business applications pages contain a scrolling table of the business applications for a module. The contents of this table can be filtered by typing at least 3 characters in search box. The table will show business applications where the name, module or title contain those characters characters (ignoring case).

View Business Application

Business Applications can be viewed using the following steps.

1. Open one of the Business Application List pages.
2. Scroll or search for the business application.
3. Click the link in the 'Name' column.

Edit Business Application

Business Applications can be edited using the following steps.

NOTE: Editing a business application will require a manual restart of the module for the settings to take affect.

1. Open the View Business Application page.
2. Click the Edit button.
3. Edit the field values.
   1. Log Level
   2. Test Mode Enabled
   3. Batch Mode Permission
   4. Instant Mode Permission
   5. Max Requests Per Job
   6. Max Concurrent Requests
   7. Num Requests Per Worker
4. Click the Save button to save changes, Revert to Saved to undo any changes, or Cancel to return to previous page.

Configuration Property Overview

The CPF master web application, CPF workers and modules can be configured by setting config properties.

Configuration Property List

The configuration properties page contains a scrolling table of the configuration properties. The contents of this table can be filtered by typing at least 3 characters in search box. The table will show configuration properties where the environment name, module name, property name, or property value contain those characters characters (ignoring case).

View Configuration Property

Configuration properties can be viewed using the following steps.

1. Open one of the Configuration Property List pages.
2. Scroll or search for the configuration property.
3. Click the link in the ‘ID’ column.

Add Configuration Property

Configuration properties not shown in the list can be added using the following steps. See

CPF Master and CPF Workers for the supported configuration properties. Consult the plug-in’s documentation for the configuration properties they support

1. Open one of the Configuration Property List pages.
2. Click Add button.
   1. Edit the field values.
   2. Click the Save button to create the configuration property, Clear Fields to undo any changes, or Cancel to return to the previous page.

Delete Configuration Property

A configuration property can be deleted using the following steps.

1. Open one of the Configuration Property List or View Configuration Property pages.
2. Click trash button in the 'Actions' field for the configuration property to delete.
3. Click the OK button on the confirm delete dialog to delete the configuration property, or Cancel to return to the page.

Edit Configuration Property

Configuration properties can be edited using the following steps.

1. Open the View Configuration Property page.
2. Click the ‘Edit button’.
3. Edit the field values.
4. Click the Save button to save changes, Revert to Saved to undo any changes, or Cancel to return to previous page.

Configuration Property Names & Descriptions

This section describes the configuration properties used for the CPF master web application and CPF workers.

The CPF uses [Java Properties](http://docs.oracle.com/javase/7/docs/api/java/util/Properties.html#load(java.io.Reader)) files for bootstrap configuration of the CPF master web application and CPF workers. In the properties files use ‘=’ not ‘:’ between the keys and values and escape any ‘:’ characters in property values using ‘:’. Properties with a tick in the ‘Admin App’ column can also be defined using the admin application.

NOTE: Any changes to configuration properties using the admin application or in the properties file will require the CPF master or CPF worker to be restarted for these properties to take affect.

CPF Master Configuration Properties

The CPF master web application requires the following properties to be defined in the /apps/config/cpf.properties file. The master will ignore any other properties in this file. So where the master and worker are on the same machine they can share the same configuration file.

Property Name	Description	Admin App	Data Type	Example
cpfConfig.baseUrl	The HTTP URL to the OAuth/Digest secured CPF web services, including context path on the server cpf is deployed to. The trailing / must be omitted.		URI	http://localhost/cpf/
cpfDataSource.url	The JDBC URL to the cpf database.		URI	jdbc:oracle:thin:@localhost:1521:cpf or jdbc\:postgresql\://localhost\:5432/cpf
cpfDataSource.password	The password for the PROXY_CPF_WEB user account.		String	cpf_2009
batchJobService.maxWorkerWaitTime	The maximum time (in seconds) the worker will wait in a HTTP request for group to process before trying a new HTTP request. This limits the number of polling requests to the server. Must be less than any HTTP server inactivity timeouts.		int	100
batchJobService.fromEmail	The email address any emails will be sent from.		String	cpf@localhost
mailSender.host	The mail server to send emails via.		String	localhost
removeOldBatchJobs.daysToKeepOldJobs	The number of days that jobs will be kept after the results have been created. After that time the jobs will be removed in the next daily cleanup.		int	7

CPF Worker Configuration Properties

The CPF worker web application requires the following properties to be defined in the /apps/config/cpf.properties file. The worker will ignore any other properties in this file. So where the worker and master are on the same machine they can share the same configuration file.

Property Name	Description	Admin App	Data Type	Example
cpfConfig.internalWebServiceUrl	The HTTP URL to the CPF web services behind any reverse proxies. This is used to speed up access from the workers.		URL	http://localhost/pub/cpf
cpfWorker.password	The password for the cpf_worker user account.		String	w0rk3r
cpfWorker.environmentName	The environment name used for the worker.		String	default
cpfWorker.maximumPoolSize	The maximum number of threads on the worker used to execute requests.		int	32

Master Tuning

The tuning parameters for the master can be viewed using the 'Tuning' page (e.g. http://localhost/cpf/admin/tuning/). The tuning page shows the number of active threads or connections, the current pool size, largest pool size reached, and the maximum pool size. The maximum pool sizes can be configured using the Config button. Changes to the pool sizes will be applied upon saving. If the current active count is greater than the new pool size then those active threads or connections will still be used until they are returned to the pool.

The table below shows the thread and database connection pools that can be configured to tune the system.

The size of the thread pools will depend on the number of processor cores. The example values shown are for a 4 processor system, each processor with 4 cores. This gives a total of 8 cores (2 * 4).

The number of threads configured for the CPF thread pools can exceed the number of cores available on the server. In this case the operating system will schedule the different threads for execution. For processes that are I/O bound (network connections, database calls, or file I/O) the thread will be paused when the I/O operation is blocked. This allows other threads to execute. For I/O bound tasks the number of connections in the pool can be increased to take advantage of the idle time during blocked I/O operations. In the examples this is indicated as the thread multiplier.

NOTE: the other load on the server should also be considered when defining the size of the pools. The first factor is the number of threads that the servlet container is configured for serving HTTP requests. These connections will consume additional database connections for the CPF web service and CPF admin requests. Also if the database is on the same server then less threads will be available for the CPF.

NOTE: The exact values for a specific system will need to be defined by experimenting with typical workloads for the business application and server hardware configurations.

Worker Tuning

The CPF worker has a single tuning property cpfWorker.maximumPoolSize. This defines the number of threads used to process groups of requests. The value for this property should be about the same as the Group Result Pool Size on the CPF master. Although if the groups take a lot longer to execute than it takes to save the results on the master then this value can be greater (e.g. 2x or 5x) than the Group Result Pool Size.

If the business applications are processor rather than I/O bound then the pool size can be reduced to avoid processor thrashing when switching between threads.

NOTE: the worker pool size can only be configured in the properties file. See CPF Worker Configuration Properties to set the cpfWorker.maximumPoolSize.

Application Tuning

The final part of tuning is the application tuning. See Business Application Fields to see the full description of the application tuning parameters and how to edit them.

The first parameter numRequestsPerWorker controls the number of requests bundled into an execution group to send to the worker. The group size should be configured for business applications that only take milliseconds to process each request. In this case the value can be set to about 100 so that the group execution time takes 1-5 seconds. This reduces the communications overhead per request due to bundling into a group. The value should not be set to large as it will then result in more memory when the group is scheduled and for storage in the database. This could slow down the scheduler.

NOTE: This value is applied at the time a job is created and can’t be changed for that job afterwards. New jobs get the new group size.

The second parameter maxConcurrentRequests controls how many groups for the business application can be scheduled at one time. The actual limit for the concurrent groups executing will depend on the number of threads specified in cpfWorker.maximumPoolSize. For slow business applications this can be used to limit the number of concurrent groups so that it does not prevent other apps from being processed. For fast business applications this could be configured to be greater than the pool of threads on the worker. This has the affect of pre-loading the scheduling queue so that work is ready for the worker as soon as the previous group results are finished.

User Account Overview

The CPF maintains a table of user accounts. These user accounts are used to authenticate (login) access to the CPF web services and admin application. The user accounts are also used to assign users to user groups.

NOTE: The master and worker for a given user may cache user accounts, user groups and user group permissions for up to 5 minutes. Wait 5 minutes if the user doesn’t have the correct permissions after a change.

NOTE: The user must be in the ADMIN user group to view the list of all user accounts and to manage user accounts.

User Account Classes

The CPF provides support for multiple classes of user accounts. Developers can add new types of user account class to link in with their existing security mechanisms. By default the CPF is installed with the CPF.

User Account List

The user accounts page contains a scrolling table of the user accounts. The contents of this table can be filtered by typing at least 3 characters in search box. The table will show user accounts where the consumer key, user account class or user name contain those characters characters (ignoring case).

1. Open the CPF Admin Application (e.g http://localhost/cpf/admin/).
2. Click the 'User Accounts' menu item.

View User Account

User accounts can be viewed using the following steps.

1. Open the User Account List page.
2. Scroll or search for the user account.
3. Click the link in the 'Consumer Key' column.

Add User Account

New user accounts can be added using the following steps. Only accounts with the CPF class can be added, therefore the User Account Class field is not shown as it is set to CPF. The created user account’s user name field will be set to the consumer key entered.

1. Open the User Account List page.
2. Click ‘Add’ button.
3. Edit the field values.
   1. Enter a Consumer Key.
      • Must be unique across all consumer keys from all classes.
      • Can only contain the characters a-z, 0-9, and _.
      • Automatically converted to lower case.
   2. Enter a Password. A random UUID password is provided as a default.
   3. Select if the user is to be active.
4. Click the Save button to create the user account, Clear Fields to undo any changes, or Cancel to return to the previous page.

Delete User Account

A user account can be deleted using the following steps. This will also remove the user account from any user group and delete the user’s jobs. For the CPF class deleting accounts is permanent. For BCGOV class this deletes the record, but a new record will be created when the user next accesses CPF.

1. Open the User Account List or View User Account page.
2. Click trash button in the 'Actions' field for the user account to delete.
3. Click the OK button on the confirm delete dialog to delete the user account, or Cancel to return to the page.

Edit User Account

User accounts can be edited using the following steps. For the CPF class the consumer key, consumer secret and active flag can be edited. For the BCGOV class only the active flag can be edited.

1. Open the View User Account page.
2. Click the ‘Edit button’.
3. Edit the field values.
   1. Enter a Consumer Key.
      • Must be unique across all consumer keys from all classes.
      • Can only contain the characters a-z, 0-9, and _.
      • Automatically converted to lower case.
   2. Enter a Password.
   3. Select if the user is to be active.

4. Click the Save button to save changes, Revert to Saved to undo any changes, or Cancel to return to previous page.

User Group Overview

The CPF maintains a table of user groups. The CPF uses user groups to control access to the CPF admin application and for modules to define the permissions end users have to use the business applications.

NOTE: The master and worker for a given user may cache user accounts, user groups and user group permissions for up to 5 minutes. Wait 5 minutes if the user doesn’t have the correct permissions after a change.

User Group List

The user groups pages contain a scrolling table of the user groups. The contents of this table can be filtered by typing at least 3 characters in search box. The table will show user groups where the user group name, module name, description contain those characters (ignoring case).

View User Group

The details of a user group can be viewed from the [User Group List][User_Group_List] pages.

1. Open one of the [User Group List][User_Group_List] pages.
2. Scroll or search for the group to view.
3. Click the link in the ‘User Group Name’ column for the group.

Add User Group

Delete User Group

Only global or module groups can be deleted. All other groups are managed by the system. Deleting a group will permanently delete the group, list of group members and any permissions granted to the group.

Edit User Group

Only global or module groups can be edited. All other groups are managed by the system.

User Accounts for a Group

Each group has the list of the user accounts who are members of that group. The user accounts in the group will inherit any permissions granted to the group. The user accounts for a group can be viewed managed using the following instructions. The exception is the USER_TYPE group, which has implicit members based on the user accounts. The list of user accounts cannot be viewed and managed for those groups.

NOTE: The CPF caches the groups a user is a member of for up to 5 minutes. If adding or removing users from a group wait at least 5 minutes before testing.

User Group Permission

CPF modules can use User Group Permissions to grant permissions for users who are a member of a group permission to perform an action on a resource. Permissions are granted to a User Group for a Module. Cross module permissions are not supported. User group permissions grant the group permission to perform an action (Action Name) on a resource (Resource Class + Resource Id). For example view (Action Name) the reportUrl (Resource Class) http://reports.com/demoReport.json (Resource Id).

NOTE: NOTE: CPF itself does not use user group permissions. Each CPF module can decide if & how they use user group permissions. Consult the module’s readme file for details on the supported resource classes, resource id schemes and action names.

NOTE: NOTE: The master and worker for a given user may cache user accounts, user groups and user group permissions for up to 5 minutes. Wait 5 minutes if the user doesn’t have the correct permissions after a change.

NOTE: The user must be in the ADMIN, ADMINMODULE[MODULE_NAME]_ADMIN, or ADMINMODULE[MODULE_NAME]_SECURITY user groups to view and manage user group permissions for a module.

Batch Jobs Overview

The main purpose of the CPF is to execute batch jobs on behalf of users. The CPF admin application can be used to view the list of jobs in the system and to monitor the progress of the execution of the batch job execution groups.

NOTE: The user must be in the ADMIN, or ADMINMODULE[MODULE_NAME]_ADMIN user groups to view batch jobs. The module admins will only be able to see batch jobs for their modules.

Batch Job List

The batch job list pages contain a scrolling table of the batch jobs. The contents of this table can be filtered by typing at least 3 characters in search box. The table will show batch jobs where the id, business application, start time, modification time, job status, submitted requests, completed requests, failed requests or user id contain those characters characters (ignoring case).

Dashboard Statistics Overview

The CPF collects statistics for all phases of job processing. These statistics are collated for each hour and business application. Statistics are automatically rolled up for each day, month and year.

NOTE: The user must be in the ADMIN, or ADMINMODULE[MODULE_NAME]_ADMIN user groups to view statistics. The module admins will only be able to see statistics for their modules.

The following table shows the statistics that are displayed on the View Statistics pages.

Summary Statistics

The summary statistics page shows the statistics for all business applications the user has admin permission for. The page has tabs for summary statistics for the current ‘Hour’, total for ‘Today’, total for this ‘Month’ and totals for each ‘Year’. To view all time periods use the [Business Application Statistics}(#Business_Application_Statistics) page.

Each tab contains a scrolling table of the statistics. The contents of this table can be filtered by typing at least 3 characters in search box. The table will show statistics where the id, module, business application, jobs submitted, jobs completed, app groups executed, app requests completed, app requests failed contain those characters characters (ignoring case).

The statistics can be viewed using the following steps.

1. Open the CPF Admin Application (e.g http://localhost/cpf/admin/).
2. Click the 'Dashboard' menu item.
3. Click on the Hour, Today, Month or Year tabs to view statistics for those time periods.

Business Application Statistics

The business statistics tab shows the statistics for a business application. The tab has a single list containing all the statistics for the current ‘Hour’, total for ‘Today’, total for this ‘Month’ and totals for each ‘Year’.

Each tab contains a scrolling table of the statistics. The contents of this table can be filtered by typing at least 3 characters in search box. The table will show statistics where the id, duration type, jobs submitted, jobs completed, app groups executed, app requests completed, app requests failed contain those characters characters (ignoring case).

1. Open the View Business Application page.
2. Click the 'Dashboard' tab.

View Statistics

The statistics can view viewed using the following steps.

1. Open the Summary Statistics, or Business Application Statistics page.
2. Scroll/Search for the statistics to view.

3. Click the link in the ‘Id’ column.

Workers Overview

The CPF uses multiple external worker processes to execute groups of requests from a batch job. The status of these workers can be viewed and groups restarted using the CPF Admin Application. The list of workers and modules is updated on the server whenever workers connect, disconnect or modules are started or stopped. These pages require manual refresh to view and changes.

Each worker is given a unique ID that will not change unless the component parts that make up the ID change. The ID is made up from the following components. Note the workerTomcatContextPath has any ‘/’ characters replaced by ‘-’.

{environmentName}:{workerHostName}:{workerTomcatPort}:{workerTomcatContextPath}

For example:

default:192.168.1.102:8009:pub-cpf-worker

NOTE: The user must be in the ADMIN user group to view workers.

Worker List

The worker list page shows a scrolling table of workers who have connected in the last 2 minutes. The contents of this table can be filtered by typing at least 3 characters in search box. The table will workers where the id or last connect time contain those characters characters (ignoring case).

1. Open the CPF Admin Application (e.g http://localhost/cpf/admin/).
2. Click the 'Workers' menu item.

View Worker

The worker can view viewed using the following steps.

1. Open the Worker List page.
2. Scroll/Search for the workers to view.
3. Click the link in the 'Id' column.

Worker Executing Group List

The list of groups that are currently executing can be viewed using the following steps. This can be used to check for groups that have been running for too long. Note that this contents of this list changes very frequently as new groups are scheduled or completed.

1. Open the View Worker page.
2. Click the 'Executing Groups' tab.

Restart Worker Executing Group

If an execution group has been stuck on a worker it can be rescheduled using the following steps.

1. Open a Worker Executing Group List page.
2. Click the Restart button in the 'Actions' column.
3. Click the OK button on the confirm restart dialog to restart the group, or Cancel to return to the page.

Worker Module List

The list of modules that are loaded on the worker cab be viewed using the following steps.

1. Open the View Worker page.
2. Click the 'Modules' tab.

View Worker Module

The full details of the module on the worker including any startup errors viewed using the following steps.

1. Open the Worker Module List page.
2. Click the link in the ‘Name’ column.

Log Files & Diagnostics Overview

The CPF creates additional log files in addition to those created for the Apache web server and tomcat servlet container. These log files can be accessed on the machine that the master and worker are running on. These maybe exposed for download via the Apache web server if configured.

{Date YYYY-MM-DD HH:MI:SS,SSS}\t{Level DEBUG, INFO,WARN, or ERROR}\t{Category}\t{Message}

2014-07-30 13:56:16,432 INFO  CPF-TEST  Start Module Start  moduleName=CPF-TEST

2014-07-17 17:08:25,305  ERROR ca.bc.gov.open.cpf.api.scheduler.BatchJobPreProcess Could not open JDBC Connection for transaction; nested exception is java.sql.SQLRecoverableException: IO Error: The Network Adapter could not establish the connection
java.sql.SQLRecoverableException: IO Error: The Network Adapter could not establish the connection
  at oracle.jdbc.driver.T4CConnection.logon(T4CConnection.java:458)
  at oracle.jdbc.driver.PhysicalConnection.<init>(PhysicalConnection.java:546)
  at oracle.jdbc.driver.T4CConnection.<init>(T4CConnection.java:236)
  at oracle.jdbc.driver.T4CDriverExtension.getConnection(T4CDriverExtension.java:32)
  at oracle.jdbc.driver.OracleDriver.connect(OracleDriver.java:521)
  at oracle.jdbc.pool.OracleDataSource.getPhysicalConnection(OracleDataSource.java:280)
  at oracle.jdbc.pool.OracleDataSource.getConnection(OracleDataSource.java:207)
  at oracle.jdbc.pool.OracleConnectionPoolDataSource.getPhysicalConnection(OracleConnectionPoolDataSource.java:139)
  at oracle.jdbc.pool.OracleConnectionPoolDataSource.getPooledConnection(OracleConnectionPoolDataSource.java:88)
  at oracle.jdbc.pool.OracleImplicitConnectionCache.makeCacheConnection(OracleImplicitConnectionCache.java:1598)
  at oracle.jdbc.pool.OracleImplicitConnectionCache.makeOneConnection(OracleImplicitConnectionCache.java:515)
  at oracle.jdbc.pool.OracleImplicitConnectionCache.getCacheConnection(OracleImplicitConnectionCache.java:475)
  at oracle.jdbc.pool.OracleImplicitConnectionCache.getConnection(OracleImplicitConnectionCache.java:357)
  at oracle.jdbc.pool.OracleDataSource.getConnection(OracleDataSource.java:395)
  at oracle.jdbc.pool.OracleDataSource.getConnection(OracleDataSource.java:179)
  at oracle.jdbc.pool.OracleDataSource.getConnection(OracleDataSource.java:157)
  ... 13 more
Caused by: oracle.net.ns.NetException: The Network Adapter could not establish the connection
  at oracle.net.nt.ConnStrategy.execute(ConnStrategy.java:392)
  at oracle.net.resolver.AddrResolution.resolveAndExecute(AddrResolution.java:434)
  at oracle.net.ns.NSProtocol.establishConnection(NSProtocol.java:687)
  at oracle.net.ns.NSProtocol.connect(NSProtocol.java:247)
  at oracle.jdbc.driver.T4CConnection.connect(T4CConnection.java:1102)
  at oracle.jdbc.driver.T4CConnection.logon(T4CConnection.java:320)
  ... 29 more
Caused by: java.net.SocketTimeoutException: connect timed out
  at java.net.PlainSocketImpl.socketConnect(Native Method)
  at java.net.AbstractPlainSocketImpl.doConnect(AbstractPlainSocketImpl.java:339)
  at java.net.AbstractPlainSocketImpl.connectToAddress(AbstractPlainSocketImpl.java:200)
  at java.net.AbstractPlainSocketImpl.connect(AbstractPlainSocketImpl.java:182)
  at java.net.SocksSocketImpl.connect(SocksSocketImpl.java:392)
  at java.net.Socket.connect(Socket.java:579)
  at oracle.net.nt.TcpNTAdapter.connect(TcpNTAdapter.java:150)
  at oracle.net.nt.ConnOption.connect(ConnOption.java:133)
  at oracle.net.nt.ConnStrategy.execute(ConnStrategy.java:370)
  ... 34 more

Log Files

The following table summarizes the log files created by the CPF. The log files by default are stored in /apps/logs/cpf/. Each module and business application has separate directories for their log files. Log files will be rolled over once they reach 10MB. The last 7 log files will be retained with extensions .{i}.log (e.g. .2.log).

{moduleName}/
{moduleName}_master.log

{moduleName}/
{moduleName}_worker_{environmentName}_{hostName}_{port}_{contextPath}.log

{moduleName}/
{appName}/
  {moduleName}_{appName}_master.log

{moduleName}/
{appName}/
  {moduleName}_{appName}_worker_{environmentName}_{hostName}_{port}_{contextPath}.log

Diagnosing Issues

This section describes how to diagnose issues with the CPF system or plug-ins running within the system.

The first step in diagnosing an issue is to detect if it is a plug-in specific issue that must be reported to the plug-in developer or a general CPF issue that must be reported to the CPF developer. The general rule is check to see if the problem is isolated to this plug-in by submitting jobs to other plug-ins (e.g. MapTileByTileId). If the error is specific to a single plug-in then contact the plug-in developer for resolution first. Only contact the CPF developer if the plug-in developer cannot resolve the issue.

2014-07-30 16:28:24,183 INFO  [Module Name]  Start Module Start    moduleName=[Module Name]
2014-07-30 16:28:24,200 INFO  [Module Name]  Start Loading plugin  class=[businessApplicationClass]
2014-07-30 16:28:24,212 INFO  [Module Name]  End Loading plugin    class=[businessApplicationClass]  businessApplicationName=[businessApplicationName]
2014-07-30 16:28:24,238 INFO  [Module Name]  End Module Start      moduleName=[Module Name] time=0.06