# mstr-report-data-service

> A Node function for calling Microstrategy's reportDataService task and returning the payload as JSON.

Latest version **1.0.1** (published 2017-04-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install mstr-report-data-service
pnpm add mstr-report-data-service
yarn add mstr-report-data-service
bun add mstr-report-data-service
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2017-04-03 |
| First published | 2017-03-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 (+2 in 2 direct dependencies) |
| Install scripts | no |
| Author | Elias Hussary |
| Maintainers | eliashussary |
| Keywords | microstrategy, reportDataService, report, data, service, mstr |

## Links

- npm: https://www.npmjs.com/package/mstr-report-data-service
- Repository: https://github.com/eliash91/mstr-report-data-service
- Homepage: https://github.com/eliash91/mstr-report-data-service#readme
- Issues: https://github.com/eliash91/mstr-report-data-service/issues
- npm.io page: https://npm.io/package/mstr-report-data-service

## Dependencies (4)

- [lodash](https://npm.io/package/lodash.md) ^4.17.4
- [xml2js](https://npm.io/package/xml2js.md) ^0.4.17
- [request](https://npm.io/package/request.md) ^2.81.0
- [request-promise](https://npm.io/package/request-promise.md) ^4.2.0

## Alternatives

- [gamedig](https://npm.io/package/gamedig.md) — 29.3K weekly downloads
- [join-monster](https://npm.io/package/join-monster.md) — 12.8K weekly downloads
- [masked](https://npm.io/package/masked.md) — 5.5K weekly downloads
- [@comunica/actor-query-process-explain-logical](https://npm.io/package/@comunica/actor-query-process-explain-logical.md) — 4.7K weekly downloads
- [@veracity/vui](https://npm.io/package/@veracity/vui.md) — 4.6K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2017-04-03
- 1.0.0 — 2017-03-22

## README

# Microstrategy Report Data Service Task
A Node function for calling Microstrategy's reportDataService task and returning the payload as JSON. 

#### Note
I wrote this library out of necessity at work. - I needed to programatically run a report and receive the data as JSON, but our MSTR instance was pre v10.4. If you have an instance deployed thats v10.4 or higher, I recommend you check out the [RESTful JSON API here.](https://lw.microstrategy.com/msdz/MSDL/_CurrentGARelease/docs/projects/WebSDK/default.htm#topics/json/JSON_Data_API.htm)

Currently tested and working on Microstrategy v10.1. 

### Usage

 
| Arg               | Type      | Description 
|-                  |-          |-
| url               | string    | url of the Microstrategy's taskProc endpoint. 
| user              | string    | username.
| pass              | string    | password.
| reportID          | string    | id of the report you'd like to run. (right click on report > properties)
| server            | string    | name of the Microstrategy server.
| project           | string    | project name.
| port [optional]   | string    | port of the Microstrategy server.

``` javascript
import reportDataService from 'mstr-report-data-service'
// const reportDataService = require('mstr-report-data-service')

reportDataService({
    url: 'http://example-reports.com/MicroStrategy/servlet/taskProc',
    user: 'exampleUser',
    pass: 'P@ssw0rd',
    reportID: '20275B0811E6FD2400000080EFC52793',
    server: 'MSTR001',
    port: '0',
    project: 'BI-Reporting'
}).then(result => {
    console.log(result)
}).catch(err => {
    console.log(err)
})
```

---
_Source: https://npm.io/package/mstr-report-data-service · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._