External System codes are used to enter unique identifiers for clients or employers that may have been assigned via an External System, such as Finance or HR Systems. These items appear within the Clients Personal Wizard:
And the Employer Wizard:
Open the Configuration Manager by choosing Manage > Configuration from the menus. The Configuration Manager displays an alphabetically ordered explorer tree.
- Adding a new External System item
- Editing an existing External System item
- Deleting a External System item
- Viewing the External System report
Adding a new External System item
- Right-click External Systems and choose Add new External System.
This will open the External System Wizard:
- Enter a External System name.
- Optionally, enter a Code to identify the External System item.
- Available for allows you to specify whether this External System Code is for Clients, Employers, or both.
- Duplicate External Codes provides the option to turn on validation for when a code is detected as already in use.
- If this item will be the most commonly used when creating a client or employer, tick the relevant This external system is default checkbox. There can only be one default set at a time.
- This External System is inactive indicates if the External System should be archived. If ticked, the External System will be added/moved to the Archived External Systems branch.
- Optionally, provide a Description for the External System.
- Click Next and then Finish.
Editing an existing External System
- Expand External Systems.
- Right-click the External System item you wish to change and choose Edit External System.
This will open the External System Wizard, where you can make changes.
Deleting an External System item
- Expand External Systems.
- Right-click the External System and choose Delete External System.
- Click Yes when asked to confirm the delete.
If an error occurs, the External System item has likely been used previously and is included in historical data. In this case, you will need to archive the code to remove it from active use.
Viewing the External System report
This report details all the External Systems, including those that have been archived.
- Right-click External Systems and choose Show External Systems report.
The report will be displayed in a new tab/window.