0.6.0 • Published 5 months ago

@cityssm/faster-report-parser v0.6.0

Weekly downloads
-
License
MIT
Repository
github
Last release
5 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.

This project is completely unofficial and is in no way affiliated with or endorsed by FASTER Asset Solutions or Transit Technologies.

Supported "Standard" FASTER Web Reports

#Report NameCSVXLSX
Assets
W114Asset Master List (20240603.1500)✔️
Inventory
W200Inventory Report✔️
W200SInventory Summary Report✔️
W201Inventory Item Issue Report✔️
W217Direct Charge Transactions✔️
W223Inventory Transaction Details Report✔️✔️
W235Inventory Snapshot✔️
Maintenance
W311Active Work Orders by Shop✔️
Setup
W600Pick List Values Report✔️
W603Message Logger✔️
W604Integration Log Viewer✔️

Advanced Parsers

More than just parsing files into objects. 🧙‍♂️

extractInventoryImportErrors(messageLoggerData)

  • Takes data from a parsed CSV "W603 - Message Logger" report, attempts to identify errors related to the Inventory Import Utility (IIU) integration, and provide context of where the errors occurred.

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.

Related FASTER Web Projects

FASTER Web Report Exporter On demand exports of selected reports from the FASTER Web fleet management system.

FASTER Web Projects A list of the City's several open source projects related to the FASTER Web fleet management system.

0.3.0

11 months ago

0.5.0

8 months ago

0.4.1

8 months ago

0.4.0

9 months ago

0.6.0

5 months ago

0.2.0

12 months ago

0.1.2

1 year ago

0.1.1

1 year ago

0.1.0

1 year ago