File-Based
Implementation Steps
| Task | Responsible Party |
|---|---|
Provide decision on delivery method:
| Client |
| Provide SFTP access details and credentials, as applicable | FacilityOS or Client (based on client’s decision above) |
| Specify type of email notifications and email addresses of recipients | Client |
| Upload to SFTP an import file that meets the formatting requirements | Client |
| Set up automated job to import data | FacilityOS |
| Review data and confirm accuracy | Client |
| Set up automated job to send data file | Client |
| Enable respective jobs for scheduled import | FacilityOS & Client |
Delivery Methods
The first step is for the client to select a delivery method. Please select from the following:
- File to FacilityOS SFTP – FacilityOS establishes a dedicated SFTP folder with unique credentials and client uploads file (MOST COMMON)
- With IP Access List (RECOMMENDED)
- For scenarios where machine uploading file will have a static IP address or IP range
- Customer must provide IP address or IP range
- Without IP Access List
- With IP Access List (RECOMMENDED)
- File to client’s SFTP – Client establishes a dedicated SFTP folder with unique credentials and FacilityOS-built job retrieves files
Content & Format Requirements
| Category | Requirements |
|---|---|
| Content | Any asset data needing inserted or updated |
| Header Row | Required |
| Columns |
|
| SFTP Folder | /AssetImport |
| File Name | (Any value) |
| File Format | Must be one of the following:
|
| Field Separators | Must be one of the following:
|
| Text Qualifiers | Must be one of the following:
|
| Line End | Must be one of the following:
|
Columns in File
| Column Name | Data Type | Description |
|---|---|---|
| AssetID | Nvarchar(50) | Required Unique ID/tracking number for the asset |
| Timestamp | DateTime | The timestamp used for the status update. If not provided, the current date/time at time of import will be used. Use UTC time zone |
| Status | Nvarchar(50) | Must be a valid LogisticsOS status; if not provided, a default will be used |
| OwnerID | Nvarchar(50) | EmployeeID of the asset's owner |
| Location | Nvarchar(50) | EmployeeID of the asset's location |
| Name | Nvarchar(50) | |
| Description | Nvarchar(50) | |
| Condition | Nvarchar(50) | |
| Manufacturer | Nvarchar(50) | |
| Model Number | Nvarchar(50) | |
| Serial Number | Nvarchar(50) | |
| Weight | Nvarchar(50) | |
| Capital Asset | Nvarchar(50) | |
| PO Number | Nvarchar(50) | |
| Acquisition Date | DateTime | Use local time zone |
| Next Maintenance | DateTime | Use local time zone |
| (Additional asset metadata fields) | (Varies) | Additional asset metadata fields may be included for import, and the column name and data type must align with the field configuration within LogisticsOS. If multiple metadata fields use the same name, the enabled field with the lowest # is used. |
| (Additional historical metadata fields) | Nvarchar(50) | Additional historical transaction metadata fields may be included for import. The column name must use the prefix hist: and the rest of the name must align with the field configuration within LogisticsOS. For example: hist:Signed By If multiple metadata fields use the same name, the enabled field with the lowest # is used. |
Time & Frequency
- Once per hour (DEFAULT)
- Alternatively, other frequencies can be configured per client request
Import Logic
The standard import logic is as follows:
- Using the status In Serivce:
- Add new records
- Update existing records that have changed
Email Notifications
The import job may be configured to send standard email notices for the following events:
- Success
- Failure
Archive and Retention
- After a successful import, the source file will be archived to a dedicated directory
- Archived files will be deleted after 14 days