Appointment
The appointment entity is what Dime.Scheduler is all about. An appointment is the main deliverable of the software and represents a block in the planning board. The appointment contains the information of the appointment such as the start and end date, and it holds references to the resources that have been assigned to it.
The following entities are exposed through the import service.
Appointment
Upsert appointment
Inserts or updates an appointment record. The behavior of this procedure depends on the data you pass to it:
- The appointment id is required if you want to update an existing appointment.
- Otherwise, it inserts an appointment resource record (linking a resource to the appointment) if the record does not exist.
| Name | Data Type | Default | Required | Description |
|---|---|---|---|---|
| SourceApp | nvarchar(30) | ✔️ | See API reference | |
| SourceType | nvarchar(10) | ✔️ | See API reference | |
| JobNo | nvarchar(50) | ✔️ | ||
| TaskNo | nvarchar(50) | ✔️ | ||
| AppointmentId | bigint | 0 | ||
| Subject | nvarchar(max) | |||
| Body | nvarchar(max) | |||
| Start | datetime | |||
| End | datetime | |||
| IsAllDayEvent | bit | 0 | ||
| Category | nvarchar(100) | See API reference | ||
| TimeMarker | nvarchar(100) | See API reference | ||
| Importance | int | 0 | See API reference | |
| Locked | bit | 0 | ||
| ResourceNo | nvarchar(50) | |||
| AppointmentGuid | nvarchar(50) | |||
| ReplaceResource | bit | 0 | ||
| SentFromBackoffice | bit | 1 | ||
| BackofficeID | nvarchar(100) | |||
| BackofficeParentID | nvarchar(100) | |||
| PlanningUOM | nvarchar(20) | |||
| PlanningUOMConversion | decimal(18,6) | 0 | ||
| PlanningQty | decimal(18,6) | 0 | ||
| UseFixPlanningQty | bit | 0 | ||
| RoundToUOM | bit | 0 |
Delete appointment
The behavior of this procedure depends on the data you pass to it:
- If a resource number is provided, then the appointment resource record is deleted. The appointment record is also deleted if no more appointment resource records exist for the appointment.
- If the resource number is not provided, then the appointment record and all linked appointment resource records are deleted.
| Name | Data Type | Default | Required | Description |
|---|---|---|---|---|
| SourceApp | nvarchar(30) | ✔️ | See API reference | |
| SourceType | nvarchar(10) | ✔️ | See API reference | |
| AppointmentId | bigint | |||
| AppointmentGuid | nvarchar(50) | |||
| ResourceNo | nvarchar(50) | |||
| SentFromBackoffice | bit | 1 |
Upsert appointment URI
Inserts or updates an appointment URI record.
An appointment URI contains links to documents, web pages and the back office system. You need to pass an existing appointment id or appointment GUID.
| Name | Data Type | Default | Required | Description |
|---|---|---|---|---|
| pSourceApp | nvarchar(30) | See API reference | ||
| pSourceType | nvarchar(10) | See API reference | ||
| pAppointmentId | bigint | 0 | ||
| pAppointmentGuid | nvarchar(50) | |||
| pUrl | nvarchar(1000) | ✔️ | ||
| pUrlDesc | nvarchar(255) |
Upsert appointment container
Adds or updates the allocation of an appointment to a container.
| Name | Data Type | Default | Required |
|---|---|---|---|
| Container | nvarchar(100) | ✔️ | |
| Appointment | nvarchar(100) | ✔️ |
Add assignment
Add a resource to an existing appointment, thereby creating a linked appointment.
| Name | Data Type | Default | Required | Description |
|---|---|---|---|---|
| SourceApp | nvarchar(30) | See API reference | ||
| SourceType | nvarchar(10) | See API reference | ||
| AppointmentId | bigint | |||
| ResourceNo | nvarchar(50) | ✔️ | ||
| AppointmentGuid | nvarchar(50) | |||
| SentFromBackoffice | bit | 1 |
Properties
Update appointment content
Updates the body and subject of the selected appointment.
| Name | Data Type | Default | Required | Description |
|---|---|---|---|---|
| SourceApp | nvarchar(30) | See API reference | ||
| SourceType | nvarchar(10) | See API reference | ||
| AppointmentId | bigint | |||
| AppointmentGuid | nvarchar(50) | |||
| SentFromBackoffice | bit | 1 | ||
| Subject | nvarchar(max) | |||
| Body | nvarchar(max) |
Update appointment planning quantity
Updates the planning quantity of an appointment.
| Name | Data Type | Default | Required | Description |
|---|---|---|---|---|
| SourceApp | nvarchar(30) | See API reference | ||
| SourceType | nvarchar(10) | See API reference | ||
| AppointmentId | bigint | |||
| PlanningQty | decimal(18,6) | |||
| AppointmentGuid | nvarchar(50) | |||
| SentFromBackoffice | bit | 1 |
Indicators
Set time marker
Update the time marker assigned to the appointment. Can be used to update status or progress of the appointment.
| Name | Data Type | Default | Required | Description |
|---|---|---|---|---|
| SourceApp | nvarchar(30) | See API reference | ||
| SourceType | nvarchar(10) | See API reference | ||
| AppointmentId | bigint | |||
| TimeMarker | nvarchar(100) | |||
| AppointmentGuid | nvarchar(50) | |||
| SentFromBackoffice | bit | 1 |
Set category
Updates the category assigned to the appointment. Can be used to update status or progress of the appointment.
| Name | Data Type | Default | Required | Description |
|---|---|---|---|---|
| SourceApp | nvarchar(30) | See API reference | ||
| SourceType | nvarchar(10) | See API reference | ||
| AppointmentId | bigint | |||
| Category | nvarchar(100) | |||
| AppointmentGuid | nvarchar(50) | |||
| SentFromBackoffice | bit | 1 |
Set lock
Locks or unlocks an appointment. A locked appointment can not be modified nor deleted on the planning board.
| Name | Data Type | Default | Required | Description |
|---|---|---|---|---|
| SourceApp | nvarchar(30) | See API reference | ||
| SourceType | nvarchar(10) | See API reference | ||
| AppointmentId | bigint | |||
| Locked | bit | 0 | ||
| AppointmentGuid | nvarchar(50) | |||
| SentFromBackoffice | bit | 1 |
Set importance
Sets the importance of an appointment.
| Name | Data Type | Default | Required | Description |
|---|---|---|---|---|
| SourceApp | nvarchar(30) | See API reference | ||
| SourceType | nvarchar(10) | See API reference | ||
| AppointmentId | bigint | |||
| Importance | int | 0 | See API reference | |
| AppointmentGuid | nvarchar(50) | |||
| 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.
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.