The Remote Access Tool (RAT) provides a centralized interface to manage and launch remote connections to servers within your network. To make these connections visible in the Desktop Client, you must define them using a specific configuration file named port_forwarding.json.

Understanding Connection Types

The Remote Access Tool (RAT) handles different services in two distinct ways; Tunneled or Independent. Understanding which category your service falls into is essential for maintaining a stable connection.

• Port-Forwarded Services (Tunneled): For protocols like SSH, VNC, and Windows RDP, the RAT tool acts as a bridge. It creates a secure tunnel between your Desktop Client and the Media Server. Because the Desktop Client is actively managing this background data flow, the Client must remain open for the duration of your remote session. If you close the Client, the tunnel collapses and the connection will drop.

• Independent Services (Placeholders): Services like TeamViewer, AnyDesk, and NoMachine operate on their own cloud infrastructure. In these cases, the RAT tool functions primarily as a secure "information tile" to display the necessary credentials (login/password) for your team. Since these applications do not rely on the Media Server to route their data, you do not need to keep the Desktop Client open once the connection is established.

Important Access Note

Permissions Requirement: Access to the Remote Access Tool settings and connection tiles is restricted. Only users assigned to the Site Administrator or Power User permission groups can view or modify these settings. If a user cannot see the RAT tiles despite a valid JSON file, please verify their account permissions in the User Management settings.

JSON Configuration Basics

The RAT relies on a strictly formatted JSON (JavaScript Object Notation) file. If the file contains even a minor syntax error, the Desktop Client will fail to parse it, and no remote access tiles will appear in the Server Settings.

Data Type Rules:

• Strings (Text): Must be wrapped in double quotes (e.g., "name": "RDP").

• Numbers: Must be plain digits without quotes (e.g., "port": 3389).

• No Empty Values: You cannot leave a value blank. If a key is present, it must have a valid value following the colon.

Correct Syntax Example:

[
    {
        "name": "RDP",
        "port": 3389,
        "login": "admin",
        "password": "123"
    },
    {
        "name": "SSH",
        "port": 22,
        "login": "root",
        "password": "456"
    }
]

Validation and Troubleshooting

Because JSON is not "smart" enough to guess missing data, a single typo can break the entire display.

How to verify your file:

1. Copy the entire content of your port_forwarding.json file.

2. Go to JSONLint.com or a similar website. 

3. Paste your JSON content and click Validate JSON.

4. If there is an error, the tool will highlight the specific line that needs fixing.

Common Formatting Mistakes:

Once your JSON is validated, save it as port_forwarding.json and move it to the appropriate directory based on your OS:

• Windows: C:\Windows\System32\config\systemprofile\AppData\Local\Network Optix\Network Optix Media Server

• Linux: /opt/networkoptix/mediaserver/var/

Important Considerations

• Credentials: The login and password in the JSON should be the credentials for the chosen application, not your Nx Witness login.

• Persistence: For services like RDP or SSH, the Desktop Client must remain open to maintain the background port-forwarding task.

• Security: Remote Access is automatically disabled if the Site Security setting is set to "High."

• Dynamic Ports: The remote connection port changes every time the Desktop Client is restarted. Always use the port currently displayed in the RAT tile.