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 |
| OwnerID | Nvarchar(50) | EmployeeID of the asset's owner |
| Location | Nvarchar(50) | EmployeeID of the asset's location |
| Name | Nvarchar(50) | Required |
| Description | Nvarchar(50) | |
| Condition | Nvarchar(50) | |
| Manufacturer | Nvarchar(50) | |
| ModelNumber | Nvarchar(50) | |
| SerialNumber | Nvarchar(50) | |
| Weight | Nvarchar(50) | |
| CapitalAsset | Nvarchar(50) | |
| PONumber | Nvarchar(50) | |
| AcquisitionDate | DateTime | |
| NextMaintenance | DateTime |
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