Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cityssm/node-faster-report-parser

Parses select Excel and CSV reports from the FASTER Web Fleet Management System into usable data objects.
https://github.com/cityssm/node-faster-report-parser

asset-management csv-parser faster-web fleet-management fmis xlsx-parser

Last synced: 16 days ago
JSON representation

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

Host: GitHub
URL: https://github.com/cityssm/node-faster-report-parser
Owner: cityssm
License: mit
Created: 2024-07-18T15:39:11.000Z (5 months ago)
Default Branch: main
Last Pushed: 2024-11-20T18:02:53.000Z (about 1 month ago)
Last Synced: 2024-11-20T18:11:59.584Z (about 1 month ago)
Topics: asset-management, csv-parser, faster-web, fleet-management, fmis, xlsx-parser
Language: TypeScript
Homepage: https://www.npmjs.com/package/@cityssm/faster-report-parser
Size: 452 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md

Awesome Lists containing this project

README

        # FASTER Web Report Parser

[![npm (scoped)](https://img.shields.io/npm/v/%40cityssm/faster-report-parser)](https://www.npmjs.com/package/@cityssm/faster-report-parser)

[![DeepSource](https://app.deepsource.com/gh/cityssm/node-faster-report-parser.svg/?label=active+issues&show_trend=true&token=rD0jxkWVmFU_1JBnPdo6HdKI)](https://app.deepsource.com/gh/cityssm/node-faster-report-parser/)

[![Maintainability](https://api.codeclimate.com/v1/badges/6e4f094e9e2473b3463b/maintainability)](https://codeclimate.com/github/cityssm/node-faster-report-parser/maintainability)

**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 |

| ----- | ------------------------------------ | --- | ---- |

| W114  | Asset Master List                    |     | ✔️   |

| W200  | Inventory Report                     |     | ✔️   |

| W200S | Inventory Summary Report             | ✔️  |      |

| W201  | Inventory Item Issue Report          |     | ✔️   |

| W217  | Direct Charge Transactions           |     | ✔️   |

| W223  | Inventory Transaction Details Report | ✔️  | ✔️   |

| W235  | Inventory Snapshot                   | ✔️  |      |

| W311  | Active Work Orders by Shop           |     | ✔️   |

| W600  | Pick List Values Report              | ✔️  |      |

| W604  | Integration Log Viewer               |     | ✔️   |

## 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

```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)


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

[FASTER Web Projects](https://github.com/cityssm/faster-web-projects)


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