Skip to main content
  1. Fenwick Support
  2. Business Central Apps
  3. Print-It with Cloud Companion

Installing the Cloud Companion (Server Edition) agent

Narada Ellis
  • Updated

The Server Edition agent for Cloud Companion can be installed using the steps in this guide.

About the agent

The Cloud Companion agent runs on an On-Premises Windows server to connect to locally shared printers.

For Business Central hosted by Microsoft or Fenwick, the service provides a path to print to local printers which are not directly accessible.

CloudCompanionPrintingArchitecture.png

The agent doesn't require any port configuration, though must be able to contact the internet (at minimum TCP 443). If your network has restrictions on outbound connections, then exceptions must be configured to allow the agent to connect.

Server Agent Setup

You can install the agent on any networked server. We recommend avoiding installation on Domain Controllers. A dedicated machine is not necessary. You'll want to use a machine that meets the following requirements:

Installing the Agent

The agent installation will require administrative permissions and a service account.

Please raise a support request to receive your installation files, and for any assistance required with your installation.

  1. Run the software installer
  2. Follow the instructions on the installer to proceed with the installation.
  3. On the Agent Registration Information screen, enter the client ID and client key provided by Fenwick Software.
  4. On the Service Account Information, you will be prompted for service account credentials, or to use the built-in Network Service account

    Note: You need to specify the service account with the full name including prefix such as DomainName\UserName or ComputerName\UserName. See below for more information about the service account.

  5. Once done, choose Next and continue with the installation

After installation, install the Ghostscript and/or NiceLabel dependencies described below, if applicable.

Service Account Requirements

If you use a dedicated service account

  • Enter the account name into the installer using the prefixed name: DomainName\UserName or ComputerName\UserName (if it is a local computer account)
  • You must ensure that the service account has log on as a service enabled. You may assign this permission manually, or cause it to be automatically assigned by first installing the agent as Network Service and then updating the user account on the service through the Windows services list
  • If you are using PDF report printing functionality, the service account must be a local administrator
  • The service account password should be set to not expire. If the password is changed, then the credential needs to be updated through the Windows services list

If you use the built-in Network Service account

  • PDF report printing functionality may not work properly

In both cases (Network Service or dedicated service account)

  • The account must have network permissions to the printers you wish to use via Cloud Companion

A managed service account (MSA or gMSA) can also be used. First, run the installer using the Network Service option, and then set the account manually afterwards via the Windows services list.

Checking the Print Service

The installer will create a Windows service Fenwick Cloud Companion (Service Edition) in your server/local machine.

To check on the status of this service:

  1. Open the Start Menu & search for services.msc
  2. On the Services list, navigate to the Fenwick Cloud Companion (Service Edition) service entry.
  3. If the status of the service is not Running, right click on the entry and start the service. Ensure that the service is Startup Type is not set to Disabled.

Ghostscript for PDF/Report Printing

If you will use report printing via Cloud Companion the reports will be sent in PDF format and Ghostscript must be installed. Ghostscript can be downloaded here. Obtain the AGPL version.

NiceLabel for Label Printing

You will need to purchase the PowerForms Suite edition (or higher) to acquire a NiceLabel SDK license for label printing. 

Only the Print feature is required when installing NiceLabel. The Automation and Designer are not required to work with Cloud Companion, although this feature is needed if you would like to design or customise your own label on the Designer software. 

Outbound Firewall Exceptions

The Cloud Companion agent must contact Azure services to perform its functions. If your network has restrictions on outbound connections then exceptions must be configured to allow the agent to connect to certain IP addresses.

As these IP addresses vary, Fenwick will advise as needed.

Older Editions of Windows Server

While not supported, older versions of Windows Server may still work if TLS1.2 support is enabled:

  1. Enable TLS1.2 Client connections
  2. Updated Cipher Suites for Server 2008 and Server 2012

You'll require these patches if you experience an error similar to the one below:

System.Net.WebException: The underlying connection was closed: An unexpected error occurred on a send. ---> System.IO.IOException: Unable to read data from the transport connection: An existing connection was forcibly closed by the remote host. ---> System.Net.Sockets.SocketException: An existing connection was forcibly closed by the remote host

Installation on Multiple Servers

If you have multiple sites you may need to install the agent on multiple servers. The agent can be installed on multiple different networks (i.e. multiple sites).

Please raise a support request to get more information on this option.

Installation Errors

Some known causes of this installation error are:

  • Service account name has been entered without a prefix (DomainName\UserName or ComputerName\UserName)
  • Service account is missing 'Log on as a service' permission
  • The operating system does not support TLS1.2+

If you encounter an unexpected error during installation like the error above, please follow these steps to output the install log files: 

  1. Run Windows PowerShell as Administrator
  2. Type in and run in PowerShell:
    cd <path to the same directory as the .msi installer>
  3. Run this command (update the msi filename to match your version): 
    msiexec /i Fenwick.CloudCompanion.ServerEdition.Installer-x64-v.1.0.0.msi /l*v install.log
  4. This should automatically start up the installer again.
  5. Run through this installer and then reproduce the steps to get the error.
  6. Once you get the error again, exit out of the installer. There should be a .log file called "install.log" (which is a text file).
  7. Please send the file through to Fenwick App Support for assistance.

Managing which printers the agent can see

The agent will only be able to see printers which are available and installed for the user account that's running the service.

If you need to add printers as a specific user, you can use one of the following methods:

Run Printer Install Wizard as Another User

  1. Start a new command prompt, using Run As (Ctrl + Shift while right clicking)
  2. Enter rundll32 printui.dll,PrintUIEntry /il and complete the wizard

Install Printer for All Users of a Machine

To install a the printer for all users of a machine, you can install globally using this command:

  1. Start a new command prompt, as an Administrator
  2. Enter rundll32 printui.dll,PrintUIEntry /ga /n\\server\printer>
  3. Restart the Spooler service (net stop spooler, net start spooler)

Use Group Policy Printers via Computer Configuration

You can also use the Print Management to make managing printers in Group Policy simpler. We recommend deploying under the Computer configuration and not to a particular User.

  1. Create a new GPO policy
  2. Under Computer Configuration > Preferences > Control Panel Settings > Printers add the new printer.

Show available printers

If you run PowerShell as the service account (using psexec if you're using a Managed Service Account) the following command will show you a list of available printers:

get-WmiObject -class Win32_printer | ft name, systemName, shareName

Setting printer defaults

To change the printer driver defaults for all users and for network users connecting to a shared printer:

  1. Start > Run > "control printers" > OK
  2. Right click printer, select Properties.
  3. Go to Advanced tab.
  4. Click Printing Defaults button.
  5. Change the settings.

Troubleshooting the Agent

Log files

Check the logs and provide them to Fenwick.

For MSI-based installations, logs are available in the C:\ProgramData\Fenwick Software\Cloud Companion (Service Edition)\log directory.

Or, if the agent has been installed via the legacy ZIP-based method, the logs are available in the log subdirectory of the folder which contains Fenwick.CloudCompanion.ServerEdition.Service.exe.

If no log files are present, ensure that the service account has permissions to create and modify files in the directory.

No print jobs are printing

  • Ensure the Fenwick Cloud Companion (Server Edition) service is running
  • If a Windows service does not start, then
    • Ensure there is a valid credential set up on the service. If your service account password has expired, then the new password must be entered.
    • Ensure that the agent files are still present in the installation directory. If you are unsure of the installation directory, it can be checked by opening the properties of the Fenwick Cloud Companion (Server Edition) service and examining the Path to executable property.
  • If network errors are present in the log file, firewall rules may need to be created.
  • If nothing is printed or logged when Business Central prints labels, there may be a printer registration issue:
    • In Business Central, review the Server Printers setup area. The Cloud ID field is important and must correspond to a valid and active printer.
    • If multiple of the same printer are visible in the Cloud ID lookup, please contact Fenwick to have these cleaned up. Duplicates can occur if the agent's Client ID has been mistakenly deleted or regenerated.

The Log File contains "This managed library is running under 64-bit process and requires 64-bit Ghostscript native library installation on this machine!"

Fenwick Cloud Companion is attempting to print PDF documents but Ghostscript has not been installed, or the wrong version has been installed (32-bit/64-bit). Review the installation steps.

Advanced Printer Investigation

Log review may show that the agent is receiving print requests but physical printing is not working, or a failure is logged when agent communicates with Ghostscript, or the Windows print spooler, or NiceLabel.

Some issues which have been seen in the past are:

  • Ghostscript may not work with printer names which are 30 characters or longer
  • Secure Print may prevent printing until the service account user has been authorised to use the printer. Performing a Test Print in Windows printer management as the service account user may present a Secure Print authorisation modal dialog
  • PaperCut (and similar software) may halt print jobs at the spooler until authorised through the PaperCut software
  • Printers installed by a non-administrative user may not print
  • Invalid default tray settings in the printer's preferences cause a printer dialog to appear (which causes a timeout to occur when the agent prints, because the agent does not have a UI)

Some advanced techniques for identifying issues are below

When simulating printing or checking settings, it is important to test specifically as the service account user as there can be user-level settings affecting printing. Either log in to Windows as the service account user, or launch cmd as the service account user, and then launch printmanagement.msc

  • Ensure manual printing works via NiceLabel or a PDF viewer
  • Use the Test Print function in Windows printer management
  • Ensure the default printer preferences are correct (e.g. default tray, paper size, paper orientation)
  • Enable detailed print logging
    • Enable through Event Viewer > Applications and Services Logs > Microsoft > Windows > Print Service. Right click on the 'Operational' log and use 'Enable Log'
    • Low-level success and error information is logged here
  • Manually assign permissions to the service account on the print spooler folder C:\Windows\system32\spool\PRINTERS\
  • Restart the 'Print Spooler' Windows service
  • Re-install printers as the service account user
  • For NiceLabel printing, try the official NiceLabel printer drivers
  • Execute the print via the ghostscript executable in Powershell, to observe behaviour (Fenwick can assist)
    • Open Powershell as the service account user
    • Download a PDF of a BC report to test with
    • Prepare and execute a script similar to this (update the path to ghostscript, the printer name, and the path to the PDF)
      "C:\Program Files\gs\gs9.56.1\bin\gswin64.exe" -dPrinted -dBATCH -dNOPAUSE -dNOSAFER -dNumCopies=1 -dFIXEDMEDIA -dFitPage -sDEVICE=mswinpr2 -sOutputFile="%printer%PrinterNameGoesHere" -f C:\path\to\pdf.pdf

Agent Configuration Options

The configuration file C:\ProgramData\Fenwick Software\Cloud Companion (Service Edition)\config.json contains the following options:

  • PrinterCheckInterval sets how often the local printers will be re-checked for changes, and to be visible in Business Central.
  • PrinterBlackList is a set of regular expressions that are used to exclude printers from being made available through Cloud Companion. By default, PDF, XPS and Fax printers are excluded.

After making configuration changes, the service will need to be restarted.

Legacy ZIP-Based Distribution

Installation

Unzip the supplied ZIP package. The ZIP should be unpacked into a permanent directory, not a temporary location.

If Fenwick has not provided a pre-configured version for you, open the file config.json and specify these settings:

  • Under the CloudCompanionBrokerApi section
    • TenantId
    • ApiKey

Open an elevated command prompt, navigate to the unzipped directory and run:

Fenwick.CloudCompanion.ServerEdition.Service.exe install

You will be prompted for service account credentials. If you are using an account without a password, you may leave the password field empty in the authentication prompt. This will install a Windows service named Fenwick Cloud Companion (Server Edition)

Run this command to start the service after installation:

Fenwick.CloudCompanion.ServerEdition.Service.exe start

Upgrading

To upgrade to the latest version of the Cloud Companion agent:

  1. Stop the Fenwick Cloud Companion (Server Edition) Windows service.
  2. Take a copy of the existing installation directory as a backup.
  3. Unzip the new package into the existing installation directory, overwriting the files.
    • It is important that the AgentId.json file is kept. This file is created by the agent when it first runs and will not be overwritten when the new package is unzipped over the top of the existing files.
  4. Start the Fenwick Cloud Companion (Server Edition) Windows service.
  5. Perform a test print from Business Central.

Removal

  1. Stop the Windows Service.
  2. At an elevated command prompt in the installation directory, run: 
    Fenwick.CloudCompanion.ServerEdition.Service.exe uninstall
  3. You can delete the files from the directory once the service is removed.
 

Comments

0 comments

Please sign in to leave a comment.