Required structure¶

helpdesktype¶

Helpdesktype is a required limetype in CRM and is based on the Lime Core database. The helpdesktype records are mapped to the case types picklist in Lime Field. Therefore, the keys in the case types picklist must have a one-to-one mapping to records of the helpdesktype lime type.

Example value: System.Picklists.Case.Type.WebTicket

All required values can be found at https://field/api/picklists/cases/types

This value MUST be defined for each helpdesktype record in CRM using the limefieldid attribute. Thus, the limefieldid attribute of helpdesktype should be flagged as required
When a helpdesk has no helpdesktype, or when the helpdesktype has no limefieldid, the case type will be left blank in Lime Field
Helpdesktype.limefieldid should only be visible and editable by admins of CRM
Helpdesktype.limefieldid is used more or less like keys are used by option fields
Using a case type in Lime Field that does not exist as a helpdesktype record in CRM will result in error

Name	Type	Length/ Belongs to	Readonly	NULL is permitted	Options/comment
limefieldid	text	64	x		This table only: Make editable in CRM for admins, invisible to other roles. Set the "Field Label" attribute in LISA of this Field to `Key` to avoid it being copied to new objects.

operatingprocedure¶

"A standard operating procedure (SOP) is a set of step-by-step instructions compiled by an organization to help workers carry out complex routine operations. SOPs aim to achieve efficiency, quality output and uniformity of performance, while reducing miscommunication and failure to comply with industry regulations."

(Wikipedia)

The list of operating procedures is sent from Field to Lime CRM using the operatingprocedure table and allows users to pick/see the connected OP on a work order.

Name	Type	Length/ Belongs to	Readonly	Options/comment
limefieldid	text	64	x	Set the "Field Label" attribute in LISA of this Field to `Key` to avoid it being copied to new objects.
title	text	255	x
inactive	yes/no		x	Will be skipped if property does not exist in crm.

resource¶

The resource table is a table that mirrors the resource concept from Lime Field. A resource can be either an internal technician working for the organization or a sub-contractor hired by the organization. Although it is not required by the integration, current implementations have set up two belongs-to relations from resource to coworker (internal technician) and company (sub-contractor) in CRM.

Name	Type	Length/ Belongs to	Readonly	Options/comment
limefieldid	text	64	x	Set the "Field Label" attribute in LISA of this Field to `Key` to avoid it being copied to new objects.
name	text	255
email	text	255
phone	text	64
inactive	yes/no

absence¶

Users of Lime Field have the ability to add time slots to resources when they are marked absent and also have their work orders directed to another resource that replaces their assignment on the work order.

To be able to see the time slots in Lime CRM, the absence table needs to be created.

Name	Type	Length/ Belongs to	Readonly	Options/comment
limefieldid	text	64	x	Set the "Field Label" attribute in LISA of this Field to `Key` to avoid it being copied to new objects.
title	text	255
start	datetime
end	datetime
resource	relation	resource
replacement	relation	resource

workorder¶

The work order lime type is required and is built upon the helpdesk lime type from the Lime Core database model.

Name	Type	Length/ Belongs to	Readonly	NULL is permitted	Options/comment
limefieldid	text	64	x		Set the "Field Label" attribute in LISA of this Field to `Key` to avoid it being copied to new objects.
helpdesk	relation	helpdesk
trait	relation	trait
title	text	255
description	text	255
inactive	yes/no
state	option				Must have options: NotStarted = Ej påbörjad, Started = Påbörjad, Finished = Avslutad
activity	option				Needs option "empty"
eventstart	datetime			x	See note about work order event
eventend	datetime			x	See note about work order event
operatingprocedure	relation	operatingprocedure
resource	relation	resource
effectivedate	datetime		x	x	Invisible field. All lists/results should remove records with future dates
started	datetime		x	x	Optional.
finished	datetime		x	x	Optional.

Note about work order event:

eventstart MUST be a datetime before the datetime given by eventend, or both needs to be empty, to make the value in CRM show up in Lime Field
when only one value of eventstart and eventend is set, or eventstart is later than eventend, a warning will be logged
Tip: Use provided VBA code example to force correct use of these properties in the CRM desktop client

Note about work order activity:

Work order activity is used to report back from Field to CRM using a picklist. The picklist is implemented as an option field in CRM. Their options must be synchronized and the key attribute in CRM must match the picklist value in Field. Example value: System.Picklists.WorkOrder.Activity.RepairedWindow

workordertask¶

Tasks are synced to CRM with the creation or updating of a workorder with checklist in Field. They are one way only and the fields are statically mapped, the name of the limetype can be changed dynamically in the config file though.

Name	Type	Length/ Belongs to	Options/comment
indent	text		Used to represent to relationships between tasks
title	text	255
responded	datetime
response	text
comment	text
description	text	255
workorder	relation
titlewithindent	text
responsetype	text
order	text		Used for sorting tasks in list view

person¶

The person table is used to connect a contact person to the helpdesk lime object. The same relation exists in Lime Field and is named PrimaryContact. Persons will only be created in Lime Field when they are linked to a helpdesk object.

Name	Type	Length/ Belongs to	Readonly	Options/comment
limefieldid	text	64	x	Set the "Field Label" attribute in LISA of this Field to `Key` to avoid it being copied to new objects.
inactive	yes/no
firstname	text	127
lastname	text	127
email	text	255
phone	text	64
mobilephone	text	64

helpdesk¶

The helpdesk lime type used by the integration is based on the Lime Core database model. This model uses relations to company and person but does not include the concept of service units which is fundamental when using Lime Field.

The service unit is the physical or virtual item that the case is all about. It may be a building, escalator, property, application, apartment, fork lift etc.

The service units used are in current implementations added as belongs to fields to the helpdesk form in CRM. Such relations needs to be set up in config so the integration can pick up the links to the other lime objects.

When the integration sees the person relation, it will create or update the person in Lime Field as well.

Name	Type	Length/ Belongs to	Readonly	NULL is permitted	Options/comment
limefieldid	text	64	x		Set the "Field Label" attribute in LISA of this Field to `Key` to avoid it being copied to new objects.
statuscolor	option				Need options "finished", "ongoing" and "new"
startdate	datetime			x
enddate	datetime			x
person	relation	person
company	relation	company
effectivedate	datetime		x	x	Invisible field. All lists/results should remove records with future dates

history¶

Users of Lime Field can write comments about cases, service units, contracts, and so on that will show up in a record log. The log can hold both system generated messages and comments written by users.

These comments are synced to the history table in CRM using the history type "comment". The biggest difference between the log and the history table is that the log is append-only. When log entries are submitted to Lime Field, the user can only add new entries and not edit previously existing entries. However, these entries are editable to users using CRM and edits will also be shown in the logs of Lime Field.

Name	Type	Length/ Belongs to	Readonly	Options/comment
limefieldid	text	64	x	Set the "Field Label" attribute in LISA of this Field to `Key` to avoid it being copied to new objects.
type	option			Needs option "comment"
helpdesk	relation	helpdesk
workorder	relation	workorder
resource	relation	resource

document¶

Both Lime CRM and Lime Field supports attaching files to objects. To keep track of when files need to be created or updated, a small set of extra attributes are needed in CRM.

When documents are sent to Lime Field they will always be using the option key "other" of the document type field in CRM. The value of the file category in Lime Field will be stored in the field named "limefieldpath".

Name	Type	Length/ Belongs to	Readonly	Options/comment
limefieldid	text	64	x	Invisible field. Set the "Field Label" attribute in LISA of this Field to `Key` to avoid it being copied to new objects.
limefieldetag	text	64	x	Invisible field. The "e" in "limefieldetag" is not a typo. Remember the "e".
limefieldpath	option			Needs option "empty"
category	option			Needs option "other"
type	option			Needs option "other"
helpdesk	relation	helpdesk
resource	relation	resource

usagequantity¶

The usagequantity table is a table that mirrors the usagequantity concept from Lime Field. Work time and/or used material when performing the job related to the work order or case.

Name	Type	Length/ Belongs to	Readonly	NULL is permitted	Options/comment
limefieldid	text	64	x		Set the "Field Label" attribute in LISA of this Field to `Key` to avoid it being copied to new objects.
title	text	255	x
description	text	1024	x
registrationdate	date		x
activity	option		x		Needs option "empty"
code	text	64	x
verificationnumber	text	64	x
quantity	decimal		x
priceperpiece	decimal		x	x
costperpiece	decimal		x	x
discount	decimal, percent		x	x
totalprice	decimal		x	x
totalcost	decimal		x	x
helpdesk	relation	helpdesk	x
workorder	relation	workorder	x
resource	relation	resource	x
inactive	bool		x		Optional. Maps to true if the `UQ.Status` in Field is `Canceled`.
metric	text	25	x		Optional.
state (status)	option		x		Optional. Must contain `Editable`, `NotEditable`, `Locked`, `Canceled`.
producttype	option		x		Optional. must contain `Time`, `Travel`, `ExternalPurchase`, `Material`, `Other`.

trait¶

Users of Lime Field have the ability to use traits to help with assigning a resource to a work order. To be able to choose a trait on work order in Lime CRM, the trait table needs to be created.

Name	Type	Length/ Belongs to	Readonly	Options/comment
limefieldid	text	64	x	Set the "Field Label" attribute in LISA of this Field to `Key` to avoid it being copied to new objects.
title	text	255
inactive	yes/no

meter¶

The meter table is a table that mirrors the meter concept from Lime Field.

Name	Type	Length/ Belongs to	Readonly	Options/comment
limefieldid	text	64	x	Set the "Field Label" attribute in LISA of this Field to `Key` to avoid it being copied to new objects.
title	text	255
location	text	255
metric	option			Needs option "empty". Must contain `Celsius`, `kWh`, `m3`, `MWh`, `kVar`.

metermeasurement¶

The metermeasurement table is a table that mirrors the meter measurement concept from Lime Field.

Name	Type	Length/ Belongs to	Readonly	Options/comment
limefieldid	text	64	x	Set the "Field Label" attribute in LISA of this Field to `Key` to avoid it being copied to new objects.
metervalue	decimal
activitycode	option			Needs option "empty"
measureddate	datetime, with seconds
comment	text	1024
meter	relation	meter
workorder	relation	workorder