Automated Import of Assets

File-Based

Implementation Steps

TaskResponsible Party

Provide decision on delivery method:

  1. FacilityOS hosted SFTP
    1. With IP Access List
    2. Without IP Access List
  2. Client Hosted SFTP 
Client  
Provide SFTP access details and credentials, as applicableFacilityOS or Client (based on client’s decision above)
Specify type of email notifications and email addresses of recipientsClient
Upload to SFTP an import file that meets the formatting requirementsClient
Set up automated job to import dataFacilityOS
Review data and confirm accuracyClient
Set up automated job to send data fileClient
Enable respective jobs for scheduled importFacilityOS & Client

 

Delivery Methods

The first step is for the client to select a delivery method.  Please select from the following:

  1. File to FacilityOS SFTP – FacilityOS establishes a dedicated SFTP folder with unique credentials and client uploads file (MOST COMMON)
    1. With IP Access List (RECOMMENDED)
      1. For scenarios where machine uploading file will have a static IP address or IP range
      2. Customer must provide IP address or IP range
    2. Without IP Access List
  2. File to client’s SFTP – Client establishes a dedicated SFTP folder with unique credentials and FacilityOS-built job retrieves files

Content & Format Requirements

CategoryRequirements
ContentAny asset data needing inserted or updated
Header RowRequired
Columns
  • See grid that follows for supported columns
  • Column names in header row must match the grid that follows
    • Not case-sensitive
  • Order of columns does not matter
  • Customer may add or subtract any columns not marked as required at any time without needing to consult FacilityOS
SFTP Folder/AssetImport
File Name(Any value)
File Format

Must be one of the following:

  • .csv
  • .txt
Field Separators

Must be one of the following:

  • Comma
    • If using comma separators, ensure commas are removed from field values during file creation or employ double-quote text qualifiers
  • Pipe
  • Tab
Text Qualifiers

Must be one of the following:

  • Double-quotes
  • (none)
Line End

Must be one of the following:

  • CR
  • LF
  • CRLF

 

Columns in File

Column NameData TypeDescription
AssetIDNvarchar(50)

Required

Unique ID/tracking number for the asset

OwnerIDNvarchar(50)EmployeeID of the asset's owner
LocationNvarchar(50)EmployeeID of the asset's location
NameNvarchar(50)Required
DescriptionNvarchar(50) 
ConditionNvarchar(50) 
ManufacturerNvarchar(50) 
ModelNumberNvarchar(50) 
SerialNumberNvarchar(50) 
WeightNvarchar(50) 
CapitalAssetNvarchar(50) 
PONumberNvarchar(50) 
AcquisitionDateDateTime 
NextMaintenanceDateTime 

 

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
Was this article helpful?
0 out of 0 found this helpful