V1UpdateService

Pre-Requisites

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

Mandatory:

• SmartConnect
• The V1 SmartSuite
• Vault

Optional:

• SmartMail (including SmartMailSend)

---

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 V1UpdateService.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\V1UpdateService

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 V1UPDATESERVICE (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\V1UpdateService directory
7. Open the V1UpdateService_Vault.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.
Each are grouped together based on a prefix for that module.

NOTE: The default is to have everything off so you can selectively activate each one without risking triggering an update erroneously.

Key	Values	Explanation
EMAIL_ALERT_ONUPDATE	1 0	1 Means activate sending an email to alert an update has occured 0 Means don't send an alert
EMAIL_ALERT_ONUPDATE_ADD	admin@mycompany.com	The email address to be informed via email if EMAIL_ALERT_ONUPDATE = 1
ROLLBACK	1 0	1 Means rollback an update to the file(s) state prior to it being applied 0 Means don't rollback NOTE: Where ROLLBACK = 1, once rolled back this value will be programatically set back to 0.
RUNNOW	1 0	1 Means run an update immediately rather than waiting for the once a day UPDATETIMECHECK 0 Means don't run immediately NOTE: Where RUNNOW = 1, once ran this value will be programatically set back to 0.
UPDATEADDONS	1 0	1 Means activate the automatic update of the V1 Addon components 0 Means don't update them
UPDATEADDONS_URL	http://myupdatewebsite.com/UPDATEADDONS	The URL storing your manifest and update files if UPDATEADDONS = 1
UPDATECORE	1 0	1 Means activate the automatic update of the V1 Core components 0 Means don't update them
UPDATECORE_URL	http://myupdatewebsite.com/UPDATECORE	The URL storing your manifest and update files if UPDATECORE = 1
UPDATEINTEGRATION	1 0	1 Means activate the automatic update of the V1 Integration components 0 Means don't update them
UPDATEINTEGRATION_URL	http://myupdatewebsite.com/UPDATEINTEGRATION	The URL storing your manifest and update files if UPDATEINTEGRATION = 1
UPDATETIMECHECK	03:00	The time / hour / minute (in 24 hour format) the check is made to do an update. Once checked that day, it will not check again until the following day, at the same time.

NOTE: When running a ROLLBACK, ensure both ROLLBACK = 1 AND RUNNOW = 1.

---

Install the V1UpdateService service

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

1. Using File Explorer, navigate to the C:\V1Home\V1UpdateService 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_V1UpdateService.bat as administrator
4. Right click and run !Start_V1UpdateService.bat as administrator
5. Go to services.msc and ensure it is both installed and started

This completes the installation procedure.

---