Vault

---

Assumptions

The EDM for Sage X3 solution is fully installed and implemented:

• For the purposes of this page, we will assume C:\V1 (change the path as appropriate to your installation)
• You have direct remote desktop access to the V1 Server

---

What is Vault?

Vault is a web based secrets engine designed to secure, store and tightly control access to passwords, server names and other sensitive information.

In the case of EDM for Sage X3, the Syracuse URL, authentication details and other sensitive information needed by the integration are stored in Vault in what are termed as ‘secrets’.

Vault is used to house these secrets and they are retrieved on demand via the native Vault API’s when needed.

---

When is Vault used?

Wherever there is a requirement to communicate with Sage X3 when using EDM for Sage X3, Vault is interrogated for the secrets that particular activity requires details, i.e.

• When using SmartDeposit to deposit an adhoc document
• When using DbScanner to deposit a barcoded document
• When polling Sage X3 to find the current Endpoints and create directories on disk, any images added to these are then processed for that Endpoint.
• C:\V1\EDMImport\-ENDPOINT-
• C:\V1\PIAIMPORT\-ENDPOINT-

---

When is not Vault used?

Some details still remain in legacy settings files on disk encoded, future releases will deprecate them in favor of moving ALL settings in Vault.

These are:

• C:\V1\DbArchive\V1_SETTINGS.def (This file is read for all EDM related activity)
• C:\V1\DbCapture\defs\V1_SETTINGS_DBCAPTURE.def (This file is read for all PIA related activity if using DbCapture)

---

Why is authentication in multiple places?

As the EDM for Sage X3 solution has evolved over time, to ensure backward compatibility and maintain familiarity, features such as Vault are being slowly introduced incrementally.

Patches will rarely change the fundamental behavior of functionality and take the first steps to introduce big changes, whereas as new releases will fully adopt such changes.

The addition of Vault is an example of this ethos, R13 Patch 3 began our transition and future releases will complete this move, which in this case, streamlines the storage of all security and optional settings in one place.

---

How do I access Vault?

Once EDM for Sage X3 is installed by the setup program, or an upgrade to R14 is performed, Vault is installed and the secrets needed by the integration added as part of the implementation. If no changes are needed, you may ever need to directly access it.

If changes are required (for instance the Syracuse password) it can be accessed at any time via the browser.

NOTE: Vault is installed locally to the V1 Server alongside the other EDM server components, so can only be accessed when physically remote desktop connected to it.

• Navigate to http://127.0.0.1:8200
• You will be prompted to enter a token to authenticate connection
• Open Windows file explorer and navigate to C:\V1\SmartConnect\SmartConnectAPI
• Using a suitable text editor, open the appsettings.json
• Copy the RTID value to your clipboard
• Return to your browser and paste in the RTID value, click Sign in
• Click the kv link
• You are presented with 3 Secret areas, EDM, PIA (where installed) and SAGE
• Depending on which area you wish to change, click on the link
• Click Edit secret
• Make your change
• Click Save