Odyssee Mobile

API User Guide

In Odyssee, installations represent the objects you provide your service activities on: any piece of installed machinery or system that you want to link a specific work order to, can be represented as an installation. Installations can be linked hierarchically, allowing you to represent large and complex setups at your customers with installation structures exactly as you need them in Odyssee. These hierarchical structures are tied to a Company - one structure can only be linked to one company. The top installation of a hierarchy of non-mobile installations is required to be a Location type installation: this represents the physical address. For more information on the use of locations and the address of an installation.

Installations types in Odyssee

  • Locations are used to represent the physical addresses of the installations of your implementation. An installation is set as a Location by selecting the equipment type 'Location' for it. For non-mobile installation structures, the top installation in a hierarchy is required to be of this type. It is possible to create and process a work order created for an installation of this type, but because the equipment type is pre-set, the options here are more limited compared to other installations because the equipment type impacts things like Bill of Material or Work Instructions. It's also not possible to specify fields like barcode or serial numbers for locations - they allow to specify the address ,name and description of the location, as well as reference numbers. For Location use equipment type (equipment_family_id) EDC4D105-71A4-474E-9CC7-8DB5297CF845.

  • Installations are the generic form of an installation: they are required to be put in a hierarchy with a Location at the head, but are otherwise not restricted in how they can be configured: the full range of installation-related options is available on these.

  • Mobile installations are not bound to the restriction of being linked in a hierarchy with a Location at the top, but are rather required to be in a hierarchy consisting entirely of other mobile installations. When creating a work order on a mobile installation structure, you will be prompted to fill in a 'one-time address', which is the address that will be used as the address for the work order. In contrast to a Location, the equipment type of a mobile installation can be freely chosen. Mobile installations can be used to represent objects that are not bound to a specific address, like trucks or a construction crane.

The hierarchy of an installation structure works on a simple relation: each installation may have one installation selected as being above it in the hierarchy. As a shorthand, the installation above an installation is called its 'parent' installation, and the installation below another installation is called its 'child' (so if A is above B, then A is the parent of B, and B the child of A). Each installation may have one parent, and an installation may have an unlimited number of children.The chain of 'parent-child' relations is also not limited in depth: a child can have a child of its own, which can have a child of its own, ... , this up to an unlimited number (though in actual use you might find it practical to limited this number to a certain depth). This hierarchy not only affects the installations themselves, but is used as the hierarchy of the jobs of a grouped work order created on an installation structure (with a one-to-one relation of the positions between the installations and the respective work orders). To add parent it installation it need to set project._parent_id (This is a id of parent project).

How to distinguish Installation and Location

For Installtion equipment_family_id value: FEFA16A0-F422-4A92-8134-A624668EE8E0, for Location equipment_family_id value: EDC4D105-71A4-474E-9CC7-8DB5297CF845