Extender: Auto Update Member Property
This snippet will modify a Member property that can vary by Scenario Type and/or Time. Just pass the relevant ScenarioType ID or Time member ID to set it in a more specific way; it will then appear as a "Stored Item" in the interface. Note: SaveMemberInfo does not create entries in Audit tables, which means the Audit Metadata report will not contain anything related to this operation. For this reason, we do not recommend to use this snippet outside of implementation activities or in production environments. 'Get the MemberInfo object for the member you want to update, in this example an Account. Dim objMemberInfo As MemberInfo = BRApi.Finance.Members.GetMemberInfo( _ si, DimType.Account.Id, "<Member Name>", True) ' Retrieve member properties so we can modify them. Dim accountProperties As AccountVMProperties = objMemberInfo.GetAccountProperties() ' change the Account Type accountProperties.AccountType.SetStoredValue(AccountType.Revenue.Id) ' change default Text1 value ' if you want to set it for a specific ScenarioType and/or time, ' use the relevant values in the first 2 parameters accountProperties.Text1.SetStoredValue( _ ScenarioType.Unknown.Id, DimConstants.Unknown, "<UpdatedValue>") 'Save the member and its properties. Dim isNew As TriStateBool = TriStateBool.TrueValue BRApi.Finance.MemberAdmin.SaveMemberInfo(si, objMemberInfo, False, True, False, isNew)2.3KViews8likes0CommentsExtender: Auto Create Member
This snippet will create a new Account member, including setting some properties that can vary by Scenario Type and/or Time. Note: SaveMemberInfo does not create entries in Audit tables, which means the Audit Metadata report will not contain anything related to this operation. For this reason, we do not recommend to use this snippet outside of implementation activities or in production environments. 'Create a new MemberInfo object with its child objects. Dim objMemberPk As New MemberPk(DimType.Account.Id, DimConstants.Unknown) 'Update Dim Name accordingly Dim objDim As OneStream.Shared.Wcf.Dim = BRApi.Finance.Dim.GetDim(si, "<Dimension Name>") 'Create New Member Dim objMember As New Member(objMemberPk, _ "<New Member Name>", "<Member Description>", objDim.DimPk.DimId) 'Create VaryingMemberProperties object Dim objProperties As New VaryingMemberProperties( _ objMemberPk.DimTypeId, objMemberPk.MemberId, DimConstants.Unknown) 'Create new member info object for new member Dim objMemberInfo As New MemberInfo( _ objMember, objProperties, Nothing, objDim, DimConstants.Unknown) 'Modify some member properties. Account dimension, in this example. Dim accountProperties As AccountVMProperties = objMemberInfo.GetAccountProperties() accountProperties.AccountType.SetStoredValue(AccountType.Revenue.Id) accountProperties.Text1.SetStoredValue( _ ScenarioType.Unknown.Id, DimConstants.Unknown, "MyNewText1Value") 'Save the member and its properties. Dim isNew As TriStateBool = TriStateBool.TrueValue BRApi.Finance.MemberAdmin.SaveMemberInfo(si, objMemberInfo, True, True, False, isNew)2.4KViews3likes0CommentsDashboard: Get or Set Literal Parameter
Literal Parameters are, effectively, application-wide variables that can be used to drive Dashboards and Cube Views. Their values can be set or retrieved in code as shown below. From version 7.3 onwards, they are contained in a Workspace. That means that the relevant calls now require the ID of the Workspace where the Parameter is located. Note that the ID of Default Workspace is an empty Guid. Note: Literal Parameters are effectively shared between all users; which means that, if a Dashboard Action triggered by "User1" modifies a Literal Parameter value, "User2" will also receive the changed value in any Dashboards they are using (at the first refresh). OneStream Version 7.3+ Dim parameterName As String = "MyParameterName" ' if Parameter lives in Dashboards under "System" tab, set this to True Dim isSystemLevel as Boolean = False ' retrieve workspace ID. If it's Default Workspace, you can just use Guid.Empty instead Dim workspaceID As Guid = BRApi.Dashboards.Workspaces.GetWorkspaceIDFromName( _ si, isSystemLevel, workspaceName) ' --- Set literal parameter value Dim newValue As String = "New Literal Value" BRApi.Dashboards.Parameters.SetLiteralParameterValue( _ si, isSystemLevel, workspaceID, parameterName, newValue) ' --- Retrieve literal parameter value Dim pValue as String = BRApi.Dashboards.Parameters.GetLiteralParameterValue( _ si, isSystemLevel, workspaceID, parameterName) OneStream Version 7.2 and below Dim parameterName As String = "MyParameterName" ' if Parameter lives in Dashboards under "System" tab, set this to True Dim isSystemLevel as Boolean = False ' --- Set literal parameter value Dim newValue As String = "New Literal Value" BRApi.Dashboards.Parameters.SetLiteralParameterValue( _ si, isSystemLevel, parameterName, newValue) ' --- Retrieve literal parameter value Dim pValue as String = BRApi.Dashboards.Parameters.GetLiteralParameterValue( _ si, isSystemLevel, parameterName)2.9KViews2likes0CommentsFinance Business Rules: Helper Sub
Example of a helper Sub. Sub allows developers to isolate a chunk of code that will be executed repeatedly in some code, without having to return results. They can be placed in Member Formula in the Helper Functions section, or in Business Rules. 'Substitute MySub for Helper Sub name Private Sub MySub(ByVal api As FinanceRulesApi) ' ... do something here End Sub Source: Snippet Editor: Finance - Business Rules - General810Views1like0CommentsFinance Business Rule: Helper Function
This is an example of helper function that could be placed either in a Member Formula (in the Helper Functions section) or in a Business Rule (before the End Class line). Functions and subs allow developers to isolate chunks of code that will be repeatedly executed in other code. 'Substitute MyFunction for Helper Function name, and the type of returned ' object at the end of the Function line; this exmple returns a DataBufferCell. 'sourceCell is a parameter passed in, in this case a DataBufferCell; ' replace with name and type of the objects you want to pass. 'resultAccountId is another parameter passed, in this case an Account ID. Replace as necessary. Private Function MyFunction( ByVal api As FinanceRulesApi, _ ByVal sourceCell As DataBufferCell, _ ByVal resultAccountId As Integer) _ As DataBufferCell 'This function will generate a Data Buffer Cell object which can be used on an Eval function Dim ud2Name As String = String.Empty Dim ud2Member As Member = api.Members.GetMember(DimType.UD2.Id, sourceCell.DataBufferCellPk.UD2Id) If Not ud2Member Is Nothing Then ud2Name = ud2Member.Name End If Return sourceCell End Function Source: Snippet Editor: Finance - Business Rules - General945Views1like0Comments
What are Literal Value Parameters and how can they be helpful with Reports?
Literal Value Parameters allow the retention and storage of the formatting settings made for row and column headers, subtotal, grand total rows to ensure consistency and ease of maintenance across your report set. Update and get “perfect” the formatting for one report, save the formatting setting script into a literal value parameter and then you can reuse that parameter to drive formatting of all of your other reports! New executive arrives pushing a different color scheme? No problem! Just update the parameter for the new color once and ALL the reports that reference that parameter are automatically updated!What are some MarketPlace solutions to help assist an Admin?
Please note: This is not a complete list! System Diagnostics (This is a marketplace solution) Administrator Solution Tools Home Page Manager Log Cleaner Business Rule Viewer Member Formula Builder Administrator Solution Tools: TDM Table Data Manager Parcel Service Guided Reporting Train Me Snippet Editor Application Control Manager Data Entry 123
What are Literal Value Parameters and how can they be helpful with Reports?
Literal Value Parameters allow the retention and storage of the formatting settings made for row and column headers, subtotal, grand total rows to ensure consistency and ease of maintenance across your report set. Update and get “perfect” the formatting for one report, save the formatting setting script into a literal value parameter and then you can reuse that parameter to drive formatting of all of your other reports! New executive arrives pushing a different color scheme? No problem! Just update the parameter for the new color once and ALL the reports that reference that parameter are automatically updated!What are some MarketPlace solutions to help assist an Admin?
Please note: This is not a complete list! System Diagnostics (This is a marketplace solution) Administrator Solution Tools Home Page Manager Log Cleaner Business Rule Viewer Member Formula Builder Administrator Solution Tools: TDM Table Data Manager Parcel Service Guided Reporting Train Me Snippet Editor Application Control Manager Data Entry 123
