Configuration

Edit the config File

The Forms and Workflows Service is configured in the file /etc/ecm4u/sbcs-faw/config.

TODO

Migrate the Database

After the database connection properties have been configured in the config file, the database must be initialized to contain the required tables. This process is called migration.

The Forms and Workflows Service distribution contains the tool sbcs-faw-migrate that can be used.

$ sbcs-faw-migrate 
usage: /usr/bin/sbcs-faw-migrate [init|info|migrate]

Once the init command must be used:

$ sbcs-faw-migrate init

This will create a table that keeps track of the current state of the database schema.

To view the current state of the database schema, use the info command:

$ sbcs-faw-migrate info
+-----------+---------+---------------------------------------------------+------+---------------------+---------+
| Category  | Version | Description                                       | Type | Installed On        | State   |
+-----------+---------+---------------------------------------------------+------+---------------------+---------+
| Versioned | 1       | Create Tables                                     | SQL  | 2017-11-21 17:21:34 | Success |
| Versioned | 2       | Create Task Tables                                | SQL  | 2017-11-21 17:21:34 | Success |
| Versioned | 3       | Create Action Tables                              | SQL  | 2017-11-21 17:21:35 | Success |
...
| Versioned | 33      | Introduce Timestamp Columns                       | SQL  | 2018-05-24 17:23:36 | Success |
| Versioned | 34      | Add Timestamp To Module Table                     | SQL  | 2018-05-25 09:26:01 | Success |
+-----------+---------+---------------------------------------------------+------+---------------------+---------+

If the State column of all rows contains Success, the database tables are up to date.

To make your database tables up to date, use the migrate command:

$ sbcs-faw-migrate migrate

This command will return with no output. You can use the info command to check the state after migration.

Note: You should use info and migrate after you've upgraded your Forms and Workflows Service installation to a new version.