The adventures and experiences documented…

The FCDReferral (v. 1.08) known as the Fixed Content Provider Referral Utility is a utility provided by IBM and used in a FileNet P8 environment.

This utility will display the associated FCP referral information for a P8 document. It can process both a single document and also multiple documents located in a text file. The utility will determine the type of FCP used for the document and display the appropriate referral information for the FCP.

 

Prerequisites

  • Java 1.6.0_11 or later
  • The appropriate JDBC driver for the database being used in your environment (Oracle, SQL, DB2).
  • The username and password to access your database.

Step One: Unzip the FCPReferral files into a directory on the server that has access to the Database (D:\FCPReferralUtility  for example).

FCPReferralUtility2

 

 

 

 

 

 

– Create a folder within your FCPReferral directory for the database JDBC jar files.

  • DB2
    • Directory:  .\JDBC\DB2
      • db2jcc.jar
      • db2jcc_license_cu.jar
  • Oracle
    • Directory:  .\JDBC\ORACLE
      • ojdbc14.jar
  • SQL Server
    • Directory:  .\JDBC\SQL\enu
      • sqljdbc.jar

– Add the .jar files and license (if applicable) to the database folder you created.

FCPReferralUtility3

 

 

 

Step Two: Edit the FCPReferral.properties file

The properties file contains both information required for the utility to run and optional information determining how the utility behaves. A sample properties file would be:

LogFilename=FCPtrace.txt
LogLevel=Off
DatabaseType=SQLServer
DriverClassname=com.microsoft.sqlserver.jdbc.SQLServerDriver
DatabaseURL=jdbc:sqlserver://192.168.105.105:1433;databaseName=tstDBNamed
DatabaseUsername=sa
DatabasePassword=h34l0tgs
DatabaseConnections=25
Action=ShowReferral
ObjectIdFileName=myDocumentIDs.txt
ReportFileName=MyReport.txt

Some lines in the properties files need to be edited to correspond to the server environment where the utility will be used.

Database Information

Update the database connection lines with the appropriate information for the database type on the server where the utility will be run.

DatabaseType=<databasetype>

Where <databasetype> is one of:

  • SQLServer
  • DB2
  • Oracle

 

DriverClassname=<dbdriverclassname>

Where <dbdriverclassname> is one of:

  • microsoft.sqlserver.jdbc.SQLServerDriver
  • ibm.db2.jcc.DB2Driver
  • jdbc.OracleDriver

 

DatabaseURL=<dburl>

Where <dburl> is one of:

  • jdbc:sqlserver://9.39.100.12:1433;databaseName=OS1
  • jdbc:db2://9.39.100.21:50000/CEMPJB
  • jdbc:oracle:thin:@9.39.100.11:1521:orclBK01

 

DatabaseUsername=<dbusername>

Where <dbusername> is the CE database user name.

 

DatabasePassword=<dbuserpassword>

Where <dbuserpassword> is the CE database user password.

 

The following is an example for database type MSSQL Server:

DatabaseType=SQLServer

DriverClassname=com.microsoft.sqlserver.jdbc.SQLServerDriver

DatabaseURL=jdbc:sqlserver://192.168.105.105:1433;databaseName=Cedar

DatabaseUsername=sa

DatabasePassword=thirdlevel

 

Document IDs

The utility has an option of processing a list of document IDs located within a text file.

If a file of document IDs will be used, edit the following line with the name of the text file.

ObjectIdFileName=myDocumentIDs.txt

 

The text file should contain a list of document IDS/GUIDs, one per line. Refer to the sample myDocumentIDs.txt file for how this file should be created.  If supplied, this file must exist. If not, an error is reported.

 

If a file of document IDs will not be used, leave the file name off this line.

ObjectIdFileName=

 

Report file

The utility will always report the results of the request to the standard listing device.  This is usually the DOS command window.  An optional report file can be generated which contains only the document ID and resulting associated FCP referral information. To have the utility generate this report, update the following line in the properties file, supplying the name of report file:

ReportFileName=MyReport.txt

 

Note: If the report file already exists, it will be overwritten.  If the new file contains less data than the old file, all of the old file is removed.  Only the new data remains in the file.

 

Other lines

Leave all other lines in the properties files unchanged, unless directed by engineering.

 

Step Three: Using the CMD Line to perform the query.

The basic command has the form of: java -cp .;FCPReferral.jar;<dbjarfile> Referral <runtimeparameters>

 

Database jar files

Replace <dbjarfile> with the appropriate database jar files.

Select the appropriate run command:

  • DB2

java -cp ;FCPReferral.jar;.\JDBC\DB2\db2jcc.jar;.\JDBC\DB2\db2jcc_license_cu.jar Referral <runtimeparameters>

  • Oracle

java -cp .;FCPReferral.jar;.\JDBC\ORACLE\ojdbc14.jar Referral <runtimeparameters>

  • Sql Server

java -cp .;FCPReferral.jar;.\JDBC\SQL\enu\sqljdbc.jar Referral <runtimeparameters>

 

For example, for DB2, the command line would include the reference to the database and license jar files. For example:

java -cp .;FCPReferral.jar;.\JDBC\DB2\db2jcc.jar;.\JDBC\DB2\db2jcc_license_cu.jar Referral <runtimeparameters>

 

Run time parameters

There are two run time parameters. The first is required, the second is optional.

 

The first parameter is the properties file for the utility. This parameter is required.

Therefor, for the DB2 example above, the full command would be:

java -cp .;FCPReferral.jar;.\JDBC\DB2\db2jcc.jar;.\JDBC\DB2\db2jcc_license_cu.jar Referral FCPReferral.properties

 

The second parameter is a document ID or GUID. This parameter is optional.  If supplied, the utility will output the associated referral information for the document. For example:

java -cp .;FCPReferral.jar;.\JDBC\DB2\db2jcc.jar;.\JDBC\DB2\db2jcc_license_cu.jar Referral FCPReferral.properties  {11B9E075-CAA5-402C-BE6C-80BCFFA6CC05}

FCPReferralUtility

 

 

A sample execution of the above command might appear as:

FCP (Fixed Content Provider) Referral Utility

Mon, Dec 6, 2010, 10:30:32 AM

Number arguments supplied: 2

args[0] = FCPReferral.properties

args[1] = {11B9E075-CAA5-402C-BE6C-80BCFFA6CC05}

 

— Database Information

Type: DB2

URL: jdbc:db2://9.39.61.13:50000/HUSKY

User name: db2admin

User password: thirdlevel

 

— Document IDs file name not supplied.

— Report file name not supplied.

 

Command line document ID: {11B9E075-CAA5-402C-BE6C-80BCFFA6CC05}, Centera, 3TL8I

V3SAUDS7e10U2MC6N4E7OOG415HNRQJTA0M67F0H36IEUP94

 

 

Reported referral information

The referral utility will report the associated FCP (Fixed Content Provider) information for the document(s) requested.  CE handles multiple FCPs.  The referral information line will be different, depending upon the FCP.

 

Centera:

<document id>, Centera, <centera clipid>

 

Image services:

<document id>, Image Services, <is document id>, <is element count>

 

TSM:

<document id>, TSM, <tsm store id>, <tsm device id>

 

HCP:

<document id>, HCP, <hcp device id>, <hcp retention>, <hcp ce count>,  <hcp location>, <hcp element count>