Dime.Scheduler

Dime.Scheduler

  • Overview
  • User
  • Administrator
  • Setup
  • Plugins
  • Back Office
  • Developer
  • Guides
  • News
  • Languages iconEnglish
    • Deutsch

›Dime.Scheduler

Dime.Scheduler

  • Introduction
  • Web API
  • Import Service
  • Stored Procedures

Microsoft Dynamics NAV

  • Sending and receiving data
  • Send, receive and support functions
  • NAV Objects and configuration overview
  • Versioning and solution IDs
  • Updated standard objects

Microsoft Dynamics CRM

  • Customization
  • Sending data
  • Receiving data
  • Overview of C# Send-Plugins, Receive-Methods and Support Methods

Microsoft Dynamics 365 Business Central Connector

  • Introduction
  • Events

Stored Procedures

In combination with the import service, stored procedures can be modified to implement business logic. In the database, stored procedures with the prefix "mboc_" can be invoked by the import service.

Anatomy of an import stored procedure

In essence, the whole exercise of connecting Dime.Scheduler to a different system is to transfer data from point A to point B. To put it in the words of Joey Tribbiani, the processor guy, it's mostly a matter of "putting numbers from one column into another column".

Joey Tribbiani

Let's have a look at a simple one, the pins. The data model of a pin couldn't be any simpler: it contains an id, name and a color. This is reflected in its stored procedure.

The parameters contain the data that should be stored in the database. At this point, you may be wondering why there is no "Id" (or any PK) in there. Recall that data may originate from other systems, which makes identifiers utterly redundant. The best next thing would be to map data using the "Name" field. The function fGetPinId does actually that, querying the Pins table for any record that contains the name that was specified in the @Name parameter. If the record exists, that particular will be updated. If it doesn't, a new item will be created. Hence the name of the stored procedure: "upsert".

CREATE PROCEDURE [dbo].[mboc_upsertPin]
    @Name nvarchar(100),
    @HexColor nvarchar(50) = '',
    @ColorR int = NULL,
    @ColorG int = NULL,
    @ColorB int = NULL
AS
BEGIN
    SET NOCOUNT ON;

    DECLARE @PinId int

    IF @Name = '' BEGIN
        RAISERROR(N'Parameter "Name" cannot be empty when creating pins.',16, 0)
        RETURN
    END

    SET @PinId = dbo.fGetPinId(@Name)

    IF @ColorR IS NOT NULL AND @ColorG IS NOT NULL AND @ColorB IS NOT NULL
        SET @HexColor = '#' + CONVERT(nvarchar(10), CONVERT(VARBINARY(1), @ColorR) + CONVERT(VARBINARY(1), @ColorG) + CONVERT(VARBINARY(1), @ColorB), 2)

    IF @PinId IS NOT NULL
        IF @HexColor = ''
            SELECT @HexColor = Color
            FROM [Pins]
            WHERE Id = @PinId

    IF @PinId IS NULL
        INSERT INTO [Pins] ([Name],[Color])
        VALUES (@Name,@HexColor)
    ELSE
        UPDATE [Pins] 
        SET [Name] = @Name,
            [Color] = @HexColor
        WHERE [Id] = @PinId
END

CREATE FUNCTION [dbo].[fGetPinId]
(
    @PinName nvarchar(100)
)
RETURNS int
AS
BEGIN
    IF COALESCE(@PinName,'') = ''
      RETURN NULL

    RETURN(SELECT TOP 1 [Id] FROM [Pins] WHERE [Name] = @PinName)
END

That's all there is to it. Clearly, there are more complicated sprocs like the ones concerned with jobs and tasks but they basically do the same thing, which is to connect other systems' data with Dime.Scheduler.

Import stored procedures list

The names of the stored procedures and their purpose are fairly self-explanatory. For example, it doesn't take a rocket scientist to figure out that mboc_deleteAppointment is responsible for deleting appointments from the database.

Nonetheless, for the sake of being complete, the table below enlists all the stored procedures which can be invoked by the import service. Of course, feel free to peruse the stored procedures in the database.

Name
mboc_addAppointmentResource
mboc_clearResourceFilterValue
mboc_clearTaskFilterValue
mboc_deleteAppointment
mboc_deleteCategory
mboc_deleteFilterGroup
mboc_deleteFilterValue
mboc_deleteJob
mboc_deleteNotification
mboc_deletePin
mboc_deleteResourceCertificate
mboc_deleteResourceFilterValue
mboc_deleteTask
mboc_deleteTaskContainer
mboc_deleteTaskFilterValue
mboc_deleteTimeMarker
mboc_deleteTimeSlotEntry
mboc_deleteTimeSlotTemplate
mboc_renameCategory
mboc_renameFilterGroup
mboc_renamePin
mboc_renameTimeMarker
mboc_updateAppointmentCategory
mboc_updateAppointmentImportance
mboc_updateAppointmentLocked
mboc_updateAppointmentPlanningQty
mboc_updateAppointmentTimeMarker
mboc_updateTaskLocked
mboc_upsertActionUrl
mboc_upsertAppointment
mboc_upsertAppointmentUrl
mboc_upsertCaption
mboc_upsertCategory
mboc_upsertFilterGroup
mboc_upsertFilterValue
mboc_upsertJob
mboc_upsertNotification
mboc_upsertPin
mboc_upsertResource
mboc_upsertResourceCapacity
mboc_upsertResourceCertificate
mboc_upsertResourceFilterValue
mboc_upsertResourceGpsTracking
mboc_upsertResourceUrl
mboc_upsertTask
mboc_upsertTaskContainer
mboc_upsertTaskFilterValue
mboc_upsertTaskUrl
mboc_upsertTimeMarker
mboc_upsertTimeSlotEntry
mboc_upsertTimeSlotTemplate

ℹ️ You will notice we adopted the acronym "upsert", which refers to a create or update operation, depending on the existence of a particular record in the database.

Jobs

Upsert jobs

Inserts or updates a job record. A job in Dime.Scheduler is the overlying 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, you cannot create a task if the corresponding job record does not exist.

NameData TypeDefault ValueRequired
SourceAppnvarchar(30)✔️
SourceTypenvarchar(10)✔️
JobNonvarchar(50)✔️
ShortDescriptionnvarchar(50)✔️
Descriptionnvarchar(MAX)
Typenvarchar(50)
Namenvarchar(255)
Categorynvarchar(100)
TimeMarkernvarchar(100)
Pinnvarchar(100)
CustomerNonvarchar(20)
CustomerNamenvarchar(50)
CustomerAddressnvarchar(MAX)
CustomerAddressGeoLongnvarchar(50)
CustomerAddressGeoLatnvarchar(50)
CustomerPhonenvarchar(50)
CustomerEmailnvarchar(50)
ContactNonvarchar(20)
ContactNamenvarchar(50)
ContactAddressnvarchar(MAX)
ContactAddressGeoLongnvarchar(50)''
ContactAddressGeoLatnvarchar(50)''
ContactPhonenvarchar(50)
ContactEmailnvarchar(50)
SiteNonvarchar(20)
SiteNamenvarchar(50)
SiteAddressnvarchar(MAX)
SiteAddressGeoLongnvarchar(50)''
SiteAddressGeoLatnvarchar(50)''
SitePhonenvarchar(50)
SiteEmailnvarchar(50)
SiteRegionnvarchar(10)
SiteStreetnvarchar(255)
SiteStreetNonvarchar(20)
SitePostcodenvarchar(20)
SiteCitynvarchar(50)
SiteCountynvarchar(50)
SiteStatenvarchar(50)
SiteCountrynvarchar(50)
SiteFromNonvarchar(20)
SiteFromNamenvarchar(50)
SiteFromAddressnvarchar(MAX)
SiteFromAddressGeoLongnvarchar(50)''
SiteFromAddressGeoLatnvarchar(50)''
SiteFromPhonenvarchar(50)
SiteFromEmailnvarchar(50)
SiteFromRegionnvarchar(10)
SiteFromStreetnvarchar(255)
SiteFromStreetNonvarchar(20)
SiteFromPostcodenvarchar(20)
SiteFromCitynvarchar(50)
SiteFromCountynvarchar(50)
SiteFromStatenvarchar(50)
SiteFromCountrynvarchar(50)
BillNonvarchar(20)
BillNamenvarchar(50)
BillAddressnvarchar(MAX)
BillAddressGeoLongnvarchar(50)''
BillAddressGeoLatnvarchar(50)''
BillPhonenvarchar(50)
BillEmailnvarchar(50)
BillRegionnvarchar(10)
Importanceint0
CreationDateTimedatetime
CustomerReferencenvarchar(50)
Languagenvarchar(10)
Responsiblenvarchar(50)
Creatornvarchar(50)
FreeText1nvarchar(100)
FreeText2nvarchar(100)
FreeText3nvarchar(100)
FreeText4nvarchar(100)
FreeText5nvarchar(100)
FreeText6nvarchar(100)
FreeText7nvarchar(100)
FreeText8nvarchar(100)
FreeText9nvarchar(100)
FreeText10nvarchar(100)
FreeText11nvarchar(100)
FreeText12nvarchar(100)
FreeText13nvarchar(100)
FreeText14nvarchar(100)
FreeText15nvarchar(100)
FreeText16nvarchar(100)
FreeText17nvarchar(100)
FreeText18nvarchar(100)
FreeText19nvarchar(100)
FreeText20nvarchar(100)
FreeDecimal1decimal(18, 6)
FreeDecimal2decimal(18, 6)
FreeDecimal3decimal(18, 6)
FreeDecimal4decimal(18, 6)
FreeDecimal5decimal(18, 6)
FreeDate1datetime
FreeDate2datetime
FreeDate3datetime
FreeDate4datetime
FreeDate5datetime
FreeBit1bit0
FreeBit2bit0
FreeBit3bit0
FreeBit4bit0
FreeBit5bit0
EnableManualSelectionbit0
AvailableInGanttbit0
StartDatedatetime
EndDatedatetime
AllowDependenciesbit1
Notenvarchar(max)
OverRuleGanttPlanningbit0

Delete job

Deletes a job record. The behavior of this procedure depends on the CheckAppointments flag:

  • When CheckAppointments is true: the job is not deleted when there are appointments for any task attached to the job.
  • When CheckAppointments is 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.
NameData TypeDefault ValueRequired
SourceAppnvarchar(30)✔️
SourceTypenvarchar(10)✔️
JobNonvarchar(50)✔️
CheckAppointmentsbit
SentFromBackofficebit1

Tasks

Upsert task

Inserts or updates a task record. A task is a child entity of a job, and a job is required before any task can be added. A task record for which no appointments exist is considered as an open task, and will therefore be displayed in the open tasks component.

NameData TypeDefault ValueRequired
SourceAppnvarchar(30)✔️
SourceTypenvarchar(10)✔️
JobNonvarchar(50)✔️
TaskNonvarchar(50)✔️
TaskTypeint0
ShortDescriptionnvarchar(50)
Descriptionnvarchar(MAX)
Namenvarchar(255)
Typenvarchar(20)
Categorynvarchar(100)
TimeMarkernvarchar(100)
Pinnvarchar(100)
ServiceNonvarchar(50)
ServiceGroupnvarchar(20)
ServiceClassnvarchar(20)
ServiceSerialNonvarchar(50)
ServiceNamenvarchar(50)
IRISFaultnvarchar(10)
IRISSymptomnvarchar(10)
IRISAreanvarchar(10)
IRISReasonnvarchar(10)
IRISResolutionnvarchar(10)
Skill1nvarchar(10)
Skill2nvarchar(10)
Skill3nvarchar(10)
ContractNonvarchar(20)
ContractTypenvarchar(30)
ContractDescriptionnvarchar(MAX)
ContractStartDatedate
ContractEndDatedate
PartsWarrantyStartDatedate
PartsWarrantyEndDatedate
LaborWarrantyStartDatedate
LaborWarrantyEndDatedate
Importanceint0
Statusnvarchar(20)
ExpectedResponseDateTimedatetime
ActualResponseDateTimedatetime
RequestedStartDatedatetime
RequestedEndDatedatetime
ConfirmedStartDatedatetime
ConfirmedEndDatedatetime
ActualStartDatedatetime
ActualEndDatedatetime
LocationDescriptionnvarchar(MAX)
Durationtime(7)
DurationInSecondsbigint
Subjectnvarchar(max)
Bodynvarchar(max)
InfiniteTaskbit0
TaskOpenAsOfdatetime
TaskOpenTilldatetime
RequiredTotalDurationtime(7)
RequiredNoResourcesint
AppointmentEarliestAlloweddatetime
AppointmentLatestAlloweddatetime
FreeText1nvarchar(100)
FreeText2nvarchar(100)
FreeText3nvarchar(100)
FreeText4nvarchar(100)
FreeText5nvarchar(100)
FreeText6nvarchar(100)
FreeText7nvarchar(100)
FreeText8nvarchar(100)
FreeText9nvarchar(100)
FreeText10nvarchar(100)
FreeText11nvarchar(100)
FreeText12nvarchar(100)
FreeText13nvarchar(100)
FreeText14nvarchar(100)
FreeText15nvarchar(100)
FreeText16nvarchar(100)
FreeText17nvarchar(100)
FreeText18nvarchar(100)
FreeText19nvarchar(100)
FreeText20nvarchar(100)
FreeDecimal1decimal(18, 6)
FreeDecimal2decimal(18, 6)
FreeDecimal3decimal(18, 6)
FreeDecimal4decimal(18, 6)
FreeDecimal5decimal(18, 6)
FreeDate1datetime
FreeDate2datetime
FreeDate3datetime
FreeDate4datetime
FreeDate5datetime
FreeBit1bit0
FreeBit2bit0
FreeBit3bit0
FreeBit4bit0
FreeBit5bit0
url1nvarchar(1000)
urldesc1nvarchar(255)
url2nvarchar(1000)
urldesc2nvarchar(255)
url3nvarchar(1000)
urldesc3nvarchar(255)
CertificateNonvarchar(50)
RequiredTotalDurationInSecondsbigint
DoNotCountAppointmentResourcebit0
IsCompletebit0
PlanningUOMnvarchar(20)
PlanningUOMConversiondecimal(18,6)0
PlanningQtydecimal(18,6)0
UseFixPlanningQtybit0
RoundToUOMbit0
AppointmentTemplatenvarchar(100)
BulkPlanningQtydecimal(18, 6)
StartDatedatetime
EndDatedatetime
PercentDoneint
SchedulingModeint0
BaseLineStartDatedatetime
BaseLineEndDatedatetime
BaseLinePercentDoneint
DeadLinedatetime
Indexint
ConstraintTypeint0
ConstraintDatedatetime
ParentTaskNonvarchar(50)
CalendarCodenvarchar(255)
PredecessorTaskNonvarchar(50)
PredecessorLagint
ManuallyScheduledbit0
Notenvarchar(max)
OverRuleGanttPlanningbit0
IgnoreCalendarsbit0
ContainerNamenvarchar(255)
ContainerIndexint

Delete task

Deletes a task record. The behavior of this procedure depends on the CheckAppointments flag:

  • When CheckAppointments is true: the task is not deleted when there are appointments for the task.
  • When CheckAppointments is false: the task is deleted without further checks. When a task is deleted, all appointments attached to the task, if any, are also deleted.
NameData TypeDefault ValueRequired
SourceAppnvarchar(30)✔️
SourceTypenvarchar(10)✔️
JobNonvarchar(50)✔️
TaskNonvarchar(50)✔️
CheckAppointmentsbit✔️
SentFromBackofficebit1

Upsert task URI

Inserts or updates a task uri record. A task link contains links to documents, web pages and the back office system.

NameData TypeDefault ValueRequired
SourceAppnvarchar(30)✔️
SourceTypenvarchar(10)✔️
JobNonvarchar(50)✔️
TaskNonvarchar(50)✔️
urlnvarchar(1000)
urldescnvarchar(255)

Update locked task

Locks or unlocks all appointments for the task. A locked appointment can not be modified nor deleted on the planning board.

NameData TypeDefault ValueRequired
SourceAppnvarchar(30)✔️
SourceTypenvarchar(10)✔️
JobNonvarchar(50)✔️
TaskNonvarchar(50)✔️
Lockedbit0
SentFromBackofficebit1

Upsert task filter value

Inserts or updates a task value record. This assigns a filter value to a task. The TransferToTemp field indicates whether the task filter value(s) are being sent to Dime.Scheduler before (value = 1 or True) or after (value = 0 or False) the task is sent.

NameData TypeDefault ValueRequired
SourceAppnvarchar(30)✔️
SourceTypenvarchar(10)✔️
JobNonvarchar(50)✔️
TaskNonvarchar(50)✔️
FilterGroupnvarchar(50)✔️
FilterValuenvarchar(100)✔️
TransferToTempbit0

Delete task filter value

Deletes a task filter value record. This removes a filter value from a task.

NameData TypeDefault ValueRequired
SourceAppnvarchar(30)✔️
SourceTypenvarchar(10)✔️
JobNonvarchar(50)✔️
TaskNonvarchar(50)✔️
FilterGroupnvarchar(20)✔️
FilterValuenvarchar(20)✔️

Clear task filter value

Deletes all task filter value records. This removes all filter values from a task.

NameData TypeDefault ValueRequired
SourceAppnvarchar(30)✔️
SourceTypenvarchar(10)✔️
JobNonvarchar(50)✔️
TaskNonvarchar(50)✔️

Upsert task container

Inserts or updates a task container.

NameData TypeDefault ValueRequired
SourceAppnvarchar(30)✔️
SourceTypenvarchar(10)✔️
JobNonvarchar(50)✔️
TaskNonvarchar(50)✔️
ContainerNamenvarchar(255)✔️
Indexint

Delete task container

Removes the task container.

NameData TypeDefault ValueRequired
SourceAppnvarchar(30)✔️
SourceTypenvarchar(10)✔️
JobNonvarchar(50)✔️
TaskNonvarchar(50)✔️
ContainerNamenvarchar(255)

Resources

Upsert resources

Inserts or updates a resource record. 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.

NameData TypeDefault ValueRequired
ResourceTypeIdint
SourceAppnvarchar(30)
SourceTypenvarchar(10)
ResourceTypenvarchar(100)
ResourceNamenvarchar(100)
DisplayNamenvarchar(100)
Departmentnvarchar(50)
ResourceNonvarchar(50)✔️
Emailnvarchar(100)
Phonenvarchar(50)
MobilePhonenvarchar(50)
ReplacementResourcebit
FieldServiceEmailnvarchar(100)
PersonalEmailnvarchar(100)
GpsTrackingResourceNonvarchar(50)
HomeAddressnvarchar(max)
HomeAddressGeoLongfloat
HomeAddressGeoLatfloat
HomePhonenvarchar(50)
HomeEmailnvarchar(50)
HomeRegionnvarchar(10)
HomePostcodenvarchar(20)
HomeCitynvarchar(50)
HomeCountynvarchar(50)
HomeStatenvarchar(50)
HomeCountrynvarchar(50)
TeamCodenvarchar(20)
TeamNamenvarchar(100)
TeamTypenvarchar(20)
TeamSortint
TeamMemberTypenvarchar(20)
TeamMemberSortint
FreeText1nvarchar(100)
FreeText2nvarchar(100)
FreeText3nvarchar(100)
FreeText4nvarchar(100)
FreeText5nvarchar(100)
FreeText6nvarchar(100)
FreeText7nvarchar(100)
FreeText8nvarchar(100)
FreeText9nvarchar(100)
FreeText10nvarchar(100)
FreeText11nvarchar(100)
FreeText12nvarchar(100)
FreeText13nvarchar(100)
FreeText14nvarchar(100)
FreeText15nvarchar(100)
FreeText16nvarchar(100)
FreeText17nvarchar(100)
FreeText18nvarchar(100)
FreeText19nvarchar(100)
FreeText20nvarchar(100)
FreeDecimal1decimal(18,6)
FreeDecimal2decimal(18,6)
FreeDecimal3decimal(18,6)
FreeDecimal4decimal(18,6)
FreeDecimal5decimal(18,6)
FreeDecimal6decimal(18,6)
FreeDecimal7decimal(18,6)
FreeDecimal8decimal(18,6)
FreeDecimal9decimal(18,6)
FreeDecimal10decimal(18,6)
FreeDate1datetime
FreeDate2datetime
FreeDate3datetime
FreeDate4datetime
FreeDate5datetime
FreeBit1bit
FreeBit2bit
FreeBit3bit
FreeBit4bit
FreeBit5bit
DoNotShowbit
InServiceFromdate
InServiceTilldate
ExchangeIntegrationEnabledbit
url1nvarchar(1000)
urldesc1nvarchar(255)
url2nvarchar(1000)
urldesc2nvarchar(255)
url3nvarchar(1000)
urldesc3nvarchar(255)
BulkPlanningbit
BulkCapacitydecimal(18,6)
ResourceGpsTrackingEnabledbit
Pinnvarchar(100)

Upsert resource filter value

Inserts or updates a resource filter value record. This assigns a filter value to a resource. TransferToTemp 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.

NameData TypeDefault ValueRequired
SourceAppnvarchar(30)
SourceTypenvarchar(10)
ResourceNonvarchar(50)✔️
FilterGroupnvarchar(50)✔️
FilterValuenvarchar(100)✔️
TransferToTempbit0

Delete resource filter value

Deletes a resource filter value record. This removes a filter value from a resource.

NameData TypeDefault ValueRequired
SourceAppnvarchar(30)✔️
SourceTypenvarchar(10)✔️
ResourceNonvarchar(50)✔️
FilterGroupnvarchar(20)✔️
FilterValuenvarchar(20)✔️

Clear resource filter value

Deletes all resource filter value records for a resource. This removes all filter values from a resource.

NameData TypeDefault ValueRequired
SourceAppnvarchar(30)
SourceTypenvarchar(10)
ResourceNonvarchar(50)✔️

Upsert resource GPS tracking

Inserts or updates a resource gps tracking record. The resource number or GPS resource tracking number is required in order to successfully insert or update a record. When a record is inserted or updated the position on the map in Dime.Scheduler is updated automatically.

NameData TypeDefault ValueRequired
ResourceNonvarchar(50)
GpsTrackingResourceNonvarchar(50)
Latitudefloat
Longitudefloat
Speedint
Datedate
RowIdnvarchar(100)
Powernvarchar(50)

Upsert resource 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.

NameData TypeDefault ValueRequired
ResourceNonvarchar(50)✔️
CapacityDatedate
CapacityInSecondsbigint
CapacityQtydecimal(18,6)
CapacityUOMnvarchar(20)
CapacityUOMConversiondecimal(18,6)

Upsert resource URI

Inserts or updates a resource URI record. Resource URIs contain links to documents, web pages and the back office system.

NameData TypeDefault ValueRequired
ResourceNonvarchar(50)✔️
Urlnvarchar(1000)
UrlDescnvarchar(255)

Upsert resource 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.

NameData TypeDefault ValueRequired
ResourceNonvarchar(50)✔️
CertificateNonvarchar(50)✔️
Scorenvarchar(100)''
LastScoreDatedatetime
ValidUntildatetime

Delete resource certificate

Deletes a resource certificate record.

NameData TypeDefault ValueRequired
ResourceNonvarchar(50)✔️
CertificateNonvarchar(50)✔️

Filters

Upsert filter group

Inserts or updates a filter group record. A filter group is the base definition for the powerful filtering mechanism of Dime.Scheduler. Filter groups are used to filter on resources and tasks, but also to set up the data-driven part of the security system.

NameData TypeDefault ValueRequired
Idint0
GroupNamenvarchar(50)✔️
ColumnNoint0
DataFilterbit0

Rename filter group

Renames the filter group.

NameData TypeDefault ValueRequired
GroupNamenvarchar(50)✔️
NewGroupNamenvarchar(50)✔️

Delete filter group

Removes the filter group.

NameData TypeDefault ValueRequired
GroupNamenvarchar(50)✔️

Upsert filter value

Inserts or updates a filter value record. A filter value is the child of filter group, and a filter group is required before any filter value can be added.

NameData TypeDefault ValueRequired
FilterGroupNamenvarchar(50)✔️
FilterValuenvarchar(100)✔️

Delete filter value

Removes the filter value.

NameData TypeDefault ValueRequired
FilterGroupNamenvarchar(50)✔️
FilterValuenvarchar(100)✔️

Appointments

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.
NameData TypeDefault ValueRequired
SourceAppnvarchar(30)✔️
SourceTypenvarchar(10)✔️
AppointmentIdbigint0
JobNonvarchar(50)✔️
TaskNonvarchar(50)✔️
Subjectnvarchar(max)
Bodynvarchar(max)
Startdatetime
Enddatetime
IsAllDayEventbit0
TimeMarkernvarchar(100)
Categorynvarchar(100)
Importanceint0
Lockedbit0
ResourceNonvarchar(50)
AppointmentGuidnvarchar(50)''
ReplaceResourcebit0
SentFromBackofficebit1
BackofficeIDnvarchar(100)
BackofficeParentIDnvarchar(100)
PlanningUOMnvarchar(20)
PlanningUOMConversiondecimal(18,6)0
PlanningQtydecimal(18,6)0
UseFixPlanningQtybit0
RoundToUOMbit0

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.
NameData TypeDefault ValueRequired
SourceAppnvarchar(30)
SourceTypenvarchar(10)
AppointmentIdbigint
ResourceNonvarchar(50)''
AppointmentGuidnvarchar(50)''
SentFromBackofficebit1

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.

NameData TypeDefault ValueRequired
pSourceAppnvarchar(30)
pSourceTypenvarchar(10)
pAppointmentIdbigint0
pAppointmentGuidnvarchar(50)
pUrlnvarchar(1000)✔️
pUrlDescnvarchar(255)

Add assignment

Add a resource to an existing appointment, thereby creating a linked appointment.

NameData TypeDefault ValueRequired
SourceAppnvarchar(30)
SourceTypenvarchar(10)
AppointmentIdbigint
ResourceNonvarchar(50)✔️
AppointmentGuidnvarchar(50)''
SentFromBackofficebit1

Update appointment category

Updates the category assigned to the appointment. Can be used to update status or progress of the appointment.

NameData TypeDefault ValueRequired
SourceAppnvarchar(30)
SourceTypenvarchar(10)
AppointmentIdbigint
Categorynvarchar(100)
AppointmentGuidnvarchar(50)''
SentFromBackofficebit1

Update appointment time marker

Update the time marker assigned to the appointment. Can be used to update status or progress of the appointment.

NameData TypeDefault ValueRequired
SourceAppnvarchar(30)
SourceTypenvarchar(10)
AppointmentIdbigint
TimeMarkernvarchar(100)
AppointmentGuidnvarchar(50)''
SentFromBackofficebit1

Update locked appointment

Locks or unlocks an appointment. A locked appointment can not be modified nor deleted on the planning board.

NameData TypeDefault ValueRequired
SourceAppnvarchar(30)
SourceTypenvarchar(10)
AppointmentIdbigint
Lockedbit = 0
AppointmentGuidnvarchar(50)''
SentFromBackofficebit1

Update appointment importance

Sets the importance of an appointment.

NameData TypeDefault ValueRequired
SourceAppnvarchar(30)
SourceTypenvarchar(10)
AppointmentIdbigint
Importanceint
AppointmentGuidnvarchar(50)''
SentFromBackofficebit1

Update appointment planning quantity

Updates the planning quantity of an appointment.

NameData TypeDefault ValueRequired
SourceAppnvarchar(30)
SourceTypenvarchar(10)
AppointmentIdbigint
PlanningQtydecimal(18,6)
AppointmentGuidnvarchar(50)''
SentFromBackofficebit1

Captions

Upsert caption

Inserts or updates a caption for a DATABASEFIELD in the specified language. These captions are used in the open tasks grid, the task details pane and in the field templates.

NameData TypeDefault ValueRequired
Contextint6
SourceTablenvarchar(255)
FieldNamenvarchar(255)
Languagenvarchar(10)
Captionnvarchar(100)

Notifications

Upsert notification

Inserts or updates a notification record. The values for notification types are:

  • 0 for Information
  • 1 for Warning
  • 2 for Error.
NameData TypeDefault ValueRequired
SourceAppnvarchar(30)✔️
SourceTypenvarchar(10)
AppointmentIdbigint
mboc_idnvarchar(50)''
NotificationTypeint0
NotificationCodenvarchar(20)''
NotificationTextnvarchar(max)''
NotificationDatedatetime
JobNonvarchar(50) = ''
TaskNonvarchar(50) = ''
AppointmentGuidnvarchar(50)''
SentFromBackofficebit1

Delete notification

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.
NameData TypeDefault ValueRequired
SourceAppnvarchar(30)
SourceTypenvarchar(10)
AppointmentIdbigint
mboc_idnvarchar(50)''
AppointmentIdbigint0
JobNonvarchar(50) = ''
TaskNonvarchar(50) = ''
AppointmentGuidnvarchar(50)''
SentFromBackofficebit1

Action URI

Upsert action URI

Inserts or updates an action uri. Action URI's can launch another application while passing parameters as the selected resource and date or time.

Values for UrlType are:

  • 0: Url is shown when user right-clicks an empty slot in the planning board
  • 1: Url is shown when user right-clicks an appointment;

Only URI's with matching SourceApp and SourceType fields are shown. UrlDesc is the description shown to the user.

NameData TypeDefault ValueRequired
SourceAppnvarchar(30)
SourceTypenvarchar(10)
UrlTypeint
Urlnvarchar(1000)✔️
UrlDescnvarchar(255)
DefaultUrlbit0

Indicators

Upsert category

Inserts or updates a category record. A category is the property or attribute of an appointment that determines the color in which an appointment is displayed. The category is used to provide an immediate visual insight in the type or status of appointments.

NameData TypeDefault ValueRequired
CategoryNamenvarchar(100)✔️
DisplayNamenvarchar(100)
CategoryHexColornvarchar(50)''
ColorRint
ColorGint
ColorBint

Rename category

Renames the category.

NameData TypeDefault ValueRequired
CategoryNamenvarchar(100)✔️
NewCategoryNamenvarchar(100)✔️

Delete category

Removes this indicator from the database.

NameData TypeDefault ValueRequired
CategoryNamenvarchar(100)✔️

Upsert time marker

Inserts or updates a time marker record. A time marker is the property or attribute of an appointment that determines the colored bar displayed below the appointment in the planning board. The time marker is used to provide an immediate visual insight in the type or status of appointments.

NameData TypeDefault ValueRequired
TimeMarkernvarchar(100)✔️
HexColornvarchar(50)''
ColorRint
ColorGint
ColorBint

Rename time marker

Renames the time marker.

NameData TypeDefault ValueRequired
TimeMarkernvarchar(100)✔️
NewTimeMarkernvarchar(100)✔️

Delete time marker

Removes this indicator from the database.

NameData TypeDefault ValueRequired
TimeMarkernvarchar(100)✔️

Upsert pin

Inserts or updates a pin record. A pin is the property or attribute of an appointment that determines the colored pin on the map.

NameData TypeDefault ValueRequired
Namenvarchar(100)✔️
HexColornvarchar(50)''
ColorRint
ColorGint
ColorBint

Rename pin

Renames the pin.

NameData TypeDefault ValueRequired
Namenvarchar(100)✔️
NewNamenvarchar(100)✔️

Delete pin

Removes the indicator from the database.

NameData TypeDefault ValueRequired
Namenvarchar(30)✔️
Last updated on 12/16/2019 by Hendrik Bulens
← Import ServiceSending and receiving data →
  • Anatomy of an import stored procedure
  • Import stored procedures list
    • Jobs
    • Tasks
    • Resources
    • Filters
    • Appointments
    • Captions
    • Notifications
    • Action URI
    • Indicators
Dime.Scheduler
Manuals
  • User Manual
  • Administration
  • Installation
  • Guides
Essential links
  • Getting Started
  • FAQ
  • Get support
  • Privacy Statement
Useful resources
  • Dime.Scheduler
  • Company website
  • GitHub
Community
  • LinkedIn
  • Youtube
  • Facebook
  • Twitter

Copyright © 2021 Dimenics