WFR Agent Operations

See the following topics to learn how you can start and stop the WFR agent, the key directories/files that are available within the WFR agent installation directory, as well as learn how to create a read-only view for inbound metadata access.

How to Start the WFR Agent?

To start the WFR agent:

  1. Run the command prompt as administrator.
  2. Navigate to the startWFRAgent.bat file. Its default location is C:\Program Files (x86)\Oracle\Oracle WebCenter Forms Recognition Agent\startWFRAgent.bat.
  3. Run the startWFRAgent.bat file.

    Note:

    If you do not run the startWFRAgent.bat file as an administrator, you'll encounter errors such as the following in the command prompt:
    C:\Program Files (x86)\Oracle\Oracle WebCenter Forms Recognition
            Agent>startWFRAgent.bat
        2022-01-23 22:38:36,518 main ERROR RollingFileManager (extproc-logs/extproc.log)
          java.io.FileNotFoundException: extproc-logs\extproc.log (Access is denied)
          java.io.FileNotFoundException:
    extproc-logs\extproc.log (Access is denied)
    at java.io.FileOutputStream.open0(Native Method)
    at java.io.FileOutputStream.open(Unknown Source)
    at java.io.FileOutputStream.<init>(Unknown Source)
    at java.io.FileOutputStream.<init>(Unknown Source)
  4. To simplify starting the server, create a shortcut to this file on your desktop. Since the agent should always be run as an administrator, configure the shortcut to do that for you.
    1. From the Start menu, search for the startWFRAgent.bat file.
    2. Right-click the file and select Open file location.
    3. Right-click the app shortcut and select Properties.
    4. On the Shortcut tab, click Advanced.
    5. Select the Run as administrator option.
    6. Click OK, then click Apply, and then click OK.

How to Stop the WFR Agent?

To stop the WFR agent:

  1. Open the command prompt in which you started the WFR agent as an administrator, and then press Ctrl + C.
    You'll notice messages like:
    2022-01-23 22:38:06,849 [SpringApplicationShutdownHook] INFO  c.z.h.HikariDataSource - HikariPool-1 - Shutdown initiated...
    2022-01-23 22:38:06,896 [SpringApplicationShutdownHook] INFO  c.z.h.HikariDataSource - HikariPool-1 - Shutdown completed.
    Terminate batch job (Y/N)?
  2. Type in Y/y and press Enter.
The WFR agent will be stopped/shutdown.

Key Directories and Files within the Installation Directory of the WFR Agent

The following table lists the key directories and files you'll see within the installation directory of the WFR agent.

Directory/File Location

WFR agent log file(s) that might be helpful in diagnosing issues.

C:\Program Files (x86)\Oracle\Oracle WebCenter Forms Recognition Agent\extproc-logs\extproc.log

The spring-boot application properties file should not be updated and/or deleted manually. Doing so will cause the WFR agent to behave inconsistently.

C:\Program Files (x86)\Oracle\Oracle WebCenter Forms Recognition Agent\config\application.properties

In case SSL certificate is configured, the certificate file will be stored in the config directory.

C:\Program Files (x86)\Oracle\Oracle WebCenter Forms Recognition Agent\config

The xpath directory consists of every WFR agent configured and Capture procedure-specific WFR XML template files for xPath mapping.

C:\Program Files (x86)\Oracle\Oracle WebCenter Forms Recognition Agent\stage\xpath

The document from Content Capture will be stored temporarily in the stage directory before it is imported into WFR.

C:\Program Files (x86)\Oracle\Oracle WebCenter Forms Recognition Agent\stage

How to Create a Read-Only View for Inbound Metadata Access?

To support tracking, reporting, and validation of documents between WebCenter Forms Recognition and Content Capture, the document metadata created in Content Capture is stored in the WFR agent database. WebCenter Forms Recognition queries this metadata when the data needs to be passed from Content Capture to WebCenter Forms Recognition. To enable tracking of document progress via the WFR agent, you need to grant the SELECT access from the WebCenter Forms Recognition schema to the WFR agent database schema. The SELECT access also lets you create a view of the WFR agent database tables that you can query even after underlying tables are modified.

Create a User

To grant the SELECT access to the EPDOCUMENTS table, you need to create a read-only user for the WFR Agent schema:

Create a user <username> identified by "<password>";

For example: Create the user extproc_read_only identified by "welcome1";

Grant Privileges

Grant <privilege> to <user>

For example: Grant create session to extproc_read_only;

Create a Read-Only User: Example

SQL> connect <sys as sysdba>/<password>
SQL> create user extproc_read_only identified by welcome1;
SQL> grant create session to extproc_read_only;
SQL> grant select on <wfr_agent_schema_user>.EPDOCUMENTS to extproc_read_only;

Read-Only User's Access to the EPDOCUMENTS Table: Example

SQL> connect extproc_read_only/welcome1
SQL> select * from <wfr_agent_schema_user>.EPDOCUMENTS;