Resource
A resource in Dime.Scheduler is someone or something that needs to be allocated during a certain timeframe in order for a task to be performed or fulfilled. This can be a service technician, a sales person, an employee, a car, a machine or equipment, a hotel or meeting room, etc.
The following entities are exposed through the import service.
Resource
Upsert
Inserts or updates a resource record.
| Name | Data Type | Default | Required | Description |
|---|---|---|---|---|
| SourceApp | nvarchar(30) | See API reference | ||
| SourceType | nvarchar(10) | See API reference | ||
| ResourceType | nvarchar(100) | The resource type's name | ||
| ResourceTypeId | int | The resource type's internal id | ||
| ResourceName | nvarchar(100) | |||
| DisplayName | nvarchar(100) | |||
| Department | nvarchar(50) | |||
| ResourceNo | nvarchar(50) | ✔️ | The resource's external identifier. | |
| nvarchar(100) | ||||
| Phone | nvarchar(50) | |||
| MobilePhone | nvarchar(50) | |||
| ReplacementResource | bit | |||
| FieldServiceEmail | nvarchar(100) | |||
| PersonalEmail | nvarchar(100) | |||
| GpsTrackingResourceNo | nvarchar(50) | |||
| HomeAddress | nvarchar(max) | |||
| HomeAddressGeoLong | float | |||
| HomeAddressGeoLat | float | |||
| HomePhone | nvarchar(50) | |||
| HomeEmail | nvarchar(50) | |||
| HomeRegion | nvarchar(10) | |||
| HomePostcode | nvarchar(20) | |||
| HomeCity | nvarchar(50) | |||
| HomeCounty | nvarchar(50) | |||
| HomeState | nvarchar(50) | |||
| HomeCountry | nvarchar(50) | |||
| TeamCode | nvarchar(20) | |||
| TeamName | nvarchar(100) | |||
| TeamType | nvarchar(20) | |||
| TeamSort | int | |||
| TeamMemberType | nvarchar(20) | |||
| TeamMemberSort | int | |||
| 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 | |
| DoNotShow | bit | See API reference | ||
| InServiceFrom | date | |||
| InServiceTill | date | |||
| ExchangeIntegrationEnabled | bit | See API reference | ||
| url1 | nvarchar(1000) | |||
| urldesc1 | nvarchar(255) | |||
| url2 | nvarchar(1000) | |||
| urldesc2 | nvarchar(255) | |||
| url3 | nvarchar(1000) | |||
| urldesc3 | nvarchar(255) | |||
| BulkPlanning | bit | |||
| BulkCapacity | decimal(18,6) | |||
| ResourceGpsTrackingEnabled | bit | See API reference | ||
| Pin | nvarchar(100) | See API reference |
Filter value
Upsert filter value
Inserts or updates a resource filter value record. This assigns a filter value to a resource.
| Name | Data Type | Default | Required | Description |
|---|---|---|---|---|
| SourceApp | nvarchar(30) | See API reference | ||
| SourceType | nvarchar(10) | See API reference | ||
| ResourceNo | nvarchar(50) | ✔️ | ||
| FilterGroup | nvarchar(50) | ✔️ | ||
| FilterValue | nvarchar(100) | ✔️ | ||
| TransferToTemp | bit | 0 | See API reference |
Delete filter value
Removes a filter value from a resource.
| Name | Data Type | Default | Required | Description |
|---|---|---|---|---|
| SourceApp | nvarchar(30) | See API reference | ||
| SourceType | nvarchar(10) | See API reference | ||
| ResourceNo | nvarchar(50) | ✔️ | ||
| FilterGroup | nvarchar(20) | ✔️ | ||
| FilterValue | nvarchar(20) | ✔️ |
Clear filter value
Removes all filter values from a resource.
| Name | Data Type | Default | Required | Description |
|---|---|---|---|---|
| SourceApp | nvarchar(30) | See API reference | ||
| SourceType | nvarchar(10) | See API reference | ||
| ResourceNo | nvarchar(50) | ✔️ |
Upsert live location
Inserts or updates the live location of a resource. The position on the map in Dime.Scheduler is updated automatically when a record is inserted or updated.
| Name | Data Type | Default | Required | Description |
|---|---|---|---|---|
| ResourceNo | nvarchar(50) | ✔️ | ||
| GpsTrackingResourceNo | nvarchar(50) | ✔️ | ||
| Latitude | float | ✔️ | ||
| Longitude | float | ✔️ | ||
| Speed | int | Deprecated | ||
| Date | date | Deprecated | ||
| RowId | nvarchar(100) | Deprecated | ||
| Power | nvarchar(50) | Deprecated |
The resource number or the GPS resource tracking number is required in order to successfully insert or update a record.
Upsert capacity
The resource capacity is set per day. If omitted, default values are set for CapacityUOM (hour by default) and CapacityUOMConversion (3600 by default).
You need to provide either CapacityInSeconds or CapacityQty. The other value is calculated using CapacityUOMConversion.
The resource's capacity is vital for the capacity pivot grid to generate reliable results.
| Name | Data Type | Default | Required |
|---|---|---|---|
| ResourceNo | nvarchar(50) | ✔️ | |
| CapacityDate | date | ||
| CapacityInSeconds | bigint | ||
| CapacityQty | decimal(18,6) | ||
| CapacityUOM | nvarchar(20) | ||
| CapacityUOMConversion | decimal(18,6) |
Upsert URI
Inserts or updates a resource URI record. Resource URIs contain links to documents, web pages and the back office system.
| Name | Data Type | Default | Required |
|---|---|---|---|
| ResourceNo | nvarchar(50) | ✔️ | |
| Url | nvarchar(1000) | ||
| UrlDesc | nvarchar(255) |
Resource certificate
This feature is deprecated and will be removed in a future version.
Upsert certificate
Inserts or updates a resource certificate record. A resource certificate contains information on certificates/exams/scores held or passed by the resource. Resource certificates can be searched and matched against a task's certificate in the resource and appointment page when UseCertificate is activated on the resource types.
| Name | Data Type | Default | Required |
|---|---|---|---|
| ResourceNo | nvarchar(50) | ✔️ | |
| CertificateNo | nvarchar(50) | ✔️ | |
| Score | nvarchar(100) | '' | |
| LastScoreDate | datetime | ||
| ValidUntil | datetime |
Delete certificate
Deletes a resource certificate record.
| Name | Data Type | Default | Required |
|---|---|---|---|
| ResourceNo | nvarchar(50) | ✔️ | |
| CertificateNo | nvarchar(50) | ✔️ |
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.
Exchange Integration Enabled
This field determines whether to synchronize the appointment with the resource's Outlook calendar.
GPS Tracking Enabled
This field determines whether to enable live location tracking. To use this feature, the 'Advanced map' optional modules must be acquired.
Do not show
This field determines if the resource should be visible in the planning board. The number of resources with this field switched off (i.e. they are shown on the planning board) determines the license validity.
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.
Transfer to temp
The TransferToTemp field indicates whether the resource filter value(s) are being sent to Dime.Scheduler before (value = 1 or True) or after (value = 0 or False) the resource is sent.