Skip to main content

Connectors

System connectivity guide

A connector defines how NIM reads data from a system and, when supported, writes account, group, and membership changes back to it.

You add and configure a system in NIM Studio. Its connector is the underlying adapter that determines available tables, connection behavior, and supported operations. Multiple configured systems of the same type use the same connector definition.

What a connector controlsDirect link to What a connector controls

NIM capabilityHow the connector contributes
CollectionDefines the tables NIM can read, the data transformations needed to import them, and connection behavior.
Data modelMakes the system’s available tables and columns available for selection, keys, and relations.
ProvisioningDefines supported resource operations for mappings, such as create, update, delete, and group membership changes.
System roleDetermines what a system can do in source and target contexts.
Use supported integrations firstStart at Integrations to find connector-specific setup instructions and supported operations. It is the fastest and most supportable way to connect a known system.

Connector formatsDirect link to Connector formats

FormatBest suited forWhere to start
RESTSystems that expose a REST API.REST connector documentation
PowerShellSystems that expose a PowerShell API or require PowerShell-based automation.PowerShell connector documentation
FileFlat-file imports, such as the supported CSV File system.CSV File integration

Official connectors are supplied with NIM and stored outside NIM Studio in C:\Program Files\Tools4ever\NIM\sysconfig. They are not intended to be directly edited. If a supported connector is missing an operation, table, or attribute, contact Tools4ever Support before extending it.

Build a custom connectorDirect link to Build a custom connector

Build a custom connector when no supported integration meets a well-defined requirement and the target system offers a supported REST or PowerShell interface.

  1. Confirm a supported integration cannot meet the need, and document the required objects, operations, authentication method, and API constraints.
  2. Choose the connector format: REST for HTTP APIs or PowerShell for a PowerShell API or automation surface.
  3. Model the system’s tables, keys, and relations so NIM can collect and interpret its data.
  4. Add only the write operations that the system supports and your workflow requires.
  5. Validate collection and each write operation with non-production data and accounts before release.

Build a REST connector

Model REST resources, requests, operations, connection settings, and authentication for an HTTP API.

Open REST connector docs →

Build a PowerShell connector

Use PowerShell to collect and provision data with a system that exposes a compatible automation interface.

Open PowerShell connector docs →
warning

Custom connectors and scripts are your organization’s responsibility. Validate them with non-production accounts and data before they can create, update, or delete production records. Tools4ever support covers connectors developed by Tools4ever.

Next stepsDirect link to Next steps

Last updated on