Functions
In the functions list below you can see in which system area you can use the different functions and examples of Microsoft Excel and Report Generator functions.
Note that this list includes functions for Forms.
For more information on parameters, see IBM Controller Parameters.
fAcc
Account.
Used in: The Report Generator
Input parameters: fAcc(Optional)
Example: fAcc() => 2099
fAccName
Account Name.
Used in:
- IBM Controller Link for Microsoft Excel
- Forms
- Report Generator
Input parameters: fAccName(Optional, Acc)
Example: fAccName('2099') => Net Income
fAccShort
Account Short Name.
Used in:
- IBM Controller Link for Microsoft Excel
- Forms
- Report Generator
Input parameters: fAccShort(Optional, Acc)
Example: fAccShort('2099') => Net Prof.
fAccType
Account Type.
Used in:
- IBM Controller Link for Microsoft Excel
- Forms
- Report Generator
Input parameters: fAccType(Optional, Acc)
Example: fAccType('2099') => I
fAct
Actuality.
Used in:
- Forms
- Report Generator
Input parameters: fAct(Optional)
Example: fAct() => AC
fActName
Actuality Name.
Used in:
- IBM Controller Link for Microsoft Excel
- Forms
- Report Generator
Input parameters: fActName(Optional, Act)
Example: fActName('AC') => Actual
fCalcVal
Updates the database with the value calculated in Cell. This value is calculated when you run Group/Calculate Report Formulas. Acc is the account to store the calculated value on and Cell can be a formula or the value to store on the account.
Used in:
- The Report Generator
Input parameters: fCalcVal(Per;Act;Comp;CurrCode;Acc; Dim1-4;JrnType;Cell)
Example: fCalcVal('0112';'AC';'4001';'SEK';'3010'; 'FR1';;;;'AA';B20) => 44444
fCbm
Period for the closing of the books.
Used in:
- IBM Controller Link for Microsoft Excel
- Forms
- Report Generator
Input parameters: fCbm()
Example: fCbm() => 12
fCComp
Counter Company.
Used in:
- The Report Generator
Input parameters: fCComp(Optional)
Example: fCComp() => 1001
fCDim
Counter Dimension.
Used in:
- The Report Generator
Input parameters: fCDim(Optional)
Example: fCDim() => 7060
fClosVer
Closing Version.
Used in:
- Forms
- Report Generator
Input parameters: fClosVer(Optional)
Example: fClosVer() => REPO
fClosVerName
Closing version name.
Used in:
- IBM Controller Link for Microsoft Excel
- Forms
- Report Generator
Input parameters: fClosVerName(Optional, ClosVer)
Example: fClosVerName('REPO') => Reported value
fComment
Retrieves comments entered on the specified account in a form. The function can retrieve text containing up to 255 characters. If you need to retrieve more than 255 characters then use the function fCommentLong.
Used in:
- IBM Controller Link for Microsoft Excel
- Report Generator
Input parameters: fComment(Per;Act;Comp;CurrCode; Acc;Dim 1-4;JrnType)
Example: fComment('0212';'AC';'1100';'USD';'3010';'JT') =>This account is...
fCommentLong
Retrieves comments entered on the specified account that exists on a form. Where no Destination Cell is entered, the comment will be inserted in the first cell to the right of the function. Please note that if a Destination Cell is specified it must be an absolute cell reference and put within quotes. Due to performance issues, use this function only if you need to retrieve text containing more than 255 characters. Otherwise use the function fComment.
Used in:
- IBM Controller Link for Microsoft Excel
- Report Generator
Input parameters: fCommentLong(Per;Act;Comp;CurrCode;Acc;Dim1-4;JrnType;Dest.Cell)
Example: fCommentLong('0112';'AC';'1001';'SEK';'2099';FR1;;;;'$A$5')
fComp
Company Code.
Used in:
- Forms
- Report Generator
Input parameters: fComp(Optional)
Example: fComp() => 1000
fCompCurr
The currency of the specified company's currency type in a certain period.
Used in:
- IBM Controller Link for Microsoft Excel
- Forms
- Report Generator
Input parameters: fCompCurr(Comp;CurrType;Per)
Example: fCompCurr('1200';'LC';'0112') => SEK
fCompGroup
The group to which the specified company belongs.
Used in:
- IBM Controller Link for Microsoft Excel
- Forms
- Report Generator
Input parameters: fCompGroup(Comp;ConsType;Per)
Example: fCompGroup('1200';'LE';'0112') => 1000
fCompInfo
Company information from the More Information tab in the Company Structure window. The information is retrieved from the specified row number.
Used in:
- IBM Controller Link for Microsoft Excel
- Forms
- Report Generator
Input parameters: fCompInfo(Comp;RowNo)
Example: fCompInfo('1200';1) => This company is...
fCompLock
The company lock function returns True or False. True - the company is locked. False - the company is unlocked. When the submission parameter is left out or set to zero, the last updated submission's status is shown.
Used in:
- IBM Controller Link for Microsoft Excel
- Forms
- Report Generator
Input parameters: fCompLock(Per;Act;Comp;Optional Submission)
Example: fCompLock('0012';'AC';'1100')
fCompName
Company Name.
Used in:
- IBM Controller Link for Microsoft Excel
- Forms
- Report Generator
Input parameters: fCompName(Optional, Comp)
Example: fCompName('1001') => IBM UK
fCompOwnp
The company's owned percentage.
Used in:
- IBM Controller Link for Microsoft Excel
- Forms
- Report Generator
Input parameters: fCompOwnp(Comp;ConsType;Per)
Example: fCompOwnp('1001';'LE';'0112') => 100
fCompShort
Company short name.
Used in:
- IBM Controller Link for Microsoft Excel
- Forms
- Report Generator
Input parameters: fCompShort(Optional, Comp)
Example: fCompShort('1001') => FR. AB
fCompType
Company type code, K (group) or D (subs.).
Used in:
- IBM Controller Link for Microsoft Excel
- Forms
- Report Generator
Input parameters: fCompType(Optional, Comp)
Example: fCompType('1000') => K
fCompVotep
The company's vote percentage.
Used in:
- IBM Controller Link for Microsoft Excel
- Forms
- Report Generator
Input parameters: fCompVotep(Comp;ConsType;Per)
Example: fCompVotep('1001';'LE';'0112') => 100
fConsMethod
The company's consolidation method.
Used in:
- IBM Controller Link for Microsoft Excel
- Forms
- Report Generator
Input parameters: fConsMethod(Comp;ConsType;Per)
Example: fConsMethod('1001';'LE';'0112') => P
fConsType
Consolidation Type.
Used in:
- Forms
- Report Generator
Input parameters: fConsType(Optional)
Example: fConsType() => LE
fConsTypeName
Consolidation type name.
Used in:
- IBM Controller Link for Microsoft Excel
- Forms
- Report Generator
Input parameters: fConsTypeName(Optional, ConsType)
Example: fConsTypeName('LE') => Legal
fContVer
Contribution Version.
Used in:
- Forms
- Report Generator
Input parameters: fContVer(Optional)
Example: fContVer() => BASE
fContVerName
Contribution version name.
Used in:
- IBM Controller Link for Microsoft Excel
- Forms
- Report Generator
Input parameters: fContVerName(Optional, ContVer)
Example: fContVerName('BASE') => Base Value
fCRate
Currency rate. The available rate types are: B(Closing rate) M(Average Yr rate) D(Average period rate)
Used in:
- IBM Controller Link for Microsoft Excel
- Forms
- Report Generator
Input parameters: fCRate(Per;Act;CurrCode;RateType)
Example: fCRate('0112';'AC';'USD';'B') => 10,57
fCUnit
Currency unit by which the currency is divided/multiplied in the currency rate register (E.g. 1, 10, 100).
Used in:
- IBM Controller Link for Microsoft Excel
- Forms
- Report Generator
Input parameters: fCUnit(CurrCode)
Example: fCUnit('SEK') => 1
fCurr
Currency code for the specified company and currency type. Index can be used, for example the 6th company in the index, but this is optional, it can be blank.
Used in:
- IBM Controller Link for Microsoft Excel
- Report Generator
Input parameters: fCurr(Optional, CompIndex; Optional, CurrIndex)
Example: fCurr(6;1) => GBP
fCurrType
The currency type code.
Used in:
- Forms
fCurrTypeName
The currency type code.
Used in:
- Forms
fDim1
Extended Dimension 1.
Used in:
- Forms
- Report Generator
Input parameters: fDim1(Optional)
Example: fDim1() => COMP
fDim2
Extended Dimension 2.
Used in:
- Forms
- Report Generator
Input parameters: fDim2(Optional)
Example: fDim2() => 7060
fDim3
Extended Dimension 3.
Used in:
- Forms
- Report Generator
Input parameters: fDim3(Optional)
Example: fDim3() => 1030
fDim4
Extended Dimension 4.
Used in:
- Forms
- Report Generator
Input parameters: fDim4(Optional)
Example: fDim4() => 7500
fDim1Name
Extended dimension 1 name.
Used in:
- IBM Controller Link for Microsoft Excel
- Forms
- Report Generator
Input parameter: fDim1Name(Optional, Dim1)
Example: fDim1Name('COMP') => Computer
fDim2Name
Extended dimension 2 name.
Used in:
- IBM Controller Link for Microsoft Excel
- Forms
- Report Generator
Input parameter: fDim2Name(Optional, Dim2)
Example: fDim2Name('7060') => ASIA
fDim3Name
Extended dimension 3 name.
Used in:
- IBM Controller Link for Microsoft Excel
- Forms
- Report Generator
Input parameters: fDim3Name(Optional, Dim3)
Example: fDim3Name('1030') => Lund
fDim4Name
Extended dimension 4 name.
Used in:
- IBM Controller Link for Microsoft Excel
- Forms
- Report Generator
Input parameters: fDim4Name(Optional, Dim4)
Example: fDim4Name('7500') => Saft
fExpVal
Exports values to the IBM Controller database using specified parameters.
The records that are defined for the function fExpVal must be unique. The function fExpVal does not allow duplicate records. Aggregate the duplicate records before you define the fExpVal function formula.
Used in:
- IBM Controller Link for Microsoft Excel
Input parameters: fExpVal(Per;Act;Comp;CurrCode;Acc;Dim1-4;CComp;Orig Comp;CDim;Trans CurrCode;Amount;Trans Amount)
Minimum req parameters: Per;Act;Comp;CurrCode;Acc;Amount.
Example: fExpVal('0112';'AC';'1001';'SEK';'2099';;;;;'2200';;;;750;) => 750
fForm
The currency type code.
Used in:
- Forms
fFormName
The form name.
Used in:
- Forms
fGetVal
Value stored for the specified parameters.
Used in:
- IBM Controller Link for Microsoft Excel
- Report Generator
Input parameters: fGetVal(Per;Period Formula;Interval; Act;Comp;ConsType;Group Persp;CurrCode/ CurrType;Acc;Movement; Dim1-4;ClosVer/JrnType; Is ClosVer;ContVer/Auto Jrn;Is ContVer;Form;CComp; CDim;JournalNo)
Is ClosVer and Is ContVer require T (True) or F (False) as input (T is default if nothing is entered). For example Is ClosVer T means that closing version is used as input. F means that Journal Type is expected as input. Minimum req parameters: Per;Act;Comp;CurrType/CurrCode; Acc;ClosVer/JrnType;Is ClosVer;ContVer/AutoJrn;Is ContVer.
Example: fGetVal('0112';'+0';'YTD';'AC';'4001';'LE';;'LC'; '3010';;;'REPO';'T';;;;;) => 55555
fGetValTrans
Retrieve the transaction amount for a given transaction currency.
Used in:
- IBM Controller Link for Microsoft Excel
- Report Generator
Input parameters: fGetValTrans(Per;Period Formula;Interval; Act;Comp;ConsType;Group Persp;CurrCode/ CurrType;Acc;Movement; Dim1-4;ClosVer/JrnType; Is ClosVer;ContVer/Auto Jrn;Is ContVer;Form;CComp; CDim;JournalNo,TraCurrCode)
Is ClosVer and Is ContVer requires T (True) or F (False) as input. Defaults to T if nothing is entered. For example, Is ClosVer T means that closing version is used as input. F means that Journal Type is expected as input. Minimum required parameters: Per;Act;Comp;CurrType/CurrCode; Acc;ClosVer/JrnType;Is ClosVer;ContVer/AutoJrn;Is ContVer,TraCurrCode. Use this formula for intercompany accounts with transaction currency (type J).
fGroup
Group code. Returns the parameter Group Perspective in fGetVal.
Used in:
- Forms
- Report Generator
Input parameters: fGroup(Optional)
Example: fGroup() => 1000
fGroupName
Group name.
Used in:
- IBM Controller Link for Microsoft Excel
- Forms
- Report Generator
Input parameters: fGroupName(Optional, Group)
Example: fGroupName('1000') => IBM
fJournalNo
Journal Number.
Used in:
- The Report Generator
Input parameters: fJournalNo(Optional)
Example: fJournalNo() => 101
fJournalText
Journal description text.
Used in:
- IBM Controller Link for Microsoft Excel
- Report Generator
Input parameters: fJournalText(Per;Act;Comp;JrnType; Auto Jrn Type;ConsType; Group;JournalNo)
Example: fJournalText('0112';'AC';'1200';'AA'; 'LE';'1001';101) => This journal is...
fLastDay
The last day of specified period.
Used in:
- IBM Controller Link for Microsoft Excel
- Forms
- Report Generator
Input parameters: fLastDay(Optional, Per)
Example: fLastDay('0112') => 31
fLastRefresh
The last time an IBM Controller Link for Microsoft Excel report was refreshed.
Used in:
- IBM Controller Link for Microsoft Excel
- Forms
- Report Generator
Input parameters: fLastRefresh()
Example: fLastRefresh() => 2003-08-29 11:38
fMCurr
Multi company currency code.
Used in:
- The Report Generator
Input parameters: fMCurr()
Example: fMCurr() => SEK
fMonth
The period specified in the system column/row.
Used in:
- Forms
fMonName
Month name.
Used in:
- IBM Controller Link for Microsoft Excel
- Forms
- Report Generator
Input parameters: fMonName(Optional, Per)
Example: fMonName('0112') => December
fMonShort
Month short name. Should be used together with fGetVal().
Used in:
- IBM Controller Link for Microsoft Excel
- Forms
- Report Generator
Input parameters: fMonShort(Optional, Per)
Example: fMonShort('0112') => Dec
fMovExt
Movement Extension Code.
Used in:
- The Report Generator
Input parameters: fMovExt(Optional)
Example: fMovExt() => 010
fMovExtName
Movement extension name.
Used in:
- IBM Controller Link for Microsoft Excel
- Forms
- Report Generator
Input parameters: fMovExtName(Optional, MovementExt)
Example: fMovExtName('010') => Purchase values
fMovExtShort
Movement extension short name.
Used in:
- IBM Controller Link for Microsoft Excel
- Forms
- Report Generator
Input parameters: fMovExtShort(Optional, MovementExt)
Example: fMovExtShort('010') => OB purch value
fMovExtType
Account type for the Movement extension.
Used in:
- IBM Controller Link for Microsoft Excel
- Forms
- Report Generator
Input parameters: fMovExtType(Optional, MovementExt)
Example: fMovExtType('010') => A
fNpw
Number of periods for weekly actualities.
Used in:
- IBM Controller Link for Microsoft Excel
- Forms
- Report Generator
Input parameters: fNpw()
Example: Npw() => 52
fNpy
Number of periods in a fiscal year.
Used in:
- IBM Controller Link for Microsoft Excel
- Forms
- Report Generator
Input parameters: fNpy()
Example: fNpy() => 12
fPer
Current Period.
Used in:
- Forms
- Report Generator
Input parameters: fPer(Optional)
Example: fPer() => 0112
fPerM
Current month period, i.e. 5 (May).
Used in:
- IBM Controller Link for Microsoft Excel
- Forms
- Report Generator
Input parameters: fPerM(Optional, Per)
Example: fPerM('0105') => 5
fPerSub
Calculates a new period based on the specified period and period formula, for example, 0112, +12 returns 0212.
Used in:
- IBM Controller Link for Microsoft Excel
- Report Generator
Note that this function should not be used for Forms.
Input parameters: fPerSub(Per;Period Formula)
Example: fPerSub('0112';'-1') => 0111
fPutComment
Displays the comment associated with one cell. The last parameter of the formula may reference to another cell holding an fPutComment formula.
Used in:
- Forms
fPutValue
Sets where entered values are saved in the database.
Used in:
- Forms
fRep
Report code.
Used in:
- The Report Generator
Input parameters: fRep()
Example: fRep() => BS
fRepName
Report name.
Used in:
- The Report Generator
Input parameters: fRepName()
Example: fRepName() => Balance Sheet
fStatus
The Reporting Status function returns one of four values:
- 0 - Missing - no values have been reported.
- 1 - Processing - values have been reported.
- 2 - Reconciled - values have been reported and reconciled without reconciliation errors.
- 3 - Ready - the company has been reconciled and set to ready.
When the submission parameter is left out or set to zero, the last updated submisssion's status is shown.
Used in:
- IBM Controller Link for Microsoft Excel
- Forms
- Report Generator
Input parameters: fStatus(Per;Act;Comp;CurrCode;Optional Submission)
Example: fStatus('0112';'AC';'1001';'SEK') => 1
fStatusDate
The date when the reporting status code was last changed, expressed as 01-06-30. When the submission parameter is left out or set to zero, the last updated submission's status is shown.
Used in:
- IBM Controller Link for Microsoft Excel
- Forms
- Report Generator
Input parameters: fStatusDate(Per;Act;Comp;CurrCode;Optional Submission)
Example: fStatusDate('0112';'AC';'1001';'SEK') => 01-06-30
fStatusTime
The time when the consolidation status code was last changed, expressed as 10:27:30. When the submission parameter is left out or set to zero, the last updated submisssion's status is shown.
Used in:
- IBM Controller Link for Microsoft Excel
- Forms
- Report Generator
Input parameters: fStatusTime(Per;Act;Comp;CurrCode; Optional Submission)
Example: fStatusTime('0112';'AC';'1001';'SEK') => 10:27:30
fTaxRate
Company tax rate.
Used in:
- IBM Controller Link for Microsoft Excel
- Forms
- Report Generator
Input parameters: fTaxRate(Acc;Country or region)
Example: fTaxRate('2099';'SE') => 28
fText
Returns the text entered in Local or Group, depending on what language selection has been chosen.
Used in:
- IBM Controller Link for Microsoft Excel
- Forms
- Report Generator
Input parameters: fText(Local;Group)
Example: fText('Local';'Group') => Local
fTextDef
The text rows that are defined in the row and column definition.
Used in:
- Forms
fTotal
Shows the total value.
Used in:
- Forms
fTotalHdr
The heading for the fTotal function.
Used in:
- Forms
fUser
User ID of the user who is currently logged on.
Used in:
- IBM Controller Link for Microsoft Excel
- Forms
- Report Generator
Input parameters: fUser()
Example: fUser() => ADM
fUserName
User name of the user who is currently logged on.
Used in:
- IBM Controller Link for Microsoft Excel
- Forms
- Report Generator
Input parameters: fUserName()
Example: fUserName() => Administrator
fYear
Current year.
Used in:
- IBM Controller Link for Microsoft Excel
- Forms
- Report Generator
Input parameters: fYear(Optional, Per)
Example: fYear('0112') => 2001