Constructor
new Report(opts)
Creates a report
Parameters:
| Name | Type | Description |
|---|---|---|
opts |
object | The configuration options. |
Methods
execute(rpId, reportName, reportFormat, uuid, uuid) → {Promise.<any>|Promise.<*>}
Execute the report
Parameters:
| Name | Type | Description |
|---|---|---|
rpId |
The id of the report |
|
reportName |
The download file name |
|
reportFormat |
The format of the report |
|
uuid |
The uuid of the selected node |
|
uuid |
Returns:
- Type
- Promise.<any> | Promise.<*>
execute(rpId, reportName, reportFormat, uuid, uuid) → {Promise.<any>|Promise.<*>}
Execute the report
Parameters:
| Name | Type | Description |
|---|---|---|
rpId |
The id of the report |
|
reportName |
The download file name |
|
reportFormat |
The format of the report |
|
uuid |
The uuid of the selected node |
|
uuid |
Returns:
- Type
- Promise.<any> | Promise.<*>
executeReportPlugin(className, params) → {Promise.<any>|Promise.<(*|never)>}
Execute plugin at get
Parameters:
| Name | Type | Description |
|---|---|---|
className |
The plugin className |
|
params |
Returns:
Return the properties of a folder
- Type
- Promise.<any> | Promise.<(*|never)>
executeReportPlugin(className, params) → {Promise.<any>|Promise.<(*|never)>}
Execute plugin at get
Parameters:
| Name | Type | Description |
|---|---|---|
className |
The plugin className |
|
params |
Returns:
Return the properties of a folder
- Type
- Promise.<any> | Promise.<(*|never)>
generateDownloadToken(rpId) → {Promise.<*>}
Generate a token to download a report
Parameters:
| Name | Type | Description |
|---|---|---|
rpId |
The id of the report |
Returns:
- Return void
- Type
- Promise.<*>
generateDownloadToken(rpId) → {Promise.<*>}
Generate a token to download a report
Parameters:
| Name | Type | Description |
|---|---|---|
rpId |
The id of the report |
Returns:
- Return void
- Type
- Promise.<*>
getReportPlugins() → {Promise.<*>}
Get the reports plugins list
Returns:
- Type
- Promise.<*>
getReportPlugins() → {Promise.<*>}
Get the reports plugins list
Returns:
- Type
- Promise.<*>
list(active) → {Promise.<*>}
Get the reports list
Parameters:
| Name | Type | Description |
|---|---|---|
active |
Returns:
- Type
- Promise.<*>
list(active) → {Promise.<*>}
Get the reports list
Parameters:
| Name | Type | Description |
|---|---|---|
active |
Returns:
- Type
- Promise.<*>
save(rpId, reportName, reportFormat, dstId, params, uuid) → {Promise.<any>|Promise.<*>}
Execute and save the report in the repository
Parameters:
| Name | Type | Description |
|---|---|---|
rpId |
The id of the report |
|
reportName |
The download file name |
|
reportFormat |
The format of the report |
|
dstId |
The uuid value of the destination folder or record node |
|
params |
||
uuid |
The uuid of the selected node |
Returns:
- Type
- Promise.<any> | Promise.<*>
save(rpId, reportName, reportFormat, dstId, params, uuid) → {Promise.<any>|Promise.<*>}
Execute and save the report in the repository
Parameters:
| Name | Type | Description |
|---|---|---|
rpId |
The id of the report |
|
reportName |
The download file name |
|
reportFormat |
The format of the report |
|
dstId |
The uuid value of the destination folder or record node |
|
params |
||
uuid |
The uuid of the selected node |
Returns:
- Type
- Promise.<any> | Promise.<*>
setRestUrl(restUrl)
Set the rest url
Parameters:
| Name | Type | Description |
|---|---|---|
restUrl |
The rest url |
setRestUrl(restUrl)
Set the rest url
Parameters:
| Name | Type | Description |
|---|---|---|
restUrl |
The rest url |
setToken(token)
Set the token in Report variables
Parameters:
| Name | Type | Description |
|---|---|---|
token |
The authorization token value |
setToken(token)
Set the token in Report variables
Parameters:
| Name | Type | Description |
|---|---|---|
token |
The authorization token value |