The OneStream Community is temporarily frozen until June 29th due to the ongoing maintenance. Please read the blog post here to learn more.
Forum Discussion
MitPower01
2 years agoNew Contributor II
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)
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
- aricgreskoContributor III
XFGetMemberInfo only has 3 arguments. If you wanted the description for an account called "Revenue", you would use this syntax.
=XFGetMemberInfo("Description","Account","Revenue") - RobbSalzmannValued Contributor II
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 NameOrDescriptionValid 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)- WillVitaleContributor II
Hey Robb,
Is there way to pull the "Text" section using XFGetMemberInfo? Like any of the Text 1 to Text 8 fields?
Thanks,
Will
- MitPower01New Contributor II
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!
- aricgreskoContributor III
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.
Related Content
- 4 years ago
- 1 year ago
- 2 years ago