V1HouseKeepingManagement

Pre-Requisites

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

Mandatory:

• SmartConnect
• Vault

Optional:

• DbCapture
• DbAuthorise
• DbArchive
• The V1 SmartSuite
• 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

---

Pre-Installation Tasks

DbCapture (if applicable)

To facilitate cleansing the DbCapture Exported queue automatically, a new services is required used exclusively for the housekeeping procedure so as not to adversely affect performance.

1. Open a command prompt as Administrator
2. CD to the DbCapture\DbCapture Communications DIR
3. Copy the following to your clipboard and paste it in to the command prompt:

dbcapcomms.exe -name DbCapComms-31466 -desc "V1HouseKeepingManagement - DbCapture:31466" -install "V1HouseKeepingManagement - DbCapture:31466" 31466@any -loglevel1

4. Press Enter
5. Navigate to Services.msc and start the service

DbAuthorise (if applicable)

To facilitate cleansing the DbAutorise queue of completed documents automatically, a new services is required used exclusively for the housekeeping procedure so as not to adversely affect performance.

1. Open a command prompt as Administrator
2. CD to the DbAuthorise DIR
3. Copy the following to your clipboard and paste it in to the command prompt:

dbcsauthserver -name dbcsauthserver-31499 -desc "V1HouseKeepingManagement - DbAuthorise:31499" -install "V1HouseKeepingManagement - DbAuthorise:31499" 31499@any c:\v1home\dbauthorise\ c:\v1home\dbform\bin\dbform.exe

4. Press Enter
5. Navigate to Services.msc and start the service

---

Copy Files

1. On the V1SERVER, download V1HouseKeepingManagement.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\V1HouseKeepingManagement

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 V1HOUSEKEEPINGMANAGEMENT (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\V1HouseKeepingManagement 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.
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 housekeeping for a module that isn't installed.

Key	Values	Explanation
DBARC_CLEARCACHE	1 0	1 Means activate clearing up the DbArchive cache dir 0 Means never clear it
DBARC_CLEARCACHE_TIMEPERIOD	5	The number of days old DbArchive Cache files are before they’re cleaned up if DBARC_CLEARCACHE = 1
DBARC_PATH	C:\V1Home\DbArchive	The route directory of DbArchive
DBAUTH_CLEAROK	1 0	1 Means activate clearing DbAuthorise OK entries 0 Means never clear them
DBAUTH_CLEAROK_TIMEPERIOD	5	The number of days old DbAuthorise OK entries are before they’re removed up if DBAUTH_CLEARCOMPLETED = 1
DBAUTH_DBAUTHPORT	31499	The dedicated port of the service installed to perform the cleansing process
DBAUTH_PASSWORD	MyPassword123	The password of the DbLogin user authorised to access DbAuthorise to perform the cleansing process
DBAUTH_SENDALERTEMAIL	1 0	1 Means activate an email alert if there are any issues communicating with DbAuthorise 0 Means never send an alert
DBAUTH_SENDALERTEMAIL_ADD	admin@mycompany.com	The email address to be informed via email if DBAUTH_SENDALERTEMAIL = 1
DBAUTH_SERVER	127.0.0.1	The DNS / IP adress where DbAuthorise is installed
DBAUTH_USERNAME	MyUser123	The username of the DbLogin user authorised to access DbAuthorise to perform the cleansing process
DBCAP_CLEAREXPORTED	1 0	1 Means activate clearing DbCapture Exported entries 0 Means never clear them
DBCAP_CLEAREXPORTED_TIMEPERIOD	5	The number of days old DbCapture exported entries are before they’re removed up if DBCAP_CLEAREXPORTED = 1
DBCAP_COMMSPORT	31466	The dedicated port of the service installed to perform the cleansing process
DBCAP_PASSWORD	MyPassword123	The password of the DbLogin user authorised to access DbCapture to perform the cleansing process
DBCAP_PATH	C:\V1Home\DbCapture	The route directory of DbCapture
DBCAP_SENDALERTEMAIL	1 0	1 Means activate an email alert if there are any issues communicating with DbCapture 0 Means never send an alert
DBCAP_SENDALERTEMAIL_ADD	admin@mycompany.com	The email address to be informed via email if DBCAP_SENDALERTEMAIL = 1
DBCAP_SERVER	127.0.0.1	The DNS / IP adress where DbCapture is installed
DBCAP_USERNAME	MyUser123	The username of the DbLogin user authorised to access DbCapture to perform the cleansing process
DISKSPACE_SENDALERTEMAIL	1 0	1 Means activate the alert for low diskspace on the V1 Server 0 Means never alert
DISKSPACE_SENDALERTEMAIL_ADD	admin@mycompany.com	The email address to be informed via email if DISKSPACE_SENDALERTEMAIL_ADD = 1
DISKSPACE_SIZETOCHECKINGB	10	If activated, the amount of diskspace (in gigabytes) it falls below before the alert is sent
LOGS_CLEARLOGS	1 0	1 Means activate the clearing of logs 0 Means never clear any
LOGS_CLEARLOGS_TIMEPERIOD	10	If activated, the age of logs which are deleted if they are older than the number of days in the time period
NIS_CLEARPREVIEWS	1 0	1 Means activate the clearing of the NIS preview / upload (cache) area 0 Means never clear them
NIS_CLEARPREVIEWS_TIMEPERIOD	10	If activated, the age of files in the nis\previews and nis\uploads which are deleted if they are older than the number of days in the time period
NIS_PATH	C:\V1Home\V1Web\IntegrationServer	The route directory of the V1NodeIntegrationServer

---

Install the V1HouseKeepingManagement service

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

1. Using File Explorer, navigate to the C:\V1Home\V1HouseKeepingManagement 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_V1HouseKeepingManagement.bat as administrator
4. Right click and run !Start_V1HouseKeepingManagement.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 and 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.

---