Skip to main content
Skip table of contents

Systems

Why does ZigiOps need a System?

A System is a configuration object containing the connection details about a product you want to integrate. The Systems page is a repository of all system instances in your current ZigiOps instance. Each system requires a set of configuration details, such as URL, port, username, and password. The configuration of the different systems varies.

Adding a System

  1. Navigate to Systems, which will display the list of available systems.

  2. Click the Add System → System Types button and select the desired system.

  3. Input the required connection and authentication details and click the Save button.

    image-20250915-122750.png

Removing a System

  1. Navigate to Systems, which will display the list of available systems.

  2. Click the Options → Delete of a System to remove it from your ZigiOps instance.

    image-20250915-123129.png

Exporting a System

  1. Navigate to Systems, which will display the list of available systems.

  2. Click the Options → Export of a System to export its configuration as a configuration file. The system’s configuration file can serve as a backup or be imported into another ZigiOps instance.

    image-20250915-122406.png

Importing a System

  1. Navigate to Systems, which will display the list of available systems.

  2. Click the Add System → Import button and select the desired system configuration file to import it to your ZigiOps instance.

    image-20250915-122724.png

Reloading a System Schema

Forces ZigiOps to discard the currently loaded schema and retrieve it again to detect new changes on the corresponding system instance, such as newly added custom fields.

Note that reloading the schema discards the locally stored schema files and requires the integration user to have sufficient permissions.

  1. Navigate to Systems, which will display the list of available systems.

  2. Click the Options → Reload Schema of a System to force reload (re-retrieve) its schema.

    image-20250915-122452.png

Downloading a System Schema

Downloads the system schema as a file for backup or troubleshooting purposes.

A copy of the schema is also available under the <ZigiOps>/conf/settings/schemes folder of each ZigiOps installation, introduced with the ZigiOps 2023.04.1.366 release.

  1. Access the ZigiOps web console.

  2. Navigate to Systems, which will display the list of available systems.

  3. Click the Options → Reload Schema button to download the schema as a file.

    image-20250915-122529.png

Test Connection

Verifies connectivity and authentication against a System instance using the provided connection details.

  1. Navigate to Systems, which will display the list of available systems.

  2. Select the desired connected system and click the Test button to test the connection.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.