Developer FAQ
This page answers common technical questions about customizing and integrating time cockpit.
Note
Examples and references in this FAQ are meant as starting points. Always verify custom scripts, queries, and integrations in a development environment before using them in production.
Data Model and Lists
Where should I start if I want to understand the standard data model?
Start with these pages:
How can I create custom fields, entities, lists, or forms?
Use the data model customization documentation:
Queries and Calculations
How do I query time cockpit data?
Use TCQL for queries inside time cockpit and the Query endpoint if you want to execute TCQL over the Web API.
Start here:
How do I work with overtime, working time, or holiday calculations?
Use the built-in working-time functions and the existing attendance entities as your reference.
See:
How can I analyze project budget or profitability data?
Use the standard budgetary control implementation and related entities as your reference point.
See:
Web API and Integrations
How do I access time cockpit from external applications?
Use the Web API.
Start with:
Should I use OData or the Query endpoint?
Use:
ODatafor standard CRUD-style access to entitiesQueryif you need TCQL, aggregations, or more complex projections
How can I export data for external systems or reporting tools?
Depending on the scenario, use:
Automation and Scripting
How do I automate workflows in time cockpit?
The standard options are:
- Actions for user-triggered logic
- Triggers for logic on save
- Automating Scripts for scheduled or repeated execution
How do I implement approval or notification workflows?
Approval workflows are usually implemented with a combination of:
- entity fields for status and approver information
- triggers for automation and notifications
- actions for approve or reject steps
- permissions that control who can see or execute the workflow
See:
Reporting
How do custom reports work in time cockpit?
Custom reports are based on SSRS and typically work on top of a time cockpit list.
See:
Can I combine multiple sources in one report?
Not directly in the standard reporting workflow. A common approach is to prepare the data in a dedicated list first and build the report on top of that list.
Security and Permissions
How do I restrict access to data by role or department?
Use entity permissions, role assignments, and where needed named sets or similar row-level patterns in the data model.
See:
How do I migrate to the newer default permissions model?
See:
Examples and Further Reading
Where can I find practical examples?
Useful starting points:
- Budgetary Control Implementation
- Scripting Overview
- Use C# to Access Time Cockpit API
- Import Data From CSV
- Export Data to Microsoft Excel
Need More Help?
If you are looking for end-user workflows instead of technical customization, continue with For Users.