Skip to main content

DocUCheck Installation Guide

Raise a support ticket

DISCLAIMER​

Any advice FYB provide in relation to setting up any FYB App, FYB Add-in, FYB Connector and or advice in relation to opening access to your on-premises or in the cloud systems will be general advice only. This means that the advice is of a general nature and will not consider your network setup, network infrastructure or any security requirements that you may have or in fact need. It is highly advised that you seek advice from internal or external providers to ensure that they are comfortable with what is required prior to going ahead with any deployment, setup, or configuration for external access.

LICENSE DETAILS​

Please contact FYB for a valid license if you are yet to obtain one for your Add-in.

INSTALLATION COMPONENTS​

The following installation components are required to ensure full functionality of the FYB DocUCheck:

  • FYB DocUCheck Service allows email notifications to be sent. This is a server-side installation
  • FYB DocUCheck Pop-Up Add-In allows the reminder Pop-Up to be shown when users open or close Content Manager. This is a client-side installation

INSTALLING FYB DOCUCHECK SERVICE​

PRE-INSTALL CONFIGURATION​

  1. Open Content Manager and create a new additional field

  2. Select the format Boolean

  3. Click the Next button

    image.png  

  4. Enter the name as Notifier Email Recipient

  5. Select the checkbox Default to yes (optional) and click the Next button

    image.png

    info

    Checking on the “Default to yes” setting will only default this field to yes for locations created post creation of this additional field. You will be required to update existing locations that will be using this functionality, as the additional field will be defaulted to No for existing Locations.

  6. On the Applies To screen, tag Person and click the Finish button

image.png

  1. Each Location that is to receive the email notifications will need the Notifier Email Recipient additional field set to Yes

  2. Right click on a Location (or list of tagged Locations) and select Additional Fields

    image.png

  3. Highlight the Notifier Email Recipient Additional Field and click the Modify button to change the value from No to Yes

    image.png

  4. Once the Notifier Additional Field value is set to Yes, click the OK button to save the change on the Location(s)

    image.png

INSTALLATION​

The DocUCheck Service MSI will:

  • Deploy the installation files
  • Setup the temp folder
  • Configure the application settings as specified by the user

To install the DocUCheck Service, follow these steps:

  1. Create an appropriate folder to house the license file (.lic) on the server For Example: C:\FYBAddins\License You will be asked to enter this location later in the install process

  2. Move the license file into the license folder

  3. Run command prompt as an administrator and launch the docucheckservice-xxx.msi

  4. Click the Next button

    2021-08-06_8-46-23.jpg

  5. On the Configuration Settings screen, enter the dataset ID, license path, and temp folder path. Click the Next button

    2022-09-06_9-40-28.png

    NAMEDESCRIPTION
    Dataset IDThe two-character dataset identifier
    License PathThe local path of the DocUCheck license file, including ".lic"
    Temp PathThe local path of the folder that the DocUCheck service is to use for temporary file storage.
    Additional Field Notifier URIThe 'Notifier Email Recipient' additional field URI
    Send Email On Service StartIf checked, the service will send an additional batch of reminder emails as soon as it starts.
  6. Enter the Email Settings then click Next

    2022-09-06_9-41-01.png

    NAMEDESCRIPTION
    Email From NameThe name that appears as the sender of the email
    Email From AddressThe email address that appears as the sender of the email.
    Email ServerThe address of the email server
    Email Server PortThe port of the email server
  7. On the Destination Folder screen, select the installation folder and click the Next button

    2021-08-06_8-47-29.jpg

  8. On the confirm installation window, click the Install button

    2021-08-06_8-47-22.jpg

  9. The installation will commence

    2021-08-06_8-47-39.jpg

  10. Once the installation is complete, click the Finish button

    image.png

  11. Navigate to the location the DocUCheck Service was installed to (default: C:\Program Files\FYB Pty Ltd\DocUCheck Service). Run the DocUCheckServiceConfig.exe as an admin

  12. Configure settings to suit your environment as per the DOCUCHECK SERVICE SETTINGS section of this guide

  13. Once the settings have been configured, click the Add Service button

    2022-09-09_15-38-33.png

  14. Enter the credentials for the service login account, and click the OK button

    2021-08-06_11-49-11.jpg

  15. The account credentials will be validated

    2021-08-06_11-49-27.jpg

  16. Once the service is successfully installed, you will be asked if you want to start the service

    2021-08-06_11-49-53.jpg

  17. Once the service is started, a message will appear advising that the service has been started successfully

    2021-08-06_11-50-04.jpg

COMMAND LINE ARGUMENTS (OPTIONAL)​

The follow command line arguments can be passed to the MSI if required.

ARGUMENTPURPOSE
DBIDSets the Database ID that connects to Content Manager dataset to run the application
LICENSE_PATHSets the license that connects to the application
TEMP_PATHSets the temp path that connects to the application
UDF_NOTIFIER_URIThe 'Notifier Email Recipient' additional field URI
SEND_EMAIL_ON_SERVICE_STARTIf checked, the service will send an additional batch of reminder emails as soon as it starts.
EMAIL_FROM_NAMEThe name that appears as the sender of the email
FROM_ADDRESSThe email address that appears as the sender of the email.
MAIL_HOSTThe address of the email server
MAIL_PORTThe port of the email server

DOCUCHECK SERVICE SETTINGS​

  1. Run the DocUCheckServiceConfig.exe located in the folder the application was installed in. The DocUCheck Service Config window will display as shown below

    NOTE

    DocUCheckServiceConfig.exe requires Windows administrator privileges to run.

    2022-09-09_15-47-55.png

  2. Update the settings to suit your environment (details below)

  3. Click the Save button to save any setting updates

CONTENT MANAGER SETTINGS​

image.png

NAMEDESCRIPTION
DatasetThe Content Manager dataset that you wish DocUCheck to work with. This field is only enabled if the service is not currently installed. To change the dataset, first uninstall the service. You can then change the dataset and reinstall the service
LicenseThe local directory path your license file on the workgroup server.
Additional Field NotifierThe 'Notifier Email Recipient' additional field
Temp File PathThe folder to temporarily store the tr5 files in
Log File PathThe folder to store the log files in
Register Logs to CMIf checked, logs will be stored in Content Manager.
Log Record TypeThe record type used to save the logs in Content Manager. This field is only enabled if the Register Logs to Content Manager is checked. The Record Type must not have any mandatory fields other than container, author, and title.
Send Email On Service StartIf checked, the service will send an additional batch of reminder emails as soon as it starts.

EMAIL SETTINGS​

2022-02-24_11-14-02.jpg

NAMEDESCRIPTION
Use Custom Email SettingsIf checked, the email settings will be set manually. If unchecked, the content manager email settings will automatically be retrieved by the configuration tool as well as the DocUCheck service each time it runs. This functionality requires the DocUCheck service to be installed on a Content Manager workgroup server.
Email From AddressThe email address that appears as the sender of the email.
Email From NameThe name that appears as the sender of the email
Email ServerThe address of the email server
Email Server PortThe port of the email server
Escalated ContactThe email address of the person(s) that will be notified when records are checked out past the escalated period selected. The escalated contact will receive a list of records and who currently has them checked out.

TIMER BASED EMAIL SETTINGS​

2022-02-24_11-14-59.jpg

NAMEDESCRIPTION
Earliest Email TimeThe earliest time that a reminder email can be sent
Latest Email TimeThe latest time a reminder email can be sent
Notification DurationThe length of time that a record is checked out before sending an email to the person it is checked out to.
Escalation DurationThe length of time that a record is checked out before sending an email to the escalated contact notifying of the extensive checked out time.
Polling IntervalThe length of time between polling cycles. This will be the amount of time between emails sent
Daily Email TimeThe time of day to send email reminders. This field is only available when the polling interval is set to Days.

EMAIL TEMPLATE SETTINGS​

image.png

NAMEDESCRIPTION
Email TemplateThe body of the email that will be sent by the DocUCheck service. The email can include optional keywords (as detailed in the following table) that, if included will replace relevant information. Please note that the below tags are case sensitive and need to uppercase

KEYWORDS

NAMEDESCRIPTION
{USER}The name of the email recipient
{DURATION}The length of time that a record is checked out before sending an email to the person it is checked out
{RECORDS}A list of the records that have been checked out by the email recipient for longer than the value specified in the Duration field. This tag will list the number and title of all records currently checked out to the user each on a separate line.
{SENDER}The name specified in the field Email From Name

SETTINGS BUTTONS​

BUTTONDESCRIPTION
2022-09-09_15-49-37.pngClick this button to save the current settings and install the DocUCheck service. You will be prompted to enter the credentials for the service login account. If the service installs successfully you will be given the option to start the service.
2022-09-09_15-52-17.pngClick this button to Uninstall the DocUCheck service.
image.pngClick this button to save the current settings. If the service is currently installed, you will be given the option to start or restart the service.
image.pngClick this button to discard unsaved changes and close the DocUCheck config tool.

INSTALLING FYB DOCUCHECK POP-UP​

AUDIT POLICY​

The DocUCheck Pop-Up relies on events being logged whenever programs open or close. This needs to be enabled in Audit Policy by setting Audit process tracking to Success. This can be set on a per machine basis, or through group policy

image.png

INSTALLATION​

The docucheckpop-up MSI will:

  • Deploy the installation files
  • Setup the scheduled task

To install the DocUCheck Pop-Up, follow these steps:

  1. Create an appropriate folder to house the license file (.lic) on the server.

  2. Create a network share of this folder. For Example: \server\FYBAddins\License

  3. Move the license file into the license folder

  4. Run command prompt as an administrator and launch the docucheckpop-up-xxx.msi

  5. Click the Next button

    image.png

  6. On the Configuration Settings screen, enter the below information. Click the Next button

    image.png

    FieldValue
    Dataset IDThe two character dataset identifier (e.g. FD)
    License PathShared path to the license file on the server, including the .lic file
    Launch On CM CloseToggle to show DocUCheck when closing CM
    Launch On CM OpenToggle to show DocUCheck when launching CM
  7. On the Destination Folder screen enter the installation folder for DocUCheck Pop-Up.

  8. Click the Next button

    image.png

  9. On the confirm installation screen, click the Install button

    image.png

  10. The Installation will commence

    image.png

  11. Once the installation is complete, click the Finish button

COMMAND LINE ARGUMENTS (OPTIONAL)​

The follow command line arguments can be passed to the MSI if required.

ARGUMENTPURPOSE
DBIDSets the Database ID that connects to Content Manager dataset to run the application
LICENSE_PATHSets the license that connects to the application
LAUNCH_ON_CM_CLOSE'1' to show DocUCheck when closing CM
LAUNCH_ON_CM_OPEN'1' to show DocUCheck when launching CM

DOCUCHECK POP-UP SETTINGS​

Note

The DocuCheckConfig.exe can only be run by administrators

To modify the DocUCheck Pop-Up settings, complete the following steps:

  1. Run the DocUCheckConfig.exe executable located in the chosen installation directory

  2. Update the settings to suit your environment

    2021-08-06_11-58-15.jpg

    NAMEDESCRIPTION
    DatasetThe Content Manager dataset
    LicenseThe shared path to the license file on the workgroup server
    Launch Pop-Up on CM StartOn checked, the DocUCheck Pop-Up will open with Content Manager opens.
    Launch Pop-Up on CM CloseOn checked, the DocUCheck Pop-Up will open with Content Manager is closed.

UNINSTALLING DOCUCHECK SERVICE USING THE INTERFACE​

To uninstall the DocUCheck Service please follow the steps below:

  1. Run the DocUCheckConfig.exe executable

  2. Click the Uninstall button

    Note

    If the Uninstall button is disabled, please skip to Step 6

  3. A message box will appear to say the service has been uninstalled,

  4. Click the OK button

    2021-08-06_11-48-17.jpg

  5. Close the DocUCheck config tool

  6. Navigate to Windows Apps & features

  7. Navigate to FYB DocUCheck Service

  8. Click the Uninstall button

    image.png

UNINSTALLING DOCUCHECK SERVICE MANUALLY​

To uninstall the DocUCheck Service using the command prompt, please follow the steps below:

  1. Open the control panel on the server the service is installed on

  2. Locate FYB DocUCheck Service and select Uninstall

  3. Run Command Prompt as an administrator

  4. Type sc delete "FYB DocUCheck Service ([Dataset ID])"

    2021-08-06_9-50-08.jpg

  5. The Service will now be uninstalled and deleted

UNINSTALLING DOCUCHECK POP-UP​

  1. Navigate to Windows Apps & features

  2. Navigate to FYB DocUCheck Pop-Up

  3. Click the Uninstall button

    image.png