Skip to content
English
More support Ticket overview
  • There are no suggestions because the search field is empty.

Guide to all imports in the Shoreline platform

Import Parameters by Data Object 

1. Sites

Parameters you can import:

  • SITE_ID (mandatory, external unique)

  • NAME

  • DESCRIPTION

  • LAT, LONG (GPS coordinates)

  • TIMEZONE (IANA string)

  • Any site custom fields

2. Assets

Parameters you can import:

  • EXTERNAL_ASSET_ID (mandatory, unique)

  • SITE_ID (must refer to valid site)

  • NAME

  • TYPE (must exist in Settings)

  • SERIAL_NUMBER

  • MODEL

  • MANUFACTURER

  • LAT, LONG

  • COMMISSIONING_DATE

  • WORK_PACKAGE_ID

  • LOADOUT_EXTERNAL_ID

  • Custom asset fields

3. Subassemblies

Parameters:

  • EXTERNAL_SUBASSEMBLY_ID (mandatory)

  • ASSET_ID (parent asset required)

  • NAME

  • DESCRIPTION

  • SERIAL_NUMBER

  • MANUFACTURER

  • Custom subassembly fields

4. Components

Parameters:

  • EXTERNAL_COMPONENT_ID (mandatory)

  • SUBASSEMBLY_ID (parent required)

  • ASSET_ID (matching asset)

  • NAME

  • DESCRIPTION

  • PART_NUMBER

  • MANUFACTURER

  • Custom component fields

5. Personnel

Parameters:

  • EXTERNAL_EMPLOYEE_ID (mandatory)

  • FIRST_NAME, LAST_NAME

  • EMAIL (valid, unique)

  • PHONE_NUMBER

  • EMPLOYEE_NUMBER

  • ROLE

  • DEPARTMENT

  • PERMISSION_TYPE

  • SKILLS (comma-separated)

  • CERTIFICATES

  • HIRE_DATE

  • STATUS

  • Custom personnel fields

6. Work Orders

(Includes Checklists and Bill of Materials)

Main Work Order Fields

  • EXTERNAL_WORKORDER_ID (unique, mandatory)

  • SITE_ID (mandatory)

  • ORDER_TYPE (must exist)

  • NAME

  • ASSET_ID (optional but recommended)

  • SUBASSEMBLY_ID (optional)

  • COMPONENT_ID (optional)

  • DESCRIPTION / EXTERNAL_REMARKS

  • INTERNAL_REMARKS

  • PRIORITY ("Urgent", "High", "Medium", "Low")

  • STATUS (Kanban status)

  • SCHEDULED_START_DATE / SCHEDULED_END_DATE

  • ACTUAL_START_DATE / ACTUAL_END_DATE

  • WORK_PACKAGE_ID

  • SKILLS_REQUIRED (comma-separated skill names)

  • VESSEL_TYPE

  • ESTIMATED_HOURS

  • VO_IDENTIFIER

  • VO_AGREED_WITH

  • VO_SIGNED (Boolean)

  • Custom work order fields

Special Fields for Advanced Imports

a. Bill of Materials (BOM)

Used to associate inventory items with the work order.

Formats accepted:

  • API-based import: Nested object (preferred for scripts)

  • CSV/Excel import:
    "inventoryName:quantity|inventoryName2:quantity2"

Example:

BILL_OF_MATERIALS = "Bolt:20|Filter:5|Grease:1"

Backend Logic:

  • The importer parses this field (see workOrderImporter.js in MPA-API).

  • Quantities must be positive numbers.

  • Inventory names must exist in the system.

  • Non-consumables default to quantity 1.

b. Checklists

Checklists link work orders to templates with predefined steps.

Field name: CHECKLIST_TEMPLATES
Format: List of external checklist template IDs, separated by |

Example:

CHECKLIST_TEMPLATES = "TEMPLATE_1|TEMPLATE_2"

Backend Logic:

  • After import, the backend creates or updates checklists for the work order using the referenced templates.

c. Custom Fields

Work orders support custom field types such as:

  • TYPE_NUMBER, TYPE_TEXT, TYPE_SELECT, etc.

  • Selects may be single or multiple (comma or pipe-separated).

  • Required custom fields must be filled.

d. Tasks (Advanced)

Field: TASKS
Format:

"TaskID>>ActivityCategoryID>>SubassemblyID>>Description>>EstimatedTime|..."

7. Activities

Parameters:

  • NAME

  • ACTIVITY_CATEGORY (linked via Settings)

  • DESCRIPTION

  • ESTIMATED_HOURS

  • Other activity custom fields

8. Work Packages

Parameters:

  • NAME

  • START_DATE

  • END_DATE

  • DESCRIPTION

  • ASSET_TYPE (comma-separated)

  • STATUS

  • NUMBER_OF_ASSETS (integer)

  • Additional package custom fields

9. Inventory

Parameters:

  • NAME

  • INVENTORY_NAME_ID

  • SITE_ID

  • QUANTITY

  • UNIT_OF_MEASUREMENT

  • SERIAL_NUMBER

  • PART_NUMBER

  • VENDOR_PART_NUMBER

  • VENDOR

  • BATCH_NUMBER

  • EXPIRY_DATE

  • LAST_CALIBRATION_DATE

  • MIN_STOCK_LEVEL

  • MAX_STOCK_LEVEL

  • Custom fields

10. Inventory Names

Parameters:

  • NAME

  • UNIT_OF_MEASUREMENT

  • CATEGORY

  • Specification fields

11. Other Settings Data

Setting Type Key Fields
Permissions NAME, settings
Roles NAME, description, default permission/comp settings
Departments NAME, hierarchy, description
Activity Categories NAME, work package, description
Certificates (Transport) Certification-specific fields

🛠️ Special Notes on Checklist & BOM Import (Work Orders)

How to Import

  • Checklists: Use CHECKLIST_TEMPLATES in CSV/XLS — values are external template IDs separated by |.

  • Bill of Materials: Use BILL_OF_MATERIALS — format as "inventoryName:quantity|inventoryName2:quantity2".

Backend Behavior

  • Checklists: Backend links and auto-creates referenced checklists (see workOrderImporter.js).

  • BOM: Links matching inventory items and sets up planned inventory references.

⚠️ Import Quirks & Tips

  • Date formats: Must be consistent. Errors occur on mismatch.

  • Relationship validation: Hierarchies (Component → Subassembly → Asset) must exist.

  • Custom fields: Multi-selects separated by , or |; values validated.

  • Checklist & BOM: Backend may skip or warn if references are invalid or misformatted.

📝 Recommendations

  • Export a sample first to verify column names and formats.

  • Use consistent external IDs.

  • Ensure all referenced entities exist before import.