V1FilterMapMaintenance

Pre-Requisites

The following core software must be installed / licensed for before applying V1FilterMapMaintenance:

Mandatory:

• SmartConnect
• DbArchive
• Vault

---

Assumptions

For the purposes of this document, the following assumptions are made, change as appropriate to your installation:

• The V1 Server components have been fully installed / implemented
• The Server Installation is applied to C:\V1Home
• The V1 server is named V1SERVER

---

Copy Files

1. On the V1SERVER, download V1FilterMapMaintenance.zip
2. Un-Compress it to a temporary location
3. Copy the directory to the top level of C:\V1Home, so you end up with:

C:\V1Home\V1FilterMapMaintenance

Which contains the files.

---

Configure Vault

Using your browser of choice, connect to the V1 Server and navigate to http://localhost:8200
Where promoted, enter the Token

1. Click Sign In
2. Click kv
3. Click Create secret
4. Enter the Path for this secret to be V1FILTERMAPMAINTENANCE (NOTE: This MUST be in UPPERCASE)
5. Toggle the JSON button so you see a black Secret data screen with blank values
6. Navigate to the C:\V1Home\V1FilterMapMaintenance directory
7. Open the Vault_settings.json file in your text editor of choice and copy the contents to your clipboard
8. Paste it into the Secret data screen
9. Click Save
10. Un-toggle the JSON button

You have now imported all the settings required and they contain sample values, the table below explains what each of them represent.
Click Edit secret to change them and Save when satisfied they are correct.

Key	Values	Explanation
SCHEDULERESTART	1 0	1 Means activate activate a scheduled restart of a service / services 0 Means do not activate
SCHEDULERESTARTTIME	03	Where SCHEDULERESTART = 1, the hour at which the restart will happen (24 Hour format, 03 is 3am, 15 is 3PM, 18 is 6PM and so on.)
SENDUPDATEALERT	1 0	1 Means activate activate an email alerting a pre-designated user of changes to Filter Map 0 Means do not activate
SERVICELIST	V1NodeIntegrationServer	Where SCHEDULERESTART = 1 and the SCHEDULERESTARTTIME is set, the service(s) that will be restarted. Multiple services can be seperated with a comma.
SYRA_PASS	XXXXXX	The Syracuse password to access Sage X3
SYRA_USER	XXXXXX	The Syracuse username to access Sage X3
UPDATEALERTEMAIL	admin@mycompany.com	Where SENDUPDATEALERT = 1, the email address to be informed of changes to Filter Map
USE_DBLOGIN_GROUPS	1 0	More information on this setting below.
V1_DIR	C:\\V1Home	The root directory of the V1 installation. NOTE: The double backslahses are deliberate.
WEBADD	https://MYSAGESERVER:8124	The baseline URL of your Sage X3 installation. Browsing to this should prompt you to login for example.

---

USE_DBLOGIN_GROUPS

Assumptions:

You're using the Sage X3 integration, Sage is using 3 Endpoints:

SEED
TEST
DEV

USE_DBLOGIN_GROUPS = 1

You have created 10 DbLogin users who do wish to have different accessibility to the images in SmartRetrieve / a Drilldown depending on the Endpoint.

1. Open the DbLogin Admin Console
2. Log in as an administrative user
3. Click on the Manage Groups icon
4. Click on Add
5. Give your Group(s) a name the same as the Sage X3 Endpoint, in uppercase. So in our example SEED, TEST and DEV
6. You will be presented with the DbLogin users setup. Those in the left pane do not have access to the Group, those on right left do have access. Using the arrows, move the users according to the access required.
7. Click OK
8. Repeat the above for all the Groups you wish to create
9. When completed, click Save

USE_DBLOGIN_GROUPS = 0

You have created 10 DbLogin users who don't wish to have different accessibility to the images in SmartRetrieve / a Drilldown depending on the Endpoint.

No specific activity is required at this point, but be aware using this option will give all DbLogin users access to all data.

---

Install the V1FilterMapMaintenance service

The final step is to install and start the V1FilterMapMaintenance service:

1. Using File Explorer, navigate to the C:\V1Home\V1FilterMapMaintenance directory
2. Double click on !!RUNMEFIRST.bat to set all the paths in files based on your current directory
3. Right click and run !Install_V1FilterMapMaintenance.bat as administrator
4. Right click and run !Start_V1FilterMapMaintenance.bat as administrator
5. Go to services.msc and ensure it is both installed and started

This completes the installation procedure.

---

Appendix

Obviously being just a def file, it is extremely flexible and can be added too / changed to accommodate other requirements, the out the box version should cover the vast majority of the most common areas.

Suggestions for improvement / standard changes are always welcome and should be in the first instance added to the idea’s portal in Aha! for review by the integrations team.

---