Configuration and logs

UP Connector configuration

The main configuration file is created automatically by installation script. There is not need to update it manually. Following description is important only for validation in case of troubles.

Configuration file for UP Connector is local.json file stored in the UP Connector directory:

<install_dir> \UPConnector\configuration\

It can look like this:

local.json example
{
"DebugOptions": {
"FakeOutputDevices": false
},
"JobDeliveryOptions": {
"MaxIppVersion": "1.1",
"ForcePrintJobOperation": "false",
"DefaultIppVersion": "1.1"
},
"ConnectorHubOptions": {
"ConnectorHubUri": "https://upconnectorhuburi.azurewebsites.net",
"TenantId": "<TenantGUID>",
"ClientId": "<ClientGUID>"
}
}

You can set FakeOuputDevices to true if you want to debug the IPP messages and printing by connector itself. The jobs will be stored in folder:

C:\Windows\System32\config\systemprofile\.universal-print\

The ConnectorHubOptions key contains an object, where you can find links into all important Azure resources. You can switch here into which environment the connector is connected.

Token cache

There is a token cache file where the authentication to the Azure services is cached. It is stored in C:\Windows\System32\config\systemprofile\.universal-print\tokenCache.enc and if you delete it the connector will ask you to perform some action to authenticate again (in it's logs).

The desired state and printer management

Desired state file can be found here:

C:\Windows\System32\config\systemprofile\.universal-print\desiredState.json

In this file, you can find ProxiedPrinters JSON key, which value is an array of printer object. Each printer has following attributes:

Proxied printer object example
{
"PrinterId": "",
"DeviceName": "My Sample Printer",
"IsEnabled": true,
"PrinterUri": "https://localhost:631/",
"RegistrationId": "<RegistrationIdGUID>"
}

Right after the installation of the UP Connector, this printer is generated and registered into Universal Print.

If you want to add a new printer just add a new object into the ProxiedPrinters array. Just pick a different name for it, because Universal Print can have problems with the same names for multiple printers. The registration identification can be blank, it will be generated on the server site.

Changing the existing proxied printer

We do not recommend to change any existing printer, just create a new one with different name.

Logs

The logs of the UP Connector installation are e.g. in <install_dir> \UPConnector\logs\install.log

The logs of the UP Connector are e.g. in <install_dir> \UPConnector\logs\upconnector.log . At the beginning of the log file there is the connector's configuration, so you can check if the connector is configured properly and you can see the IPP messages here.

How to enable verbose logging

  1. Open logging.json located at <install_dir>\UPConnector\configuration\

  2. Find category # MinimumLevel

  3. Change the following value:

    • "Default": "Debug" to "Default": "Verbose"

  4. Restart YSoft SafeQ Universal Print Connector service