> For the complete documentation index, see [llms.txt](https://docs.biscit.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.biscit.com/biscit-spend-management/getting-started/onboarding-guide.md).

# Onboarding Guide

What happens when BISCIT Spend Management (BSM) is connected to your Epicor system, what we need from you, and why. Most of the work is done by BISCIT.

### Before the visit <a href="#before-the-visit" id="before-the-visit"></a>

#### Who should be there <a href="#who-should-be-there" id="who-should-be-there"></a>

* Your Epicor administrator or IT security manager
* Your accounts payable or finance lead

#### What to have ready <a href="#what-to-have-ready" id="what-to-have-ready"></a>

* An Epicor set-up account with the options in The set-up account
* A short window to regenerate the Epicor data model and recycle the Epicor application pool
* Who will use BSM, and what each person may do
* If your Epicor server is not open to the internet, the firewall rules in BSM Firewall Rules for an Epicor Behind a VPN, in place before the visit

#### The set-up account <a href="#the-set-up-account" id="the-set-up-account"></a>

Create this account before the visit. BISCIT signs in to Epicor with it to set BSM up. Call it something like `BSMUser`. In User Account Maintenance, tick only the options below and leave every other option unticked. BSM needs no others.

| Option                    | Section       | Why BSM needs it                                                             |
| ------------------------- | ------------- | ---------------------------------------------------------------------------- |
| **Security Manager**      | Security      | To create the BSM security groups, access scopes and integration users.      |
| **Allow API V1**          | System Access | BSM connects to Epicor through Epicor's REST API, version 1.                 |
| **Can Install Solutions** | System Access | To install the BSM solution package: its queries, fields and business rules. |
| **BAQ Advanced User**     | System Access | To install the BSM queries that update Epicor records.                       |
| **BPM Advanced User**     | System Access | To install the BSM business rules.                                           |
| **Customize Privileges**  | System Access | To add BSM's links to the invoice, payment and supplier screens.             |

Also authorise the account for each company being set up. Security Manager does not include the other five options, because Epicor checks each one separately, so all six are needed.

Disable the account once set-up is finished. Enable it again only when BISCIT installs a BSM update.

### On the day <a href="#on-the-day" id="on-the-day"></a>

BISCIT works through these steps during the visit, signed in with the set-up account.

<table data-search="false"><thead><tr><th width="160">Step</th><th>What we need from you</th><th>What BISCIT does</th><th>Why</th></tr></thead><tbody><tr><td><ol><li><strong>Access for set-up</strong></li></ol></td><td>Sign in with the set-up account.</td><td>Uses that sign-in for the set-up session only.</td><td>Only a security manager can change Epicor security.</td></tr><tr><td><ol start="2"><li><strong>Register your Epicor system</strong></li></ol></td><td>Your Epicor web address and company names.</td><td>Adds your system to BSM's list of approved systems.</td><td>BSM refuses to work with any system not on the list.</td></tr><tr><td><ol start="3"><li><strong>Install BSM components</strong></li></ol></td><td>Nothing.</td><td>Installs the queries and fields BSM uses, all named <code>BISC_BSM</code>.</td><td>BSM reads your invoices and records payment progress through them.</td></tr><tr><td><ol start="4"><li><strong>Regenerate the data model</strong></li></ol></td><td>Regenerate the Epicor data model, then recycle the Epicor application pool from the Epicor Administration Console.</td><td>Waits, then checks Epicor can see the new BSM fields before carrying on.</td><td>Epicor only picks up the new BSM fields after the data model is regenerated and the application restarts.</td></tr><tr><td><ol start="5"><li><strong>Create your company in BSM</strong></li></ol></td><td>Nothing.</td><td>Creates a secure record for your company.</td><td>Keeps each company's settings separate.</td></tr><tr><td><ol start="6"><li><strong>Set up BSM security</strong></li></ol></td><td>Nothing.</td><td>Creates four BSM security groups and five access scopes in Epicor.</td><td>Limits BSM, and each person, to only what they need.</td></tr><tr><td><ol start="7"><li><strong>Create BSM integration users</strong></li></ol></td><td>Assign each user its access scope, and add two extra permissions. One of them lets BSM check each person's Epicor session when they sign in.</td><td>Creates five system users with generated passwords no one sees.</td><td>BSM works in Epicor through these users, never through your staff's own accounts.</td></tr><tr><td><ol start="8"><li><strong>Connect BSM to Epicor screens</strong></li></ol></td><td>Nothing.</td><td>Sets up three Epicor screens (invoices, payments and suppliers) so BSM can open them at the right record, and adds a Linked to BSM label to supplier bank accounts.</td><td>Click a record in BSM to open it straight in Epicor, and see which supplier bank accounts BSM pays.</td></tr><tr><td><ol start="9"><li><strong>Decide who can do what</strong></li></ol></td><td>Add each person to one BSM group (see below).</td><td>Helps you map your team to the roles.</td><td>People only get the access their role needs.</td></tr><tr><td><ol start="10"><li><strong>Add the BSM tab</strong></li></ol></td><td>Each user adds the tab to their Epicor home page.</td><td>Shows the first person how.</td><td>BSM opens inside Epicor, with your normal Epicor login.</td></tr></tbody></table>

#### Epicor Company Configuration Checklist <a href="#check-list" id="check-list"></a>

* [ ] Countries in Country Maintenance should have CountryNumISOCode set with 2-letter [ISO Alpha-2 Country codes](https://www.iban.com/country-codes).
* [ ] Currencies in Currency Master should have ISOCurrCode set with [ISO 4217 currency codes](https://www.iban.com/currency-codes).
* [ ] Company timezone in Company Maintenance is set.&#x20;
* [ ] GL controls and account codes should be set up correctly for the BSM bank fee created by integration setup.
* [ ] GL control and account codes should be set up correctly when the miscellaneous payments are created under a payment group which is going to be processed by BSM integration.

### BSM roles <a href="#bsm-roles" id="bsm-roles"></a>

| Group         | Can                                                                                            |
| ------------- | ---------------------------------------------------------------------------------------------- |
| BSM Viewer    | See invoices and payments. Change nothing.                                                     |
| BSM Submitter | Viewer, plus prepare payment groups.                                                           |
| BSM Approver  | Submitter, plus approve and release payments through to OFX. Created but not used without OFX. |
| BSM Admin     | Approver, plus BSM set-up.                                                                     |

One group per person is enough.

### For IT security <a href="#for-it-security" id="for-it-security"></a>

#### BSM keeps <a href="#bsm-keeps" id="bsm-keeps"></a>

One record per company, in BISCIT's Microsoft Azure Key Vault, holding:

* your Epicor web address and company name
* the integration users' usernames and passwords
* the email addresses BSM sends notifications to

Your Epicor web address is also on BSM's list of approved systems (step 2).

Only the BSM services are given access to the Key Vault. No BISCIT staff member is given access in Live, and every access is logged.

#### BSM does not keep <a href="#bsm-does-not-keep" id="bsm-does-not-keep"></a>

* the set-up account's password
* your staff's passwords. Users sign in with their Epicor session, which BSM checks with Epicor.

#### Added to Epicor <a href="#added-to-epicor" id="added-to-epicor"></a>

* `BISC_BSM` queries, fields and business rules
* 4 security groups, 5 access scopes
* 5 integration users
* small additions to 3 Epicor screens


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.biscit.com/biscit-spend-management/getting-started/onboarding-guide.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
