@cityssm/faster-report-parser
Version:
Parses select Excel and CSV reports from the FASTER Web Fleet Management System into usable data objects.
94 lines (63 loc) • 4.66 kB
Markdown
# FASTER Web Report Parser
[](https://www.npmjs.com/package/@cityssm/faster-report-parser)
[](https://app.deepsource.com/gh/cityssm/node-faster-report-parser/)
**Parses select Excel (XLSX) and CSV reports from the
[FASTER Web](https://fasterasset.com/products/fleet-management-software/) 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 Name | CSV | XLSX | XML |
| --------------- | ------------------------------------ | --- | ---- | --- |
| **Assets** | | | | |
| W114 | Asset Master List (20240603.1500) | | ✔️ | |
| **Inventory** | | | | |
| W200 | Inventory Report | | ✔️ | |
| W200S | Inventory Summary Report | ✔️ | | |
| W201 | Inventory Item Issue Report | | ✔️ | |
| W217 | Direct Charge Transactions | | ✔️ | |
| W223 | Inventory Transaction Details Report | ✔️ | ✔️ | |
| W235 | Inventory Snapshot | ✔️ | | |
| **Maintenance** | | | | |
| W311 | Active Work Orders by Shop | | ✔️ | |
| W399 | Technician Work Order | | | ✔️ |
| **Setup** | | | | |
| W600 | Pick List Values Report | ✔️ | | |
| W603 | Message Logger | ✔️ | | |
| W604 | Integration 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.<br />
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.<br />
No parsers can be written for them!
## Installation
```sh
npm install @cityssm/faster-report-parser
```
## Usage
```javascript
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](https://www.npmjs.com/package/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](https://www.npmjs.com/package/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.
- [@cityssm/dynamics-gp](https://www.npmjs.com/package/@cityssm/dynamics-gp) - Unofficial integrations with the Microsoft Dynamics GP financial system.
- [@cityssm/worktech-api](https://www.npmjs.com/package/@cityssm/worktech-api) - Unofficial integrations with the WorkTech work order management system.
## Related FASTER Web Projects
[FASTER Web Report Exporter](https://github.com/cityssm/node-faster-report-exporter)<br />
On demand exports of selected reports from the FASTER Web fleet management system.
[FASTER Web Projects](https://github.com/cityssm/faster-web-projects)<br />
A list of the City's several open source projects related to the FASTER Web fleet management system.