Skip to main content

FYB Software Scheduler Service 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.

INSTALLATION COMPONENTS​

The following installation components are required to ensure full functionality of the FYB Software Scheduler Service:

  • FYB Software Scheduler Service MSI allows the set up of the windows service. This is a server-side deployment

INSTALLING FYB SOFTWARE SCHEDULER SERVICE​

Warning

Before running the MSI ensure that all prerequisites are complete. Including deploying the .NET 8 SDK and Hosting Bundle.

To deploy the Net Core SDK and Hosting Bundle to the server, follow these steps:

  1. Install the latest .NET 8 SDK (x64) found here

    NET SDK 8.png

  2. Install the latest ASP.NET Core 8 Runtime Hosting Bundle found here

    NET Hosting Bundle 8.png

  3. Once both executables have been installed, complete a full server restart to allow for .NET 8 to bind to IIS. If a server restart is not possible an IIS reset can be completed with the following CMDs from an elevated command prompt.

    • net stop was /y
    • net start w3svc
    • iisreset
    Note

    To check that the SDK has been attached to the hosting bundle, open Command Prompt and type dotnet --info

    2022-06-03_17-02-10.png

INSTALLATION​

The FYB Software Scheduler Service MSI will:

  • Deploy the installation files
  • Setup the windows service

To install the FYB Software Scheduler Service Application, follow these steps:

  1. Run command prompt as an administrator and launch the fybsoftwareschedulerservice-10x.msi
  2. The MSI will complete its process

CONFIGURATION​

To configure the FYB Software Scheduler Service, complete the following

  1. Go the installation path, this will be within the Program Files directory > FYB Pty Ltd > FYB Software Scheduler Service

    image.png

  2. Within the appSettings.json update the Target URL to point to the required FYB application/s.

    image.png

    NAMEFUNCTIONALITY
    Target UrlsA list of all FYB Applications that require for a ping to be sent to the URLs listed. You can add multiple URLs by providing a comma between each URL. Ensure each URL is surrounded by quotation marks
    Interval MinutesHow often in minutes a ping should be sent to the application
    Ping On Restart OnlyAbility to send a ping to the URL only when it identifies the server has restarted. This will only send the ping once per restart. It will not ping again until another restart has occurred.
  3. Save the appSettings.json file.

    What can I ping?

    Any FYB application that contained a scheduled process can be set up for the FYB Software Scheduler Service. This includes all FYB apps, platforms and connectors.

STARTING THE WINDOWS SERVICE​

By default upon installing the FYB Software Scheduler Service, the windows service will be turned off.

  1. Go to Services application

    image.png

  2. Search for the 'FYB Software Scheduler Service', right click on the service > Start

    image.png

    Changes to the appSettings.json

    If any changes need to occur to the app settings, the windows service must be stopped first before making any changes, and restarted again after the change has occurred

UNINSTALLATION​

To uninstall the FYB Software Scheduler Service manually please follow the steps below:

  1. Navigate to control panel

    controlpanel.jpg

  2. Click on the Uninstall a program option

    uninstall.jpg

  3. Locate FYB Software Scheduler Service in the list of Programs and feature

  4. Right click on FYB Software Scheduler Service and click on the Uninstall button

  5. If a warning Prompt appears, click on the Continue button

    warning.jpg

  6. Click the Yes button

    2021-01-22_9-25-25.jpg

  7. The uninstallation process will commence

  8. Open Command Prompt as an Administrator once the uninstallation is completed

  9. Enter the following commands SC STOP FYBSoftwareSchedulerService SC DELETE FYBSoftwareSchedulerService

The windows service will be deleted.