Chicane Enterprise Module SDK v1
Your tools. Inside Chicane.
Build screens, dashboards and workflows for your customers using HTML, CSS and JavaScript, with the fleet information their users are already permitted to see.
What is the Enterprise Module SDK?
The software SDK lets developers extend Chicane Enterprise with account-installed add-ons. Create a specialist asset dashboard, personal fleet notes or an equipment-status workflow alongside the tools teams already use. Modules can add their own screens, badges and map icons.
Chicane supplies authenticated services without giving module code the user's session token. An account administrator reviews the module's identity and requested permissions before enabling it for selected users. Existing asset permissions still apply.
Fleet data, settings and maps
Read permitted asset snapshots and supported digital-input telemetry, and keep module-owned settings and records in user or account scope. Available voltage, input readings and observation times let a module distinguish a fresh reading from stale or missing information.
Location and history capabilities use their own permissions. Maps, recorded-trail playback and historical charts are demonstrated by Asset Pulse with the matching host update. Available data depends on the device, account permissions and deployed SDK version.
Working examples: Fleet Notes and Asset Pulse
Fleet Notes is the starter for reading accessible assets and saving personal notes. Asset Pulse expands this into Running, Standby, Attention and Unknown cards, configurable input rules, voltage and freshness checks, follow-ups, badges and maps.
The local preview uses fictional assets and in-memory settings. It helps develop the interface without connecting to a live account; it does not reproduce production authorisation or server-side changes.
How to get started
- Confirm access to a compatible Chicane Enterprise deployment and the SDK files with our team.
- Open AddOns → Modules → SDK developer documentation in Enterprise for the full API guide, permissions and packaging instructions.
- Copy the template, choose your module identity and request only the capabilities you need. No package manager or framework is required; framework-based code must be bundled into local files.
- Preview with sample devices, then package the HTML, CSS, JavaScript and manifest into a module ZIP.
- As an account administrator, review the requested permissions, install disabled, select users and enable the module. Test with the intended users and devices.
Where custom server work fits
Browser background entries run while an authorised Enterprise browser tab is open. They are not a continuous monitoring service or server scheduler. Continuous jobs and external integrations require an explicitly supported, reviewed server service.
For device protocols, media processing or an integration outside the SDK contract, explore our Telematics Middleware, developer APIs and custom integration work.