Developers
Developer guides
Build reliable integrations and automation for NIM—from API connectors and PowerShell modules to JavaScript calculations and App scripts.
Custom connectors and scripts are used at your own risk. Validate them with non-production data and accounts before deployment. Tools4ever support covers connectors developed by Tools4ever.
Choose your development pathDirect link to Choose your development path
REST connectors
Use NIM's REST engine for API integrations, especially when the system must be both a source and a target.
PowerShell connectors
Use a vendor module, Windows management surface, SDK, or custom PowerShell automation.
Javascript Guidelines
Choose and test calculations in system columns, filters, variables, and App properties.
App TypeScript scripts
Add focused business logic, validation, and lookups inside a NIM App.
Make the right choiceDirect link to Make the right choice
| Your goal | Recommended approach |
|---|---|
| Collect or provision through a REST API | REST connector |
| Integrate through PowerShell commands or a vendor module | PowerShell connector |
| Calculate values in a system table, filter, variable, or App property | Javascript Guidelines |
| Add custom logic inside a NIM App | App TypeScript script |
| Inspect requests, responses, or authentication failures | Fiddler proxy troubleshooting |
Develop connectors safelyDirect link to Develop connectors safely
Start read-only. First make the connection test pass, collect one table, and validate its identifiers and resources. Add create, update, or delete only after the API permissions, required fields, expected responses, and rollback behavior are clear.
For REST connectors, use the public REST Connector JSON Schema for editor validation and autocomplete. The Tools4ever NIM GitHub organization includes maintained connector examples.
NIM TypeScript scripts run only from within a NIM App. They cannot be triggered by connectors, mappings, jobs, filters, or other NIM features outside the App runtime.
Install and refresh a REST connectorDirect link to Install and refresh a REST connector
A REST connector is one JSON file. Place it in:
C:\ProgramData\Tools4ever\NIM\config\connectors\rest
Its filename, without .json, becomes the system type shown in NIM Studio and is case-sensitive. After editing it, restart the NIM service or use Configuration → Connectors → Reload Connector for that system type.
Credentials do not belong in the connector file. Store them through NIM's encrypted connection configuration and reference those values from the connector.
Before productionDirect link to Before production
- Test expected, empty, invalid, and high-volume responses.
- Use disposable records for every write operation.
- Mask secrets and personal data in logs.
- Document required API permissions and the connector owner.
- Keep connector resource names, keys, and connection-field names stable after mappings depend on them.