Skip to main content
Newcomer
Feb 15, 2024 11:26 PM UTC
Solved

Looking for sample Excel Add-in function XFGetMemberInfo for Account

I tried using this function to pull the account description but keep getting an error.  I'm sure because I am using the wrong fields.  I looked for samples but can't find any. 

XFGetMemberInfo
This function retrieves the description in the system.  Each Parameter needs to be defined.
XFGetMemberInfo(MemberInfoType, DimTypeName, MemberName, NameorDesc, NameandDesc)

aricgresko
Veteran
Feb 16, 2024 12:49 PM UTC

XFGetMemberInfo only has 3 arguments.  If you wanted the description for an account called "Revenue", you would use this syntax.
=XFGetMemberInfo("Description","Account","Revenue")

5 replies

aricgresko
Veteran
Feb 16, 2024 12:49 PM UTC

XFGetMemberInfo only has 3 arguments.  If you wanted the description for an account called "Revenue", you would use this syntax.
=XFGetMemberInfo("Description","Account","Revenue")

Newcomer
Feb 16, 2024 1:04 PM UTC

Thank you so much!  I couldn't find that example anywhere in the admin guides.  And the fact that function template has 5 fields I would never have guessed.  Thanks Again!

aricgresko
Veteran
Feb 16, 2024 1:07 PM UTC

You're welcome.  The easiest way I know of to check what arguments need passed in, is to begin writing the function in excel and clicking on the function arguments (fx) icon.  

aricgresko_1-1708088856259.png

 

RobbSalzmann
Employee - Advisor
Employee - Advisor
Feb 16, 2024 2:18 PM UTC

For those who find this looking for the same thing, here is the correct API:
XFGetMemberInfo(string memberInfoType, string dimTypeName, string memberName)

Valid options for memberInfoType:

Currency
CurrencyId
Description
DimId
DimName
Id
Name
NameAndDescription
NameOrDescription

 

Valid options for dimTypeName :
Note: DimTypeId in parentheses is just for reference, don't include it in XFGetMemberInfo:

Entity (0)
Consolidation (1)
Scenario (2)
Time (3)
View (4)
Account (5)
Flow (6)
Origin (7)
IC (8)
UD1 (9)
UD2 (10)
UD3 (11)
UD4 (12)
UD5 (13)
UD6 (14)
UD7 (15)
UD8 (16)

 

Contributor
Aug 20, 2024 8:23 PM UTC

Hey Robb,

Is there way to pull the "Text" section using XFGetMemberInfo? Like any of the Text 1 to Text 8 fields?

Thanks,

Will