This article is for experienced users only and troubleshooting purposes. Modify files at your own risk. To make any changes work, you will need to stop and restart the application.
Sections in this article:
Logging
nShift ApportConnect logs events in a file named application.log located in the installation directory. If you are unsure where nShift ApportConnect is installed, refer to the Installation section in the article Downloading and installing ApportConnect .
If something goes wrong, you may want to send the log file(s) to nShift's Customer Support for review. By default, the log level is set to INFO, which logs only the most important events and errors. You can change the log level to DEBUG under Settings > ApportConnect settings > General Settings. This will cause nShift ApportConnect to log all events and errors with more detailed information, useful for debugging and troubleshooting.
You can also send the log file directly to nShift's Customer Support by clicking Help & Support > Contact nShift, filling out the form, and clicking Send. The log file will be automatically attached.
Settings file
The program and user settings are saved in two separate files: user_settings.json and program_settings.json, located in the same directory as the logfile. (The installation directory). This file contains information about the user's setup in nShift ApportConnect, as well as which server to send files and fetch documents from.
Proxy settings
nShift ApportConnect supports the use of an HTTPS proxy for all outgoing communication. To activate this feature, navigate to Settings > ApportConnect settings > Proxy Settings. Enable the proxy and enter the proxy address and port. Be sure to restart the application after saving your changes.
Headless mode
You can run nShift ApportConnect in headless mode by passing the program argument -headless when starting the program. It will run as a process in the operating system without displaying a GUI. If you run the program from a terminal, it will display all output (logging) directly to you. Additionally, you can input basic commands in the terminal to get more information and perform manual prints. To see the available commands, type help to display a list of commands.
Running as a Windows Service
Note: Because of nShift ApportConnect's platform independence, native code to run it as a Windows Service has not been included. However, there is a straightforward method to run nShift ApportConnect as a service using a 3rd party library.
nShift cannot take responsibility or ensure full functionality of 3rd party applications.
This example will be using the program called NSSM (Non-Sucking Service Manager) to install nShift ApportConnect as a Windows service.
- Download NSSM at (http://nssm.cc/download)
- Unpack the files and select the win32 or win64 folder, depending on your OS architecture.
- Copy nssm.exe from the appropriate folder (selected in step 2) to any location on your computer (or C:\Windows\System32 if you want it to be globally accessible)
- Start a Windows command prompt with administrator privileges.
- (Skip this if nssm.exe is in C:\Windows\System32). Navigate to the location of nssm.exe in the command prompt.
- Type
nssm.exe install “ApportConnect”and press Return/Enter.
- You should be prompted with a new window. In Application Path, browse and select the installed ApportConnect.exe.
-
You can also configure various other options in this program, such as the user to run the service as, process priority, shutdown methods, automatic restart, and more. For detailed information, refer to the NSSM usage guide for more information: NSSM - the Non-Sucking Service Manager.
-
When you have finished configuring the service, click Install service.
-
To edit the service later via NSSM, open a command prompt and type
nssm.exe edit "ApportConnect".
Endpoints
The following endpoints are used by ApportConnect:
- https://service.web-ta.net/integration/api/printr/print
- https://service.web-ta.net/integration/api/printr/incoming
- https://service.web-ta.net/integration/api/printr/lookup
- https://service.web-ta.net/integration/api/printr/version/getnew
- https://service.web-ta.net/integration/api/printr/support
Port: 443 (https://)