1. Overview
FP Sign integration allows DMS users to electronically sign PDF documents. To activate this functionality, you need to configure a special setting in the Patricia database, which contains the necessary parameters for FP Sign.
2. Prerequisites
- Access to the Patricia Database: Ensure that you have rights to insert or update records in the
PAT_DMS_SETTINGS
table. - FP Sign Credentials: You must obtain your account details as well as your environment data for staging (test) or production beforehand.
3. Creating/Updating the Setting in the Patricia Database
- Table:
PAT_DMS_SETTINGS
- Setting Name:
fp.sign.settings
- Setting Value: A JSON object containing the fields required by FP Sign.
Below is an example (with fictitious values):
{ "applicationId": "YOUR_APPLICATION_ID", "users": { "patriciaUser1": { "username": "fpsignUser1", "password": "fpsignPass1" }, "patriciaUser2": { "username": "fpsignUser2", "password": "fpsignPass2" } }, "originator": "YOUR_ORIGINATOR_ID", "production": false, "tenantId": 12345 }
- applicationId: Obtained from the external FP Sign system.
- users:
- The key is the Patricia username (e.g.,
patriciaUser1
). - The value contains FP Sign credentials:
"username"
: FP Sign login."password"
: FP Sign password.
- The key is the Patricia username (e.g.,
- originator: A special identifier provided by FP Sign.
- production:
false
for the staging environment (test environment).true
for production (live environment) where signatures are legally binding.
- tenantId: A numeric identifier (number) for your tenant, obtained from FP Sign.
Note: We recommend starting with
production: false
to test the integration in a staging environment before switching it to live mode.
4. Field Completion Guidelines
- applicationId and originator:
- Obtain these from your FP Sign point of contact or support team.
- users:
- Add entries for each Patricia user who needs access to signing.
- Ensure the key (e.g.,
patriciaUser1
) exactly matches the user’s name in Patricia.
- production:
false
(default) – run in the test environment.true
– activate only after successful testing.
- tenantId:
- Also provided by the external FP Sign system.
5. Verification and Troubleshooting
- DMS Update:
- After adding (or modifying) the record in
PAT_DMS_SETTINGS
with the namefp.sign.settings
, wait 10 minutes or restart the system so that the new parameters take effect.
- After adding (or modifying) the record in
- Login Test:
- Log in as one of the users specified in the
users
section to confirm that the FP Sign PDF signing option is now available.
- Log in as one of the users specified in the
- Error Diagnosis:
- If errors occur, ensure that
applicationId
,originator
, andtenantId
are correct. - Check that the
username
andpassword
for each Patricia user match valid FP Sign credentials.
- If errors occur, ensure that