Home >
Financial Performance Suite > Reporting > FPS Function Manager Excel Add-in >
✉ 🖶

FPS Function Manager Custom Functions

There are several custom functions available in the Financial Performance Suite (FPS) Function Manager Excel® add-in. These functions return FPS metadata, FPS data values, and time frame utility values.

Prerequisites

Most FPS functions require that the Excel® add-in is installed, opened in Excel®, and that the user is signed in with a valid Client ID and private key file. Functions that rely on FPS data or metadata also require valid access to the configured FPS API and token services.

Function Namespace

All functions are exposed in Excel® under the FPS namespace.

Example: =FPS.ACCOUNT(...)

The available functions include:

  • FPS.ACCOUNT
  • FPS.ALLOCATIONTYPE
  • FPS.ALMDATA
  • FPS.ALMSCENARIO
  • FPS.CHART
  • FPS.DATA
  • FPS.DATAITEM
  • FPS.DAYSINTIMEFRAME
  • FPS.DAYSINYEAR
  • FPS.DAYSYTD
  • FPS.MONTHINYEAR
  • FPS.ORGANIZATION
  • FPS.PREPAYDATA
  • FPS.RATIOCODE
  • FPS.RULESET
  • FPS.SOURCEMONTH
  • FPS.TIMEFRAME
  • FPS.WHATIF

FPS.ACCOUNT

Gets the name of an account.

=FPS.ACCOUNT(CategoryId, AccountId, [IncludeGL])

Parameter Description
CategoryId Category ID
AccountId Account ID
IncludeGL Optional. Include the GL selection ID.

Returns: Account name as text.

Example: =FPS.ACCOUNT(2,1450)

FPS.ALLOCATIONTYPE

Gets the name of an allocation type.

=FPS.ALLOCATIONTYPE(AllocationTypeId)

Parameter Description
AllocationTypeId Allocation type ID

Returns: Allocation type name as text.

FPS.ALMDATA

Gets the ALM data value of an account.

=FPS.ALMDATA(CategoryId, DataItemId, WhatIfId, OrganizationId, AccountSelectionType, AccountId, BeginTF, EndTF, Period, Aggregation, ScenarioId, SourceMonth)

Parameter Description
CategoryId Chart category ID
DataItemId Data item ID
WhatIfId What-if model ID
OrganizationId Organization ID
AccountSelectionType Account or code selection type ID
AccountId Account ID
BeginTF Begin time frame month serial
EndTF End time frame month serial
Period Period ID
Aggregation Aggregation ID
ScenarioId ALM scenario ID
SourceMonth Source month month-serial value

Returns: Numeric ALM data value.

FPS.ALMSCENARIO

Gets the name of an ALM scenario.

=FPS.ALMSCENARIO(ScenarioId, WhatIfModelId, CategoryId)

Parameter Description
ScenarioId ALM scenario ID
WhatIfModelId What-if model ID
CategoryId Category/ALM module ID

Returns: ALM scenario name as text.

FPS.CHART

Gets the name of a chart category.

=FPS.CHART(CategoryId)

Parameter Description
CategoryId Chart category ID

Returns: Chart category name as text.

FPS.DATA

Gets the data value of an account for a time frame selection.

=FPS.DATA(CategoryId, DataItemId, WhatIfId, OrganizationId, AccountSelectionType, AccountId, BeginTF, EndTF, Period, Aggregation, [PrepaymentType], [AllocationType], [RuleSetId])

Parameter Description
CategoryId Chart category ID
DataItemId Data item ID
WhatIfId What-if model ID
OrganizationId Organization ID
AccountSelectionType Account or code selection type ID
AccountId Account ID
BeginTF Begin time frame month serial
EndTF End time frame month serial
Period Period ID
Aggregation Aggregation ID
PrepaymentType Optional. Prepayment type ID
AllocationType Optional. Allocation type ID
RuleSetId Optional. Allocation rule set ID

Returns: Numeric FPS data value.

Example: =FPS.DATA(1,12,3,25,1,4100,24001,24003,1,1)

FPS.DATAITEM

Gets the name of a data item in a chart category.

=FPS.DATAITEM(CategoryId, DataItemId)

Parameter Description
CategoryId Chart category ID
DataItemId Data item ID

Returns: Data item name as text.

FPS.DAYSINTIMEFRAME

Gets the number of days in the specified time frame or time frame range.

=FPS.DAYSINTIMEFRAME(BeginTimeFrame, Period, [EndTimeFrame])

Parameter Description
BeginTimeFrame Begin time frame month serial
Period Period ID
EndTimeFrame Optional. End time frame month serial.

Returns: Number of days.

FPS.DAYSINYEAR

Gets the number of days in the calendar year containing the specified time frame.

=FPS.DAYSINYEAR(TimeFrame)

Parameter Description
TimeFrame Time frame month serial

Returns: Number of days in the calendar year.

FPS.DAYSYTD

Gets the number of days from the beginning of the fiscal year through the end of the specified time frame.

=FPS.DAYSYTD(TimeFrame)

Parameter Description
TimeFrame Time frame month serial

Returns: Number of days year-to-date.

FPS.MONTHINYEAR

Gets the month number within the fiscal year for the specified time frame.

=FPS.MONTHINYEAR(TimeFrame)

Parameter Description
TimeFrame Time frame month serial

Returns: Fiscal month number.

FPS.ORGANIZATION

Gets the name of an organization.

=FPS.ORGANIZATION(OrganizationId)

Parameter Description
OrganizationId Organization ID

Returns: Organization name as text.

FPS.PREPAYDATA

Gets the name of a prepayment type.

=FPS.PREPAYDATA(PrepaymentType)

Parameter Description
PrepaymentType Prepayment type ID

Returns: Prepayment type name as text.

FPS.RATIOCODE

Gets the name of a ratio code.

=FPS.RATIOCODE(CategoryId, RatioCodeId)

Parameter Description
CategoryId Category ID
RatioCodeId Ratio code ID

Returns: Ratio code name as text.

FPS.RULESET

Gets the name of an allocation rule set.

=FPS.RULESET(RuleSetId)

Parameter Description
RuleSetId Allocation rule set ID

Returns: Rule set name as text.

FPS.SOURCEMONTH

Gets a source month time frame.

=FPS.SOURCEMONTH(OffsetOrMonthYear, WhatIfModelId)

Parameter Description
OffsetOrMonthYear A numeric offset for floating source months or a date string such as Jan 2026 for fixed source months.
WhatIfModelId What-if model ID

Returns: Source month as text.

FPS.TIMEFRAME

Gets a time frame value.

=FPS.TIMEFRAME(OffsetOrMonthYear, WhatIfModelId)

Parameter Description
OffsetOrMonthYear A numeric offset for floating time frames or a date string such as Jan 2026 for fixed time frames.
WhatIfModelId What-if model ID

Returns: Time frame as text.

FPS.WHATIF

Gets the name of a what-if model.

=FPS.WHATIF(WhatIfId)

Parameter Description
WhatIfId What-if model ID

Returns: What-if model name as text.

Troubleshooting

  • Confirm that the add-in is installed and that the task pane opens successfully.
  • Sign in with a valid Client ID and a valid .pem private key file.
  • Verify that the referenced IDs and time frame values are valid for your FPS environment if a function returns an error.
  • Confirm that the add-in is connected to the correct FPS API server and token server for the active environment.

Support

For additional assistance with the FPS Function Manager Excel® add-in, use the support resources that are provided with your FPS deployment.

Parent topic: FPS Function Manager Excel Add-in