Skip to main content

Parameters for dynamic report

Overview

Information can be passed to JSReport from FA in the form of parameters. There are some parameters (params) which the JSReport can request and some which are passed irrespective of the request. 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.

Param Name

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 auth token name for REST calls

1570453402551

param-tokenValue

String

API auth token value for REST calls

fh1238d2v4lel6vj21pbba6iuieah4ag88e7824s

param-portfolioIdTxt

String

Portfolio Text

param-portfolioId

Array of Strings

Portfolio IDs

Needs to be requested if you want to show the 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

Needs to be requested if you want to show the UI.

param-purchaseValueType

Long

Needs to be requested if you want to show the UI.

param-purchaseValueTypeTxt

String

param-transactionDateType

Long

Needs to be requested if you want to show the UI.

param-transactionDateTypeTxt

String

param-transactionTagsTxt

String

param-transactionListingTxt

String

param-transactionTypeTxt

String

param-sortingDate

Long

Needs to be requested if you want to show the UI.

param-groupBy

Long

Needs to be requested if you want to show the UI.

param-group

String

Needs to be requested if you want to show the UI.

IND

param-groupByTxt

String

param-groupBy2

String

Needs to be requested if you want to show the UI.

param-groupTxt

String

IND : Industry

param-transactionListing

Long

Needs to be requested if you want to show the UI.

param-generateEmptyReport

Boolean

Needs to be requested if you want to show the UI.

param-securityTxt

String

param-securityTypeTxt

String

Parameters sent by request

The following parameters can be requested from FA. You need to attach tags to a report to get the values from FA.

Param & Tag Name

Type/Sample

Description

Return value

param-startDate

Date

Show Date-Period Selector UI

Oct 1, 2019 12:00:00 AM

param-endDate

Date

Show Date-Period Selector UI

Oct 6, 2019 12:00:00 AM

param-reportDate

Date

Show Single Date picker

Oct 7, 2019 12:00:00 AM

param-logoImage

Byte[]

No UI

param-timePeriod

String

No UI

Oct 1, 2019 12:00:00 AM,Oct 6, 2019 12:00:00 AM / CALWEEK-1

param-security

Long

Shows Security selector UI

10529797 (database ID)

param-securityType

String

Shows Type selector UI

3

param-transactionTags

Set

Shows TextField UI

[ chosen tag ] e.g. "Settlement - waiting"

param-transactionType

Array of Strings

Shows Type selector UI

E.g. "CADD"

param-purchaseValueType

Long

Shows Radio UI selector

1

param-groupName

String

No UI

param-securityName

String

No UI

param-securityNameType

String

No UI

param-groupingName

String

No UI

param-purchaseValueName

String

No UI

param-transactionListingTxt

String

No UI

Selected time period / From positions in the time period

param-purchaseValueTypeTxt

String

No UI

Transaction purchase value

param-transactionDateType

Long

Shows Radio UI for date type

(Sent by FA without request but UI is hidden.)

0

param-transactionDateTypeTxt

String

No UI

(Sent by FA without request but UI is hidden.)

Transaction date

param-generateEmptyReport

Boolean

Shows Checkbox UI for allowing to print empty report

(Sent by FA without request but UI is hidden.)

true/false

param-group

String

Shows "Allocation group" selector UI

(Sent by FA without request but UI is hidden.)

See Using group parameters

IND

param-contactName

Array of Strings

No UI

(Sent by FA without request but UI is hidden.)

[ name of contact ] E.g. "Antti Arvo"

param-portfolioName

Array of Strings

No UI

(Sent by FA without request but UI is hidden.)

[ name of portfolio ] E.g. "Investment portfolio"

param-transactionTypeTxt

String

No UI

(Sent by FA without request but UI is hidden.)

"Add Contract"

param-transactionListing

String

Shows Selector UI for Transaction Time period

(Sent by FA without request but UI is hidden.)

1 or 2

param-groupBy2

String

Shows selector UI for Grouping

(Sent by FA without request but UI is hidden.)

See Using group parameters

E.g. "PORTFOLIO_CONTACT"

param-groupBy

Long

Shows selector UI for Grouping

(Sent by FA without request but UI is hidden.)

See Using group parameters

3

param-groupByTxt

String

No UI

(Sent by FA without request but UI is hidden.)

[ chosen selection ] e.g. "Risk classification"

param-securityTypeTxt

String

No UI

(Sent by FA without request but UI is hidden.)

[ chosen security type ] e.g. "Bond"

param-portfolioIdTxt

String

No UI

(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

(Sent by FA without request but UI is hidden.)

[ name of the security ]

param-transactionTagsTxt

String

No UI

(Sent by FA without request but UI is hidden.)

[ chosen tag ] e.g. "Settlement - waiting"

param-sortingDate

Long

Shows Selector UI for Date Type 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

Shows Portfolio Selector UI Field

(Sent by FA without request but UI is hidden.)

10527618 (database ID)

param-language

String

Shows Selector UI for language / Shown anyway

(Sent by FA without request but UI is hidden.)

fi_FI

param-transactionId

Array of Longs

Enables report to be run in transactions view

param-tradeOrderId

Array of Longs

Enables report to be run in trade orders view

Using group parameters

Best practice is to use either param-groupBy or param-groupBy2 param (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.