Equipment master data (Equipment Operator)

ECLIC Equipment Master Data Guideline

This guideline explains how the ECLIC organisation role Equipment Operator can maintain equipment master data. Equipment data can be maintained manually in the eECD application, by CSV upload, or automatically through an API connection with an internal cleaning, transport or yard management system.

Intro and objective

The purpose of this guideline is to help Equipment Operators create, update and delete equipment master data while keeping the eECD tank-cleaning process operational and the equipment information up to date.

Equipment master data maintenance

Manual equipment master data creation

A user with the User Admin or Equipment Manager role can create and maintain equipment master data records in the eECD application.

1. Open the eECD application.

2. Select + ADD EQUIPMENT.

3. Complete the equipment details in the form.

4. Scroll down and select Save.

The eECD web application also allows users to search for a specific equipment record and update it.

CSV upload and download

When an internal TMS is not integrated with ECLIC through an API connection, equipment data must be maintained manually. A semi-manual integration is possible by downloading and uploading a CSV file through the ECLIC web application. This allows equipment data to be copied between a TMS and ECLIC.

Equipment data can be downloaded in CSV format at any time to compare the data in ECLIC with the equipment data in an internal system.

Download an equipment CSV template

1. Log in to the eECD application and select Equipment from the top-left menu.

2. Create at least one equipment record manually in ECLIC/eECD using the data fields available to you.

3. Select Download EQUIPMENT CSV. The CSV file will be requested by email.

4. When the email arrives, select Click here to download to open the CSV file.

Prepare and upload the CSV file

1. Do not change the header text in the downloaded CSV file.

2. Copy new equipment master data from your TMS or another system into the CSV file and save it as a CSV file.

3. Do not leave critical fields blank, as the file may not be uploaded.

4. Columns may be repositioned or moved as needed.

5. Upload the CSV file to ECLIC, using a new filename for each upload.

CSV upload behaviour

Be careful when overwriting existing data with empty values. To delete part of an equipment list, delete records one by one in ECLIC or contact ECLIC Support at eclicsupport@nxtport.com with the equipment IDs to be deleted.

API connection

When an internal cleaning, transport or yard management system is integrated with ECLIC, equipment master data can be created, updated and deleted automatically based on actions taken in the internal TMS.

Create

When new equipment is created in the internal system, it should also be created in ECLIC. Equipment must be unique: no equipment may have the same licence plate (tank trailer) or container ID (tank container).

• POST /v1/equipment

• POST /v1/equipment/import for bulk creation of existing equipment before using the ECLIC platform.

Update

When equipment information is updated in the internal system and the information is also an ECLIC data field, the corresponding field must be updated in ECLIC.

• GET /v1/equipment/paged

• GET /v1/equipment/{id}

• PUT /v1/equipment/{id} to update the equipment.

Delete

When equipment is no longer used and is deleted in the internal system, it can also be deleted from ECLIC.

• GET /v1/equipment/paged

• GET /v1/equipment/{id}

• DELETE /v1/equipment/{id} to delete the equipment.

Q&A: Other questions about maintaining master data

What happens if I delete an equipment master data record while eECD or ePPL transactions are pending?

Although deletion is possible, it is recommended that an equipment record or equipment ID is deleted only when there are no pending cleaning or loading transactions or e-documents, and when the online historical equipment booklet information is no longer needed by the planner or dispatcher. This can be checked using the equipment history and Assign load screens.

Deleting an equipment ID does not affect completed or archived eECD and ePPL documents. However, pending transactions and history, including historical information for up to three previous loads, are deleted automatically and cannot be retrieved.

What happens to pending or ongoing eECD and ePPL transactions when equipment master data is updated?

When one or more equipment master data fields are updated manually, through CSV upload or through the API, pending transactions reflect the latest online master data and continue using it. Completed or archived eECD and ePPL documents retain the master data from the time they were completed or archived.

What happens if I delete and re-add equipment master data?

All online eECD process data for pending transactions, such as previous-load information, and all uncompleted e-documents are lost when the equipment record is deleted. No new equipment cleaning or loading transactions can start while the equipment record is deleted. Historical and archived cleaning and loading documents remain available and searchable in the eECD and ePPL archive.

What should I do if I want to delete all company equipment records and online history?

If your company needs to delete part of a long equipment list, especially a list of more than 200 records, contact ECLIC Support at eclicsupport@nxtport.com and provide the equipment IDs to be deleted.