Skip to main content

system.mes.location.importFromCsv

Description​

Imports Locations from a CSV file provided as a string or as raw bytes. The service layer will parse the CSV content and create or update location entities based on the 'name' and 'location' columns.

Recommended to export at least one pre-existing location to CSV using the Export Locations functionality to ensure the correct format of the CSV file.

Syntax​

system.mes.location.importFromCsv(importString)
system.mes.location.importFromCsv(importBytes)

Parameters​

Either a string or bytes array representing the CSV content.

ParameterTypeDescription
importStringStringThe CSV content as a string.
importBytesPyArrayThe CSV content as raw bytes.

Returns​

The number of locations successfully imported or updated.

Code Examples​

Here is an example of how to use the importFromCsv method in the context of a Perspective File Upload Component onFileReceived event handler. Reference Perspective - File Upload Scripting for more information on the onFileReceived event handler.

Bytes​

def runAction(self, event):
	csvBytes = event.file.getBytes()
	system.mes.location.importFromCsv(csvBytes)

String​

def runAction(self, event):
	csvString = event.file.getString()
	system.mes.location.importFromCsv(csvString)