Job
A job in Dime.Scheduler is the encompassing entity that groups tasks. This can be a service order header with multiple lines, a project with several tasks, a cargo transport with multiple containers, etc. A job record is mandatory for a task. In other words, you cannot create a task if the corresponding job record does not exist.
The following entities are exposed through the import service.
Upsert
Inserts or updates a job record.
| Name | Data Type | Default | Required | Description |
|---|---|---|---|---|
| SourceApp | nvarchar(30) | ✔️ | See API reference | |
| SourceType | nvarchar(10) | ✔️ | See API reference | |
| JobNo | nvarchar(50) | ✔️ | ||
| ShortDescription | nvarchar(50) | ✔️ | ||
| Description | nvarchar(MAX) | |||
| Type | nvarchar(50) | |||
| Name | nvarchar(255) | |||
| Category | nvarchar(100) | See API reference | ||
| TimeMarker | nvarchar(100) | See API reference | ||
| Pin | nvarchar(100) | See API reference | ||
| CustomerNo | nvarchar(20) | |||
| CustomerName | nvarchar(50) | |||
| CustomerAddress | nvarchar(MAX) | |||
| CustomerAddressGeoLong | nvarchar(50) | |||
| CustomerAddressGeoLat | nvarchar(50) | |||
| CustomerPhone | nvarchar(50) | |||
| CustomerEmail | nvarchar(50) | |||
| ContactNo | nvarchar(20) | |||
| ContactName | nvarchar(50) | |||
| ContactAddress | nvarchar(MAX) | |||
| ContactAddressGeoLong | nvarchar(50) | |||
| ContactAddressGeoLat | nvarchar(50) | |||
| ContactPhone | nvarchar(50) | |||
| ContactEmail | nvarchar(50) | |||
| SiteNo | nvarchar(20) | |||
| SiteName | nvarchar(50) | |||
| SiteAddress | nvarchar(MAX) | |||
| SiteAddressGeoLong | nvarchar(50) | Used to diplay the job on the map. | ||
| SiteAddressGeoLat | nvarchar(50) | Used to diplay the job on the map. | ||
| SitePhone | nvarchar(50) | |||
| SiteEmail | nvarchar(50) | |||
| SiteRegion | nvarchar(10) | Used in the geocoding process. | ||
| SiteStreet | nvarchar(255) | Used in the geocoding process. | ||
| SiteStreetNo | nvarchar(20) | Used in the geocoding process. | ||
| SitePostcode | nvarchar(20) | Used in the geocoding process. | ||
| SiteCity | nvarchar(50) | Used in the geocoding process. | ||
| SiteCounty | nvarchar(50) | Used in the geocoding process. | ||
| SiteState | nvarchar(50) | Used in the geocoding process. | ||
| SiteCountry | nvarchar(50) | Used in the geocoding process. | ||
| SiteFromNo | nvarchar(20) | |||
| SiteFromName | nvarchar(50) | |||
| SiteFromAddress | nvarchar(MAX) | |||
| SiteFromAddressGeoLong | nvarchar(50) | |||
| SiteFromAddressGeoLat | nvarchar(50) | |||
| SiteFromPhone | nvarchar(50) | |||
| SiteFromEmail | nvarchar(50) | |||
| SiteFromRegion | nvarchar(10) | |||
| SiteFromStreet | nvarchar(255) | |||
| SiteFromStreetNo | nvarchar(20) | |||
| SiteFromPostcode | nvarchar(20) | |||
| SiteFromCity | nvarchar(50) | |||
| SiteFromCounty | nvarchar(50) | |||
| SiteFromState | nvarchar(50) | |||
| SiteFromCountry | nvarchar(50) | |||
| BillNo | nvarchar(20) | |||
| BillName | nvarchar(50) | |||
| BillAddress | nvarchar(MAX) | |||
| BillAddressGeoLong | nvarchar(50) | |||
| BillAddressGeoLat | nvarchar(50) | |||
| BillPhone | nvarchar(50) | |||
| BillEmail | nvarchar(50) | |||
| BillRegion | nvarchar(10) | |||
| Importance | int | 0 | See API reference | |
| CreationDateTime | datetime | |||
| CustomerReference | nvarchar(50) | |||
| Language | nvarchar(10) | |||
| Responsible | nvarchar(50) | |||
| Creator | nvarchar(50) | |||
| FreeText1 | nvarchar(100) | See API reference | ||
| FreeText2 | nvarchar(100) | See API reference | ||
| FreeText3 | nvarchar(100) | See API reference | ||
| FreeText4 | nvarchar(100) | See API reference | ||
| FreeText5 | nvarchar(100) | See API reference | ||
| FreeText6 | nvarchar(100) | See API reference | ||
| FreeText7 | nvarchar(100) | See API reference | ||
| FreeText8 | nvarchar(100) | See API reference | ||
| FreeText9 | nvarchar(100) | See API reference | ||
| FreeText10 | nvarchar(100) | See API reference | ||
| FreeText11 | nvarchar(100) | See API reference | ||
| FreeText12 | nvarchar(100) | See API reference | ||
| FreeText13 | nvarchar(100) | See API reference | ||
| FreeText14 | nvarchar(100) | See API reference | ||
| FreeText15 | nvarchar(100) | See API reference | ||
| FreeText16 | nvarchar(100) | See API reference | ||
| FreeText17 | nvarchar(100) | See API reference | ||
| FreeText18 | nvarchar(100) | See API reference | ||
| FreeText19 | nvarchar(100) | See API reference | ||
| FreeText20 | nvarchar(100) | See API reference | ||
| FreeDecimal1 | decimal(18, 6) | See API reference | ||
| FreeDecimal2 | decimal(18, 6) | See API reference | ||
| FreeDecimal3 | decimal(18, 6) | See API reference | ||
| FreeDecimal4 | decimal(18, 6) | See API reference | ||
| FreeDecimal5 | decimal(18, 6) | See API reference | ||
| FreeDate1 | datetime | See API reference | ||
| FreeDate2 | datetime | See API reference | ||
| FreeDate3 | datetime | See API reference | ||
| FreeDate4 | datetime | See API reference | ||
| FreeDate5 | datetime | See API reference | ||
| FreeBit1 | bit | 0 | See API reference | |
| FreeBit2 | bit | 0 | See API reference | |
| FreeBit3 | bit | 0 | See API reference | |
| FreeBit4 | bit | 0 | See API reference | |
| FreeBit5 | bit | 0 | See API reference | |
| EnableManualSelection | bit | 0 | ||
| AvailableInGantt | bit | 0 | ||
| StartDate | datetime | |||
| EndDate | datetime | |||
| AllowDependencies | bit | 1 | ||
| Note | nvarchar(max) | |||
| OverRuleGanttPlanning | bit | 0 | ||
| ReadOnly | bit | 0 |
Delete
Deletes a job record. The behavior of this procedure depends on the CheckAppointments flag:
- When
CheckAppointmentsis true: the job is not deleted when there are appointments for any task attached to the job. - When
CheckAppointmentsis false: the job is deleted without further checks. When a job is deleted, all tasks and appointments attached to the job, if any, are also deleted.
| Name | Data Type | Default | Required | Description |
|---|---|---|---|---|
| SourceApp | nvarchar(30) | ✔️ | See API reference | |
| SourceType | nvarchar(10) | ✔️ | See API reference | |
| JobNo | nvarchar(50) | ✔️ | ||
| CheckAppointments | bit | |||
| SentFromBackoffice | bit | 1 |
API reference
Source
Dime.Scheduler is a centralized planning application. One the key tenets is the ability to accommodate data from different origins. For instance, it is perfectly acceptable to plan work orders from Business Central, CRM, imported Excel sheets, etc., and Dime.Scheduler won't break a sweat because of the existence of the Source App and SourceType fields in the data model.
Source App
When the planner makes an appointment for a resource or task, Dime.Scheduler knows which system to notify. Through the connector setup, Dime.Scheduler will find a matching SourceApp and send the appointment to the corresponding URI subsequently. The source app field is a unique identifier that identifies a back office instance such a tenant of Business Central, a test environment, an instance of CRM cloud, or any other application you wish to use to feed the data into Dime.Scheduler.
Source Type
The SourceType is used inside the backoffice system itself. A source type represents a distinct entity such as a service order, production order, assembly order, etc.
The standard connectors that Dime Software provides make it possible to plan different types of resources and tasks. When Dime.Scheduler posts an appointment to a standard connector, it ends up in a staging table, which is then processed by the connector to make sure the appointment produced in Dime.Scheduler is traced back to the original record using the externally identifiable fields (JobNo, TaskNo, ResourceNo) that identify the record.
Importance
Controls the visual indicator of the planned task in the planning board. Read more about the matter here.
Category
Controls the visual indicator of the planned task in the planning board. Read more about the matter here.
Time Marker
Controls the visual indicator of the planned task in the planning board. Read more about the matter here.
Pin
Controls the visual indicator of the planned task in the map. Read more about the matter here.
Free fields
Free fields are unmapped fields that you can link custom fields to.
The caption can be changed through the captions localization system. Either use the GUI and look for the corresponding field of the corresponding source table for the 'DATABASEFIELD' context, or use the import API.