Installing Exo Business Services

Once the Exo Business system is set up, you can install supporting services for the Exo API and Exo Email Service using the Exo Business Service Setup Wizard, Exo Business Services Installer.msi. This installer is supplied with the main Exo Business installer. It must be run on a server that already has Exo Business installed on it, and must be run from an account with administrative permissions.

To perform the installation:

  1. Double-click on the installer to run it. The welcome screen appears:

  2. Click Next. The MYOB Exo End User Licence Agreement is displayed:

  3. Tick I accept the terms in the Licence Agreement and click Next to continue.

  4. Select which components to install. Choose from:

    • The Exo API Service
    • The Exo Messaging Service

    Note: The API configuration utilities are always installed (see below).

  5. The install location is displayed at the bottom of the window. Click Browse to choose a different location if necessary.

  6. Click Next. You are now ready to install the Exo Business services.

  7. Click Install to begin the installation. The progress of the installation is displayed:

  8. Once the installation is complete, click Finish to close the wizard. You can choose to open the Exo Business Service Configuration utility to set up details of the Exo API services.

    Note: The Exo Business Service Configuration utility is installed in the same location as the Exo API services. You can run the utility (MYOB.ED.EXO.Cloud.ServiceConfig.exe) from this location at any time.

Setting up the Services

The Exo Business services must be set up for each Exo Business database connection, using the MYOB Exo Business Service Configuration utility. This utility, MYOB.ED.EXO.Cloud.ServiceConfig.exe, can be run immediately after installation, or you can open it from the Exo services install directory at any time.

Note: All setup must be performed on the server that the Exo Business services are installed on, using an account with administrator privileges.

The utility displays configuration settings for the following services:

  • Exo API Configuration
    • API Services - this is the main Exo API service.
    • API Provider Services - this service connects the Exo API to the online relay. This service is only needed this if you want to communicate with the Exo API remotely.
  • Exo Business Alerts Configuration
    • Message Services - this is the Exo Business messaging (email) service.

To configure an API service, select an Exo Business database connection, then click the relevant Add Service button. For the API Service, you must also enter a Base URL, which is the location and port the API is accessible on (the default should be suitable in most cases, unless you want to use a different directory and/or port).

Note: For local API access, ensure that your firewall is configured to allow the relevant ports, services and/or applications.

To validate that the Exo API has been successfully installed and set up, navigate to the Base URL in a web browser or REST client to see a list of available endpoints.

The configuration process for the messaging service is slightly different; where the API services create a separate instance for each Exo Business database connection, the messaging service has a single instance, which can have multiple connections to it.

To install the messaging service instance, select a database connection and click Add Connection. This adds the service and sets up a connection to the selected database. To add new connections, select them from the EXO Connection dropdown and click Add Connection.