Parameters for dynamic report
Overview
Information can be passed to jsreport from FA in the form of parameters. There are some parameters (params) which jsreport can request and some which are passed irrespectively. This page contains information about both parameter types.
Parameters sent always
FA Back sends the following parameters without asking. There is no need to create and attach tags for them.
Parameter | Type/Sample | Description | Return value |
|---|---|---|---|
param-graphqlUri | String URL | API base URL for GraphQL calls | http://xyz:8080/graphql |
param-userAccessToken | String URL | Access token to be used in GraphQL calls | |
param-apiUri | String URL | API base URL for REST calls | http://localhost:8080/rs/ |
param-tokenName | String | API authentication token name for REST calls | 1570453402551 |
param-tokenValue | String | API authentication token value for REST calls | fh1238d2v4lel6vj21pbba6iuieah4ag88e7824s |
param-portfolioIdTxt | String | Portfolio text | |
param-portfolioId | Array of Strings | Portfolio IDs This needs to be requested if you want to show its UI. | |
param-portfolioName | Array of Strings | Name of portfolio(s) | |
param-portfolioInfos | Array of Strings | [object Object] | |
param-contactName | Array of Strings | Name of contact(s) | |
param-language | String | Language code This needs to be requested if you want to show its UI. | |
param-purchaseValueType | Long | This needs to be requested if you want to show its UI. | |
param-purchaseValueTypeTxt | String | ||
param-transactionDateType | Long | This needs to be requested if you want to show its UI. | |
param-transactionDateTypeTxt | String | ||
param-transactionTagsTxt | String | ||
param-transactionListingTxt | String | ||
param-transactionTypeTxt | String | ||
param-sortingDate | Long | This needs to be requested if you want to show its UI. | |
param-groupBy | Long | This needs to be requested if you want to show its UI. | |
param-group | String | This needs to be requested if you want to show its UI. | IND |
param-groupByTxt | String | ||
param-groupBy2 | String | This needs to be requested if you want to show its UI. | |
param-groupTxt | String | IND : Industry | |
param-transactionListing | Long | This needs to be requested if you want to show its UI. | |
param-generateEmptyReport | Boolean | This needs to be requested if you want to show its UI. | |
param-securityTxt | String | ||
param-securityTypeTxt | String |
Parameters sent by request
The following parameters can be requested from FA. You need to attach the tags to a report to get the values from FA.
Param & Tag Name | Type/Sample | Description | Return value |
|---|---|---|---|
param-startDate | Date | This enables the Date-Period selector UI. | Oct 1, 2019 12:00:00 AM |
param-endDate | Date | This enables the Date-Period selector UI. | Oct 6, 2019 12:00:00 AM |
param-reportDate | Date | This enables the Single Date picker. | Oct 7, 2019 12:00:00 AM |
param-logoImage | Byte[] | No UI is available for this parameter. | |
param-timePeriod | String | No UI is available for this parameter. | Oct 1, 2019 12:00:00 AM,Oct 6, 2019 12:00:00 AM / CALWEEK-1 |
param-security | Long | This enables the Security selector UI. | 10529797 (database ID) |
param-securityType | String | This enables the Type selector UI. | 3 |
param-transactionTags | Set | This enables the TextField UI. | [ chosen tag ] e.g. "Settlement - waiting" |
param-transactionType | Array of Strings | This enables the Type selector UI. | CADD |
param-purchaseValueType | Long | This enables the Radio UI selector. | 1 |
param-groupName | String | No UI is available for this parameter. | |
param-securityName | String | No UI is available for this parameter. | |
param-securityNameType | String | No UI is available for this parameter. | |
param-groupingName | String | No UI is available for this parameter. | |
param-purchaseValueName | String | No UI is available for this parameter. | |
param-transactionListingTxt | String | No UI is available for this parameter. | Selected time period / From positions in the time period |
param-purchaseValueTypeTxt | String | No UI is available for this parameter. | Transaction purchase value |
param-transactionDateType | Long | This enables the Radio UI for date type. (Sent by FA without request but UI is hidden.) | 0 |
param-transactionDateTypeTxt | String | No UI is available for this parameter. (Sent by FA without request but UI is hidden.) | Transaction date |
param-generateEmptyReport | Boolean | This enables the Checkbox UI for allowing to print empty report. (Sent by FA without request but UI is hidden.) | true/false |
param-group | String | This enables the Allocation Group selector UI (Sent by FA without request but UI is hidden.) | IND |
param-contactName | Array of Strings | No UI is available for this parameter. (Sent by FA without request but UI is hidden.) | [ name of contact ] E.g. "Antti Arvo" |
param-portfolioName | Array of Strings | No UI is available for this parameter.. (Sent by FA without request but UI is hidden.) | [ name of portfolio ] E.g. "Investment portfolio" |
param-transactionTypeTxt | String | No UI is available for this parameter. (Sent by FA without request but UI is hidden.) | "Add Contract" |
param-transactionListing | String | This enables the Transaction Time Period selector UI. (Sent by FA without request but UI is hidden.) | 1 or 2 |
param-groupBy2 | String | This enables the Grouping selector UI. (Sent by FA without request but UI is hidden.) | "PORTFOLIO_CONTACT" |
param-groupBy | Long | This enables the Grouping selector UI. (Sent by FA without request but UI is hidden.) | 3 |
param-groupByTxt | String | No UI is available for this parameter. (Sent by FA without request but UI is hidden.) | [ chosen selection ] e.g. "Risk classification" |
param-securityTypeTxt | String | No UI is available for this parameter. (Sent by FA without request but UI is hidden.) | [ chosen security type ] e.g. "Bond" |
param-portfolioIdTxt | String | No UI is available for this parameter. (Sent by FA without request but UI is hidden.) | [ name of contact ] e.g. "Antti Arvo" or [ name of portfolio ] e.g. "Investment portfolio" |
param-securityTxt (Securities) | String | No UI is available for this parameter. (Sent by FA without request but UI is hidden.) | [ name of the security ] |
param-transactionTagsTxt | String | No UI is available for this parameter. (Sent by FA without request but UI is hidden.) | [ chosen tag ] e.g. "Settlement - waiting" |
param-sortingDate | Long | This enables the Date Type selector UI for another Date component (Transaction date / Settlement date). (Sent by FA without request but UI is hidden.) | 0 or 1 |
param-portfolioId | Array of Strings | This enables the Portfolio selector UI field. (Sent by FA without request but UI is hidden.) | 10527618 (database ID) |
param-language | String | The Language selector UI is always enabled. (Sent by FA without request but UI is hidden.) | fi_FI |
param-transactionId | Array of Longs | This enables the report to be run in the transactions view. | |
param-tradeOrderId | Array of Longs | This enables the report to be run in the trade orders view. |
Using group parameters
The best practice is to use either the param-groupBy or param-groupBy2 parameter (but not both) together with param-group. When you select the "Asset class" or "Asset type" value in either of the Grouping selectors, this dynamically makes the "Allocation group" (i.e. param-group) selector to appear. Thus, param-group should not be used alone.