FSM Profitability Report Configuration
This topic is intended for administrators and developers who configure the Profitability Report button on asset and customer forms.
This reference covers settings for the Profitability Report button on Asset and Customer forms.
This topic includes the following sections:
Customer Profitability Report Button
The views/customer/profitability configuration adds the Profitability Report button in customer view mode. The report must exist in the account and accept the supplied Customer filters.
The following table lists the Customer Profitability Report button's properties, accepted values, standard defaults, and effects.
|
Property |
Accepted Value |
Standard Default |
Effect |
|---|---|---|---|
|
|
Boolean. |
|
Prevents the button from appearing when |
|
|
Page-button ID string. |
|
Identifies the button. |
|
|
Text or translation identifier. |
Translated Profitability Report label. |
Sets the button text. |
|
|
Report internal ID number. |
Configured entity profitability report, or |
Selects the report in this account. |
|
|
Web address template string. |
Report runner web address defined after this table. |
Builds the filtered report link. |
The standard report web address is /app/reporting/reportrunner.nl?cr=${ report }&crit_1_mod=${ date }&crit_1_from=${ start }&crit_1_to=${ end }&crit_2=${ entity }&crit_3=${ name }.
The template context contains the following values:
-
report- The report ID -
date-"CUSTOM" -
start- January 1, 1970, formatted as an account date -
end- January 1, 2100, formatted as an account date -
entity- The customer entity title, encoded for use in a web address -
name- An empty value
The report ID comes from the accounting setting or installed account report information. The component can show the button even when the report default is 0. Changing reports can require corresponding changes to filter positions in the report web address and to report access.
Complete Standard Object with Dynamic Values
This object shows all declared standard defaults and retains expressions for dynamic values.
{
"views/customer/profitability": {
hidden: false,
name: "custpage_nx_profitability",
label: "custcollection_fsm.profitability_customer_report_button_label",
report: getEntityProfitabilityReport(state) || 0,
url: "/app/reporting/reportrunner.nl?cr=${ report }&crit_1_mod=${ date }&crit_1_from=${ start }&crit_1_to=${ end }&crit_2=${ entity }&crit_3=${ name }",
}
}
The report property is resolved from the account's entity profitability report setting or installed report information, with 0 as the fallback.
Asset Profitability Report Button
The views/asset/profitability configuration adds the Profitability Report button in asset view mode. The selected report must exist in the account and support the supplied Asset filter.
The following table lists the Asset Profitability Report button's properties, accepted values, standard defaults, and effects.
|
Property |
Accepted Value |
Standard Default |
Effect |
|---|---|---|---|
|
|
Boolean value. |
|
Prevents the button from appearing when |
|
|
Page-button ID string |
|
Identifies the button. |
|
|
Text or translation identifier |
Translated Profitability Report label. |
Sets the button text. |
|
|
Report internal ID number |
Configured Asset profitability report, or |
Selects the report. Use the report's internal ID from the account. |
|
|
Web address template string |
|
Builds the report link. |
The web address template context contains report and the Asset name encoded for use in a web address. Here, name is the asset name, not the page-button ID. The report default comes from the accounting setting or installed account report information. A default of 0 doesn't identify a usable report. The component doesn't use that value to hide the button. A replacement web address must use the report's required filter positions and permissions.
Complete Standard Object with Dynamic Values
This example shows the complete declared standard defaults and retains expressions for dynamic values.
{
"views/asset/profitability": {
hidden: false,
name: "custpage_nx_profitability",
label: "custcollection_fsm.profitability_asset_report_button_label",
report: getAssetProfitabilityReport(state) || 0,
url: "/app/reporting/reportrunner.nl?cr=${ report }&crit_2=${ name }",
}
}
The report property is resolved from the account's Asset profitability report setting or installed report information, with 0 as the fallback.