Notification

Upsert

Inserts or updates a notificationNotificationA message from the back office attached to a task, an appointment or the whole tenant. The notifications component lists them, and a colored vertical bar on the appointment signals their severity. record. Notifications can be applied for either one of the following dimensions:

• Global
• Job
• Task
• Appointment

This is a cascading mechanism. The appointmentAppointmentA task scheduled to a resource for a specific period - the scheduled instance you see on the planning board. has a reference to a taskTaskA unit of work that belongs to a job. It appears in the open task list until it is scheduled to a resource., and a task has a reference to a jobJobA high-level container, comparable to a project, that bundles related tasks together with common information such as customer, billing, and address.. Notifications for a job will be shown for all corresponding tasks and jobs. Same goes for tasks, whose notifications will be shown to the planned appointments.

Name	Data Type	Default	Required	Description
SourceApp	nvarchar(30)			See API reference
SourceType	nvarchar(10)			See API reference
NotificationType	int	0		See API reference
NotificationCode	nvarchar(20)
NotificationText	nvarchar(max)
NotificationDate	datetime
mboc_id	nvarchar(50)
JobNo	nvarchar(50)
TaskNo	nvarchar(50)
AppointmentId	bigint
AppointmentGuid	nvarchar(50)
SentFromBackOffice	bit	1

Import

• This endpoint is available in the import API endpoint /import via the procedure mboc_upsertConnector.
• Example body:

  [
      {
          "StoredProcedureName": "mboc_upsertNotification",
          "ParameterNames": ["SourceApp","SourceType", "NotificationType", "NotificationCode", "NotificationText", "NotificationDate", "JobNo", "TaskNo"],
          "ParameterValues": ["MYSOURCEAPP","MYSOURCETYPE", "1","CODE","TEXT","DATE", "JOBNO", "TASKNO"]
      }
  ]

API

• See POST /notification, PUT /notification in the REST API reference.
• Example body:

  {
      "SourceApp": "MYSOURCEAPP",
      "SourceType": "MYSOURCETYPE",
      "AppointmentNo": "MYAPPOINTMENTNO",
      "TaskNo": "MYTASKNO",
      "JobNo": "MYJOBNO",
      "Type": 1,
      "Code": "MYCODE",
      "Text": "MYTEXT",
      "Date": "MYDATE"
  }

Delete

Deletes the notification record. The behavior of this procedure depends on the data passed to it:

• A filled out JobNo and TaskNo will lead to all notification records attached to the TaskNo being deleted.
• Populating JobNo will delete all notification records attached to the JobNo.

Name	Data Type	Default	Required	Description
SourceApp	nvarchar(30)			See API reference
SourceType	nvarchar(10)			See API reference
mboc_id	nvarchar(50)
JobNo	nvarchar(50)
TaskNo	nvarchar(50)
AppointmentId	bigint	0
AppointmentGuid	nvarchar(50)
SentFromBackOffice	bit	1

Import

• This endpoint is available in the import API endpoint /import via the procedure mboc_upsertConnector.
• Example body:

  [
      {
          "StoredProcedureName": "mboc_deleteNotification",
          "ParameterNames": ["SourceApp","SourceType", "JobNo", "TaskNo", "AppointmentGuid"],
          "ParameterValues": ["MYSOURCEAPP","MYSOURCETYPE", "JOBNO","TASKNO","APPOINTMENTGUID"]
      }
  ]

API

• See DELETE /notification in the REST API reference.
• Example body:

  {
      "SourceApp": "MYSOURCEAPP",
      "SourceType": "MYSOURCETYPE",
      "AppointmentNo": "MYAPPOINTMENTNO",
      "TaskNo": "MYTASKNO",
      "JobNo": "MYJOBNO",
      "Type": 1,
      "Code": "MYCODE",
      "Text": "MYTEXT",
      "Date": "MYDATE"
  }

API reference

Source

Dime.Scheduler is a centralized planning application. One of its 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 Source Type fields in the data model.

Source App

When the planner creates 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 subsequently send the appointment to the corresponding URI.

The source appSource appAn identifier Dime.Scheduler attaches to data so it can route a change back to the correct back-office system. field is a unique identifier that identifies a back-officeBack officeThe ERP or business system Dime.Scheduler plans for - most often Microsoft Dynamics 365 Business Central. It owns the master data and remains authoritative over what it receives. instance such as a tenant of Business Central, a test environment, an instance of CRM cloud, or any other application you wish to use to feed data into Dime.Scheduler.

Back officeERP · CRM · LoB

served bySource App

ConnectorBound to one Source App

creates

JobProject container

contains

TaskWork to do

scheduled as

AppointmentPlanning decision

Step 1 of 4Back office Connector

The back office is bound to a connector

Each back-office instance - a Business Central tenant, a CRM environment, an Excel sheet - is identified by a Source App. The connector is configured for that one Source App and nothing else, so Dime.Scheduler always knows which system any record came from.

Source Type

The SourceType is used inside the back-office system itself. A source typeSource typeAn identifier that, together with the source app, tells Dime.Scheduler which back-office table a record belongs to. represents a distinct entity such as a service orderService orderA Business Central service management document. The service order solution plans it as one task or as one task per service item line, and writes the assignment back as a resource allocation., production orderProduction orderA Business Central manufacturing order with routing lines. The production routing solution puts those lines on the planning board against work and machine centers while BC’s own rules still hold., assembly orderAssembly orderA Business Central document that says what to build. The assembly order solution schedules the resources that build it and keeps the order’s dates in sync., etc.

The standard connectorsConnectorAn integration that links Dime.Scheduler to a back-office system, routing data in and scheduling decisions back out. 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 tableStaging tableThe Dime.Scheduler Appointments table in Business Central where incoming appointments land first. Business Central processes rows from there, so a row can be received and still fail processing., which is then processed by the connector to ensure 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.

Notification type

The values for notification types are:

• 0 for Information
• 1 for Warning
• 2 for Error.