0.2.0 • Published 2 months ago

@cityssm/faster-report-parser v0.2.0

Weekly downloads
-
License
MIT
Repository
github
Last release
2 months ago

FASTER Web Report Parser

npm (scoped) DeepSource Maintainability

Parses select Excel (XLSX) and CSV reports from the FASTER Web Fleet Management System into usable data objects.

Useful when developing integrations between FASTER Web and other systems.

Supported "Standard" FASTER Web Reports

#Report NameCSVXLSX
W114Asset Master List✔️
W200Inventory Report✔️
W200SInventory Summary Report✔️
W217Direct Charge Transactions✔️
W223Inventory Transaction Details Report✔️✔️
W235Inventory Snapshot✔️
W311Active Work Orders by Shop✔️
W600Pick List Values Report✔️

Important Notes

⚠️ When parsing reports, use the files as exported from FASTER Web. Reports that are opened and resaved in Excel will lose formatting required by the parsers.

⚠️ Excel exports from search results and other tables are not valid Excel files. No parsers can be written for them!

Installation

npm install @cityssm/faster-report-parser

Usage

import { parseW223ExcelReport } from '@cityssm/faster-report-parser/xlsx'

const parsedReport = parseW223ExcelReport('C:/path/to/report.xlsx')

console.log(parsedReport.data[0].storeroomDescription)
// => "MAIN STOREROOM"

Integration Tips

💡 Schedule exporting the necessary reports in FASTER Web to an FTP, then download those reports for parsing.

  • basic-ftp does a great job downloading from FASTER Web FTP sites!

💡 Schedule downloading reports from the FTP based on the export schedule defined in FASTER Web.

  • node-schedule makes it easy to schedule downloading new reports using parameters very similar to the scheduling parameters in FASTER Web.

💡 Make use of other APIs and import tools to integrate with other systems.

More Code for FASTER Web

FASTER Web Helper A service to support integrations with the FASTER Web fleet management system.

Userscripts for FASTER Web Fixes some of the common irks when using FASTER Web.