Documentation Guide - WritingSample
Documentation Guide - WritingSample
Manager Guide
PV740 SV101
Copyright © 2024 OneStream Software LLC. All rights reserved.
Any warranty with respect to the software or its functionality will be expressly given in the
Subscription License Agreement or Software License and Services Agreement between
OneStream and the warrantee. This document does not itself constitute a representation or
warranty with respect to the software or any related matter.
OneStream Software, OneStream, Extensible Dimensionality and the OneStream logo are
trademarks of OneStream Software LLC in the United States and other countries. Microsoft,
Microsoft Azure, Microsoft Office, Windows, Windows Server, Excel, .NET Framework, Internet
Information Services, Windows Communication Foundation and SQL Server are registered
trademarks or trademarks of Microsoft Corporation in the United States and/or other countries.
DevExpress is a registered trademark of Developer Express, Inc. Cisco is a registered trademark
of Cisco Systems, Inc. Intel is a trademark of Intel Corporation. AMD64 is a trademark of
Advanced Micro Devices, Inc. Other names may be trademarks of their respective owners.
Table of Contents
Table of Contents
Solution Overview 1
Setup and Installation 2
Dependencies 2
Select the Application Control Manager Development Location 2
Create the OneStream Development Application 3
Install Application Control Manager 3
Set Up Application Control Manager 4
Package Contents 4
Application Control Manager Dashboard 7
Settings 8
Global Setup 8
Load/Extract 10
Uninstall 14
Administration 15
Dimensions 16
Properties 20
Layouts 29
Validations 37
Email Setup 40
Request Profiles 45
Report Setup 51
Requests Home Page 54
Request Toolbar 55
Master Request and Items Grid 56
Request Filters 58
Request Activity 58
Requests Details Page 59
Manage Request Toolbar 60
Item Detail 61
Metadata File Import 64
Retain Source System Order 64
Import Add-On Components 65
Global POV Time 72
Import Varying Properties 73
Exports 74
Export Requests 74
Export Dimension 79
Logs 82
Request Activity 85
Reports 87
Solution Overview
OneStream Application Control Manager is a MarketPlace solution designed to support and
manage change requests and ensure the right level of control and governance over application
changes.
l Import metadata from ERP, data warehouses, or MDM tools and synchronize changes to
OneStream.
l Provide an easy way for users to request changes to OneStream applications. For
example, new or updated accounts, cost centers, other dimensions and user privileges.
Dependencies
Component Description
OneStream 7.4.0 Minimum OneStream Platform version required to install this version of
or later Application Control Manager.
2016 Standard
SP1 or later
NOTE: OneStream strongly recommends that you implement the solution in the
Development environment with a fresh copy of the Production application before
starting work.
2. Create a backup copy of your Production database or copy your Production OneStream
application to your Development environment and rename it. This Development version will
be used for your Application Control Manager project.
3. It is suggested to temporarily increase the Database Command Timeout settings for the
installation. This can be done in the OneStream Application Server Configuration Tool. In
Database Connections under the Connection Strings section, set the Command Timeout
and Command Timeout Large settings to 3600. These values can be reverted after the
installation is complete.
2. On the Application Control Manager Solution page, select the OneStream platform version
from the Minimum Platform Version drop-down list.
3. Select the most recent version from the Solution Version drop-down list and then click
Download.
4. Log in to OneStream.
6. On the Load tab, locate the solution package using the Select File icon and click Open.
9. Click Application Control Manager Installer and expand the Application Control
Manager Installer.
12. Close the dialog box when the installation process is complete.
13. Refresh the application and navigate to OnePlace > Dashboards > Application Control
Manager. You will see the solution.
NOTE: If you are upgrading from a previous version, you must close any existing
and open requests from the previous version to complete the new installation. If an
open request is detected, the installation process will stop and a log message will
display in the Task Activity Log.
Package Contents
The Application Control Manager is the user interface for settings and application governance.
The following Business Rules are included:
l ACM_MetadataSource
l ACM_DataSet
l ACM_Reports
l ACM_Config
l ACM_Engine
l ACM_FlowHelpers
l ACM_Globals
l ACM_Helpers
l ACM_ItemHelper
l ACM_Logging
l ACM_Objects
l ACM_RequestHelper
l ACM_SolutionHelper
l ACM_SQLHelpers
l ACM_Validations
l ACM_Param
l ACM_CreateFlowViews
l ACM_CreateRequest
l ACM_MetadataCommit
l ACM_PrepareMetadata
The following items are included with the installation to import metadata from source.
l Dimensions:
o Entity dimension: ACM_MetadataImportMember
o Scenario dimension: ACM_MetadataImportScenario
o Account dimension: ACM_MetadataImportParent
l Cubes
o ACM_MetadataImport
l Workflow Profiles
o ACM_MetadataImport
l Parser
o ACM_ImportMetadata
l Transformation Rules:
o ACM_ImportMetadata_View
o ACM_ImportMetadata_Account
o ACM_ImportMetadata_Entity
Data Management Sequences and Steps are created for use with their related Business Rules.
The benefit of running these processes through a Data Management Sequence is that they can
run in the background while the user continues their work.
l Settings
l Administration
l Requests
l Exports
l Logs
l Reports
Click on the gear icon on the top right of the application to access the pages.
Global Setup
Most global settings are configured once during the initial installation and do not need to be
updated on an ongoing basis. There are three sections under the Global Setup:
l Global Options: Set up preferred time zone adjusted from Coordinated Universal Time
(UTC)
Global Options
Global configuration options apply to the entire solution.
NOTE: In order to save changes, ensure you select the Save button at the bottom
of the page.
Global Security
l Security Role [Manage Setup]: Select the OneStream security group that will be the
Application Control Manager Administrator.
The dropdown selection displays all groups that are set up in the Applications Security Groups.
The application left navigation bar will show only the Requests and Reports page for a non-
Administrator, while an Administrator will have access to all pages.
Load/Extract
The Load and Extract pages are designed to allow extraction of the application tables in a SQL
text format. The extracted file can be loaded back into the application or loaded to another
application.
For example, you can migrate the configuration settings from a Development application to a Test
QA application or Production application.
Extract
Use to extract the components of Application Control Manager tables in SQL text format. You can
extract a single table or use the Extract All icon to extract every table.
l Extract: Select the specific configuration table that you want to extract to a .txt file similar to
the one shown below for future import or backup.
l Extract All Config Data: Extracts all tables of Application Control Manager configuration
into a .txt file for future import or backup. Successful extraction will result in the following
pop up alongside the .txt file.
Load
Use to delete and load the Application Control Manager configuration and components.
l Load Data: Imports configuration data from chosen file. Must be in a SQL loadable format
including INSERT statements.
Uninstall
1. Uninstall UI will remove the dashboards and business rules that are created for the
application. The configurations data and requests history will remain. This is useful when
upgrading to a newer version of the solution.
2. Uninstall Full will completely uninstall the solution including all components and data. This
uninstalls the custom database tables and removes all dashboards.
IMPORTANT: Running this process will also delete any open requests. This process
cannot be canceled or stopped once started. Unless you have backed up both the
dashboards and data, you cannot recover from an Uninstall Full.
Typically, the sequence below is what you will follow to create and complete a Request Profile,
which is the main control for a change request. Each section below will be explained in more detail
in this guide.
1. Dimensions (required): This is the first step in designing a request. This page defines
which dimension types, cubes, and hierarchies are to be managed in a request. This is a
required step for the request to commit correctly.
2. Properties (optional): The Properties page defines all the possible properties that can be
added to a request and how these properties will be rendered on screen in the Request
Profile. The properties table is pre-populated with OneStream properties and delivered
custom properties for the users. Normally you will not need to modify the default properties.
However, this page allows you to create additional custom properties to enrich requests.
3. Layouts (required): The layout is where you define the properties that can be input within a
request step. A layout is required in the Request Profile to turn on allowable actions.
6. Request Profiles (required): You can define the steps a request should go through, as
well as assign security groups and email addresses for each step. You will also define what
actions can be taken in a request by assigning a layout to the action. Layouts can vary at
each step of the process so that a requester can have a layout different from other users
that need to enrich or approve the request during the process.
7. Report Setup (optional): Setup security access for the default reports or create a custom
report here.
Refer to Sample User-Initiate Request Flow to learn how to configure a request process from end-
to-end with screenshots.
Dimensions
This is the starting point when setting up Application Control Manager. First, users need to define
which dimension, cube, and hierarchy can be updated througha change request. A valid
dimension configuration is required to complete the Request Profile and for a request to run
correctly.
l The same CorpAccounts dimension name with the same root hierarchy can be assigned to
different cubes.
l The same CorpAccounts dimension name can also be filtered down to a subset of the
hierarchy such as Balance Sheet or Operating Expenses.
l If there is an inherited dimension, you can also setup a dimension for it by selecting the
inherited dimension name.
Dimensions that are configured here will be used as selections when setting up the Request
Profile.
Dimensions Toolbar
l New: Create a new dimension selection. This will bring up the Dimensions editing page
allowing you to filter the dimensions as discussed in the section above.
l Copy: Select an existing dimension to copy. This will bring you to the editing page where
you will be required to provide a unique description.
l Cancel: Cancels all changes made directly in the grid since the last save
l Dimension Type (required): Type of dimension that can be updated within the request.
Drop-down list of the twelve supported dimension types (Entity, Asset, Scenario, Flow and
UD1-UD8).
l Cube (required): All available cubes within your application are listed in the drop-down.
l Member Filter: Further limit the dimension hierarchies, members, and more, that are
available for updates by specifying a member filter here. Example format of member filters
is:
A#Root.Tree
UD1#CostCenters.Base
The first part of the filter indicates the dimension type with the # sign, followed by the level of
the hierarchy, and then the expansion. These are the available dimensions and
expansions:
o Dimensions:
o A# - Account
o E# - Entity
o S# - Scenario
o F# - Flow
o Member Expansions:
o Member
o Base
o Children
o Children(I)
o Descendants
o Tree
o Tree Descendants
l Grouped Dimensions (optional): This feature allows you to create a member in multiple
dimensions with only one input during a user-initiated request process. Grouped
Dimensions can only be edited from the Dimension editor dialog box, not in the summary
grid.
For example, when you group Entity and UD1 together, a user only needs to input once in
the request and the application will automatically generate the second line item for the other
grouped dimension.
Properties
The Properties page contains a table that is pre-installed with all the OneStream dimension
properties and commonly used custom properties that you can leverage when creating a request.
In this page, users can view, edit, or add properties that may be leveraged when creating a layout.
Properties must appear on this page to be added to a layout and used in the request process.
For information on the function of each OneStream property, see OneStream Software Design
and Reference > Application Properties.
Properties Toolbar
Copy: Select an existing property to copy. This will bring you to the editing page where you will
provide a unique description.
Cancel: Cancel all changes made directly in the grid since the last save.
The required property name and description for default properties aredefined by OneStream. It is
not recommended to delete or edit the default OneStream properties. Users will need to create a
name and description for any custom created properties. All properties must have a unique name
and description in order to save.
The unique name is used for data storing purposes in the table. You can use the custom label
function within the Layout page to control how an end user will see the property names in the
layout.
Category
Each property is attached to a category to allow easy filtering. You will see the filtering in the
Layouts page under the Available Properties pane. The categories include:
l The standard twelve OneStream dimension types: Account, Entity, Scenario, Flow, and
UD1-UD8
A property can be linked to multiple dimension types. For example, the Description property is
attached to all twelve standard dimension types.
In addition, you can create a custom property and link it to a dimension category so that it is easy
to find in the available properties list within the layout screen.
Component type defines how the property will appear in the request. It is not recommended to edit
the component types for the default OneStream properties and Security properties. These
components are displayed in the grid for informational purposes only.
There are many component types available to the user when creating custom properties. The
component selection is primarily used for Custom property creation and is normally set to Text
Box, Check Box, Combo Box, or List Box.
The table below defines the component types within the drop-down menu:
Combo Box and List Box Provides a drop-down that can be populated using the
following parameter type:
Security Group Selector Provides a drop-down list of all existing Security Groups in the
application.
Security Group This component has a built-in feature to copy the security
Membership group assignment from an existing user. The Users drop-down
Position Within Parent Custom component type to support the relationship property
Selector Position. This property does not store any values and it
reverts to Retain Current Position after every commit. This
behavior is consistent with the Dimension Library.
Varying Member Property Custom component type to support all OneStream varying
Selector properties. Following are the different varying types that a
property could utilize:
Default value provides a prepopulated value when creating a request. This field is optional, and if
not filled out, will appear as an empty field awaiting to be populated.
Advanced Options
Some component types can be customized by passing parameters. When writing parameters
ensure there are no spaces in between the parameter name, the equal sign, and the parameter
value (within squared brackets). Below are some examples of the parameters in the Advanced
Options:
For a Combo Box, Check Box, or Text Box component type, a tooltip can be added to show
customized message. When hovering over the property, the user will be able to read the
message. An example of a tooltip parameter is:
l Use a Member Selector or Parent Selector component type to display existing hierarchical
structures from the Dimension Library by entering this parameter:
IsParentName=True, DimeTypeName=|!Item_mdb_DimTypeName_ACM!|,
PropName=ParentName
3. Click Save. The list will be created as a Parameter under Workspaces > Application
Control Manager (ACM) > Parameters, with a prefix of "CustList_" and can be edited from
the workspace page.
Custom Properties
Custom properties are used to enrich requests. This allows organizations to create requests with
specific sets of information outside the typical security or metadata properties. Examples may
include tracking the department generating the request, the risk of the request, or the urgency of
the request.
NOTE: These custom properties are only stored within the Application Control
Manager table. They are not passed to the OneStream platform, and therefore their
values are not stored in the OneStream Dimension Library.
Application Control Manager delivers several commonly used custom properties, but you can set
up as many custom properties as needed. A list of the custom properties delivered in Application
Control Manager are in the table below:
Layouts
A layout is used to design the input form a user will leverage to enter details or to enrich a request
during a change request process. A layout is required to create a Request Profile and layouts
can vary by the different actions allowed in a request.
You can control a set of properties that are allowed to be updated, set required fields, or apply
validations to the properties in a layout. A different layout can be created and assigned to different
steps and actions in a Request Profile to control who can update what properties.
For example:
l For a requester creating a new account (Add action), the layout may contain most of the
basic properties, but for copying an account (Copy action), you may create a different
layout that only needs the Name and Parent name.
In the examples above, four separate layouts would be created to support the process.
Layouts Toolbar
New: Create a new layout. This will bring up the Layouts editing page.
Edit: Select a layout and click Edit to modify. This will bring up the Layouts editing page.
Copy: Select an existing layout to copy. This will bring you to the editing page where you will
provide a unique description.
Delete: Select an existing layout to delete. A layout cannot be deleted if there is an associated
request. It is not recommended to delete the OneStream preinstalled layouts. There is no risk in
leaving the layouts in the list for potential future use.
Cancel: Cancel all changes made directly in the grid since the last save.
l Main Layouts: This is the layout a user will use as the main input form. When you create a
new layout, it will automatically be labeled as a main layout.
SeeOneStream Design and Reference > Cube > Dimensions for varying properties descriptions.
CAUTION: It is not recommended that you update or delete the default layouts. If you
edit the default layouts, you will also need to update the Metadata File Import Data
Sources connectors. See Define Metadata Import Properties for information on
customizing the import process.
The following are the default layouts that are pre-installed in the application:
Layout Description: This is what will show in the Request Profile when assigning a layout to an
action. Description length cannot exceed 250 characters.
Available Properties: All the properties from the Properties page will be displayed in the
Available Properties pane organized by dimension types.
l Filter: Properties are categorized by dimension type. Use the Filter function to instantly
search for a property.
l Update Button: After selecting the properties by selecting the checkbox, click on the
Update button to move the selected properties to the Assigned Properties grid..
l Create New Custom Property: This will bring up the property editing page that allows you
to create a new custom property. The new property will be available for selection
immediately and will automatically be added in the Properties page.
Assigned Properties Grid: The main control of what and how a user can interact with each
property assigned in the layout.
Property Name: Use the Available Properties pane to assign properties here. In the Metadata
File Import Process, this property name must match the Business Rule connector field for the
import to run correctly.
Display Order: The order of properties displayed in the layout. In the Metadata File Import
process, this display order must match the Business Rule connector field in order for the import to
run correctly. Duplication in display order will cause an error when processing the file import.
The following options are only applicable to user-initiated requests. They do not apply to the
Metadata File Import process.
l Editable: Indicates whether the property can be edited during the request process.
l Required: Indicates if the property is required. When set to True, users will not be able to
save the line item if the property is left blank.
l Calculate: Indicates if the property is calculated based on another property. Typically, this
is used in conjunction with a Reference property. For example, referencing another
Account when creating a new account, you may want to make Account Type as a calculate
field to copy the same account type as the member being referenced.
l Options: Advanced options are used to allow passing of parameters to set a property as a
reference property or set the property tooltip.
Change Order: Click this button to access the change order editing page.
l Click Save.
l Select one or more validations and click the Add button to move them to Assigned
Validations.
l Click the Removebutton to unassign validations.
l Click Create Custom Validation to create a new validation from this pane.
Toggle Editable: This will either select all or clear all checkboxes in the Editable column in the
Assigned Properties grid. After you click this button, all previous selections you have made in the
grid will be overwritten and cannot be undone.
Toggle Required: This will either select all or clear all checkboxes in the Required column in the
Assigned Properties grid. After you click this button, any previous selections you have made in the
grid will be overwritten and cannot be undone.
Toggle Calculate: This will either select all or cleart all checkboxes in the Calculate column in
the Assigned Properties grid. Clicking this will overwrite any previous selections, which cannot be
undone.
Application Control Manager can assist in this situation. When a Request Profile is created, the
application automatically creates a corresponding Layout for it. The layout is saved as Request
Profile Layouts type and is named with a prefix of FV_ followed by the Request Profile’s name.
For example, if the Request Profile name is Entity_Initiate1, then the layout will be named FV_
Entity_Initiate1.
To access these layouts, navigate to Layouts page then select Request Profiles Layouts from
the Layout Type filter.
Propertiesassigned to the Request Profile Layouts level will appear after you select the Request
Profile and click Create from the home page.
Validations
Validations are a set of rules that can be applied to a property to ensure data integrity. For
example, descriptions can be set to not exceed a certain number of characters, or a particular
date format can be set. Validations are optional and are not required to complete a Request
Profile.
NOTE: Validations do not work with the Metadata File Import process. They are
only applicable to user-initiated requests.
Validations will run when you save the line-items, or when you click the Validate button.
Application Control Manager is preinstalled with the following default validations. You can also
create custom validations.
Validations Toolbar
l New: Create a new validation. This will bring up the Validation editing page.
l Edit: Select a validation and click Edit to modify. This will bring up the Validation editing
page.
l Copy: Select an existing layout to copy. This will bring up the editing page to allow for a
unique description to be provided.
l Delete: Choose an existing validation to delete.
l Cancel: Cancel all changes made in the grid since the last save.
Use the Validations and Properties buttonsto select an existing layout and assign the validation to
one or multiple properties assigned to the selected layout.
NOTE: You must first select a layout by clicking the Validations button before
clicking the Properties button.
Validations: This allows you to select an existing layout and assign a validation. First select the
desired validation, then click on this button to display the assignment window.
IMPORTANT: When creating a custom validation rule, ensure the parameters are
added to the ACM_Validations business rule, which is unencrypted. Using another
business rule is not supported at this stage.
Email Setup
Email can be used to notify users of the status of a request or notify the application admin when
there is failure in a process. An email template is required to complete a Request Profile. Elect not
to useemail notification by leaving the email addresses blank.
l Email Template: After a request is submitted, this is the email template sent to the
specified email addresses.
The server name is prepopulated with OnestreamEmail server. Choose this or enter your own
server name and click Save to register it in the application.
l Server Configuration name: Specify the email server account to send notifications from
Application Control Manager
Email Templates
You can set up a different email template to use at different stages in a request. For example, a
template can contain next step information to notify users of a pending request. An email template
could notify users when a request has been committed.
Two defaults email templates are preinstalled with the application: Error and Default templates.
You can edit these default templates or create new templates using the available placeholders
from the application.
l New: Create a new template. This will bring up the email template editing page.
l Copy: Select an existing template to copy. This will bring you to the editing page, where you
will provide a unique description.
l Subject: Description that will show up in the subject line of the email.
l Message: The message that will show up in the email body. This can be customized by
using the placeholder options below.
Using the email placeholder and the escape sequences below, you can customize an email
template for use in different steps in the request.
For example, type in the content you would like to see in the body of the email, like Request
Name:. Then specify the placeholder and enclose it with # signs, like #FlowLabel#. Enter \n to
insert a line break.
l \": doublequote
l \t: tab
The Default email template is prefilled with the below placeholders as an example of how to
format the message:
The resulting email with these placeholders would look like this:
l What email notification should be sent out for each step. This is setup in the Email Setup
page.
l What actions (Add, Copy, Update, etc.) are allowed to be performed on the dimension
l New: Create a new profile. This will bring up the Request Profile editing page, allowing you
to enter details.
l Edit: Select a profile and click Edit to modify. If a Request Profile has an associated open
request, you will receive a prompt asking if you would like to close out the request before
proceeding.
l Delete: Select an existing profile to delete. Ensure there are no associated, open, or
completed requests to prevent the audit trail from being deleted.
l Create: Create dynamic dashboard components for the selected Request Profile. Every
time there is a change in a profile, you must click Create to regenerate the dynamic
dashboard.
l Create All: Create dynamic dashboard components for all Request Profiles.
l Delete All: Delete all dynamic dashboard components for all Request Profiles. This only
deletes the underlying dynamic dashboards, not the Request Profile.
l Cancel: Cancel all changes made directly in the grid since the last save.
l Email Template is set to the preinstalled templates, the Error and Default templates.
l Actions (Add, Copy, Update, Move, Remove) are turned on with the preinstalled layouts.
See Define Metadata Import Properties for more information on customizing the import process.
The following are the default layouts that are pre-installed in the application:
l Display Order: Oorder in which the request will display for user selection
l Error Email Address: Email address receiving the profile error email, usually the
application administrator group. Input the full email address such as
[email protected].
Request Type
l Dimension (required): Indicates which dimensions the request can update. You will select
the Dimension Description as defined in the Dimensions creation step above. You can also
select multiple dimensions and use the Grouped Dimensions functionality. See Setup and
Use Grouped Dimensions. This will appear after selecting Metadata under Request Type
and saving.
l Modify Approvers: Determines if the Approvers icon will be visible to users on the Request
page. Enabling this features will bypass the security action group specified in the steps.
See Use Modify Approvers for more information.
l Order: Indicates the stages the request will go through. Minimally you need the Initiate and
Commit steps in order for a request to be created and committed correctly. Step orders
must be sequential and cannot be duplicated.
l Step: The application is setup to support five step types. You can have multiple Process
steps, but should only have one Initiate and Commit step.
o Initiate: First step in creating a request. This step cannot be deleted.
o Process: Additional processing steps to support the request. For example, for
approval, enrichment, or review.
o Commit: Makes the updates to the OneStream Dimension Library.
o Migrate: Migrate requests to the target environment based on the setup in Global
Options. A target environment is required to save this step correctly.
o Export: Export Requests to the target folder based on the setup in Exports > Export
Request. An Export Group selection is required to save this step correctly.
l Email Template: Select the email template for email notification. Email templates are setup
on the Email Setup page.
l Email Address: Email group to be notified when the request has reached their assigned
step. Input the full email address such as [email protected].
Use the toolbar and step editing page to manage the steps in the request profile.
l Add Step: This will bring up the step editing page. The next number is automatically
populated.
l Remove Step: Select the step you would like to delete, then click on the Remove Step
icon. You cannot delete a Initiate step.
Determine what actions a user can submit in a request by assigning a layout to it in order to
activate it. For example, to allow Adding of a new account, assign an Account layout to the Add
column. Or to prevent user from removing an Entity, leave the Remove column blank to turn the
action off.
Only the Initiate and Process steps need to have layout assignments for actions.
l Actions: There are six available actions in the application. Action types will only be
processed if a Layout is assigned.
o Add: Create a new member
o Copy: Copy a member and it's relationships
o Update: Change the property value of a member
o Move: Move a member to a new parent. This will remove the member from their
current relationship.
o Remove: Remove the current relationship of a member without moving them to a
new one. If the Member is no longer a part of the Dimension structure, it will be
placed under Orphans.
o Delete: Delete a member. Members that have underlying stored data (such as Actual
amount or Budget data) cannot be deleted.
As you select the Request Profile type, you will see the available actions in the Layout Assignment
grid.
For Metadata the available actions are: Add, Copy, Update, Move, Remove, and Delete.
For User Security the available actions are: Add, Update, and Remove.
Click on the New Layout icon to bring up the Layout editing page and create a new layout without
leaving the page.
IMPORTANT: After creating the Request Profile, or anytime after modifying profile
options, you must return to the Request Profile Summary page to run the create
dashboard process.
Report Setup
Defaults reports are preinstalled with the application. You can also create custom reports. All
custom reports should first be created in the application dashboard group below:
Application > Presentation > Dashboards > Application Control Manager (ACM)
Report Sets
Report sets contain a group of individual reports. The preinstalled reports are grouped in the
Default report set.
l
: Add a new report set.
l
: Undo unsaved changes.
l
: Save changes to the report sets.
l
: Add a report to the set.
l
: Undo unsaved changes.
l
: Save changes to the report.
l Display Name: The name of the report displayed to the end user.
l Enabled: Determines if the report in the set can be seen by the end user.
l Security Group: Assigns the OneStream security group that can view this report.
l Dashboard Name: Name of the report dashboard in Application Control Manager. Custom
reports must first be created in the Application > Presentation > Dashboards >
Application Control Manager (ACM).
A typical flow for a user-initiate request often follows the steps below:
1. Click on the Create button from the home page.
2. A window with the Request Profile drop-down will appear. Users will only see the profile that
they have access to. Select a profile and, if applicable, the Request Profile level properties
will appear for the user to enter.
3. Next, the user will be brought to the Request Detail page.
6. In the Item Detail section, the properties or layout that are assigned to the action will show
up.
7. Users will enter the necessary information and click on Save. If applicable, the validations
that are triggered will show an error message at this time.
8. After clicking on Save, the line item grid will be refreshed.
l Create: Create a new request. A window will open for users to select a Request Profile that
is enabled and they have access to. Any properties that are assigned to the Request Profile
Layout will also appear in this window. After clicking Save, it will bring you to the request
detail page.
l Edit: Update an existing request. Once a request has been submitted to the next, the
requester will not be able to edit the request.
l Manage: Brings users to the request detail page. A user cannot manage a request that was
initiated by them.
l Claim: Clicking on this icon will update the Claimed By column with the name of the user
who claimed it. A user cannot claim a request that was initiated by them.
l Unclaim: Clicking on this icon will update the Claimed By column with Unclaimed. See the
request Filters section below for more information.
l Reject: Reject and close out the request. A comment window will display. A comment is
optional to close the request.
o Waiting: Submitted by prior step and is now pending next step action.
o FailedCommit: Ran through the commit step but there are line items that failed.
l Claimed By: Name of the user who claimed the request. The default value for this is
Unclaimed.
l Last Modified Date: Time stamp indicating the last modification date and time
l Ready for Commit: Indicates if the request is ready to be committed. When a request
reaches the Commit step, this column will automatically be set to True. Administrators can
un-select the check box in the grid to set it to False.
Items Grid
l Item Group (only shown if the request contains Grouped Dimensions item): Displays the
member name in the request.
l SubItem(only shown if the request contains Grouped Dimensions item): Either True or
False. This indicates if the item is a sub-item of a Grouped Item. Only valid on Grouped
Request Types.
Request Filters
Use the request filters to quickly refresh the Master Request grid and display the relevant
requests. There is an option for you to input how many days of requests to show in the grid.
l My Actions: Shows requests with pending actions for the current user.
l My Queue: Shows requests for the current user when their group has the next pending
action (for example, Enrich group).
l Active Requests: Shows requests that are currently active (not in a closed, completed, or
committed status).
l All Recent: Shows all requests in any state from recent days as configured in the next
option.
: Shows all requests in any state from recent days as configured in the next option.
Request Activity
The Request Activity grid is a read-only grid that can be found on the Request Home Page as well
as in the Request Details Page.
l Add Comment: Add a comment to the request (not to individual line-items within the
request) for further clarification
l Reject a request
l Home: Redirects to the Application Control Manager Master Request Home page.
l Add: Click here to start adding items to the request. A window will appear and all the
allowable actions as defined in the Request Profile will be listed in the drop-down list.
l Unclaim: Puts the request back into the queue as Unclaimed for other approved users to
claim and redirects back to the Application Control Manager Master Request Home page.
l Reject: Rejects and closes the current request. A window will open for you to input any
comments prior to closing the request. You can no longer edit the request after this action.
l Pushback: Pushes the request back to the previous step in the request flow.
l Validate: Checks the validation status of all items in the current request.
l Submit: Moves the request to the next step in the request flow.
Attach Documents
Users can attach supporting documents as part of the change request process. Most commonly
used file types are supported (xls, doc, pdf, png, zip) except for xml type.
l View: Select the document then click on View to open the file.
Item Detail
Line items and details in the request represent the members and actions that the user will be able
to update. What kind of actions are allowed to be performed in a request is determined by the
Request Profile.
Where applicable, a user can add multiple line items, or action types, within the same request. For
example, you may have five new accounts and a couple Move members within the same request.
Items Grid
This is a read-only grid. After a user clicks on the Save button, the grid will be refreshed and show
the line item details. The Items grid can display unlimited rows and also allows you to export the
data by right-clicking within the grid.
After updating properties in a layout, it is important to re-create the dynamic dashboard in order for
the updated properties to appear in the Item Detail section.
l Approvers (Only shown when Modify Approvers is turned on in the Request Profile): Add
approvers to the request
l Note: Must first select a line item, and then a note can be entered
You can use the interface on the Metadata File Import page to upload metadata using an Excel
template (see Setup Metadata Import Excel Template), or create a custom Data Connector (see
Setup Custom Metadata File Import).
Import: Select an Excel template to import. Data in the staging table will be replaced (not
appended) with the new import dataset.
Process: Run the comparison process for the selected data management step.
Clear Table: Use this to clear imported data from the selected data management step.
Retain Source System Order: When checked, metadata will be sorted in the same order
provided in the source data file.
l Import Tree table: Use for storing the relationship details, parent, and child. Each
dimension table contains a different set of properties, including relationship properties and
varying properties, relevant to the dimension.
The following columns exist in all tree tables:
o Sort Order: Retain Source System Order checkbox must be set to True for
functionality. . You can use this to define how the member is sorted in the hierarchy. If
order is not important, enter a value of 1 for all rows in the hierarchy table and ensure
the Retain Source System Order checkbox is unchecked.
l Import Member table: Use for storing the member properties detail. Each dimension table
contains a different set of properties, including varying properties, relevant to the
dimension.
1. Choose a character that is not used in your data set. For example, @, ^, or a pipe |.
2. Navigate to Data Sources > Connectors and select the connector you want to update.
Note which Scenario Type the connector is set to. In our example, ACM_AccountSource is
set to (All) scenarios.
4. Navigate to Business Rules > Connector and select the rule for your source import. In this
example, we are using the default ACM_AccountSource connector rule.
5. Update all properties in the rule with the parser character you have chosen.
You can use the application interface to upload metadata using an Excel template. If you are not
using an Excel template, modify these default data connectors to pull data from a specific file
location (see Setup Custom Metadata File Import).
Workflow Profiles
A Workflow Profile called ACM_MetadataImport_Default is created during installation. Each
supported dimension under the Workflow Profile is configured to connect to the default data
source connector created during installation.
If updates are found, a request in the application will be generated. The results of this process are
displayed on the main home page of the application.
After a request has been generated, the Commit All Metadata Updates data management step
runs to commit the updates to the system.
If set to False, the data management source system import process ignores any Global POV
settings and instead uses the system date and time to determine the period for loading data.
l Any type of varying properties. See the Properties section in this guide for more
information.
See Importing Shared Member and Varying Properties section for instructions.
Export Requests
On the Export Requests allows users to export request details into a file and folder of their choice.
Here is an example of an exported .csv file:
You can configure which properties and information is included in the export file. There is also an
option to run the export by a date range as well as the option to setup an Export step in a Request
Profile to run the export every time a request is committed.
To configure the Export criteria, navigate to Exports on the left navigation bar and select Export
Requests.
l File Extension: File extension examples are txt, pdf, xls, doc, csv.
l FilterActions: This setting is used to specify if only certain actions are allowed to get
exported. If not selected, all actions are included in the file.
l FileActions: Actions that can be added to the file such as add, modify, and remove.
The next section allows you to specify data or properties that are included in the export file.
l Input Value: If the Field Type is not defined, this will be the default value for the property.
l FixedInRow: If PropsInRow is selected, the export will look for properties that are not set as
FixedInRow
l Export Group: This will bring up the date range window. Click on Create to run the export
for all files within the selected group.
l Copy Group: Make a copy of the selected group and all the files within the group.
l Export File: This will bring up the date range window. Click on Create to run the export for
the single selected file.
l Copy File: Make a copy of the selected file and all of the properties criteria within the file. _
COPY will be added at the end of the file name.
When adding the Export step in the Request Profile, select the Export Group from the drop-
down. This is required for the Export step to save.
Dimensions can be exported into CSV format. Exported dimensions populate as a .zip file to the
file location selected by the user within File Share. The dimension(s) exported are individual CSV
files sorted by dimension type in the .zip file.
NOTE: When looking for a dimension, you can search by inputting a partial name of
the dimension above the hierarchy view.
Dimension data is in Parent-Child relationship format and contains all OneStream properties.
For members that are shared across different parents, it will display each relationship in separate
rows. This is the same for members containing varying member properties.
When selecting a folder, ensure it is a folder you have access to otherwise an error message will
populate.
2. Choose the dimension(s) you would like to export in the hierarchical tree view. You can
multi-select the dimensions or select all dimensions.
3. Once your selections have been made, click the Export button on the right side of the page.
4. Notice your file explorer pops up. Select a folder to add the .zip file to.
Click Refresh to refresh the detailed logging screen. Click Delete to clear all Application Control
Manager log files, and click Export to export logs into a CSV format which can be saved as an
archive or a back up before deleting log entries.
l Log Level: Captures the type of Log item that was written (for example, Information,
Warning, Error, or Fatal)
l Category: The organization of the system type that generated that Log Entry
l Business Rule: Business Rule responsible for writing the Log Entry
l User Name: Login name of the user who performed the activity
l Exception Trace: The full path of the error. These breadcrumbs lead to the error.
Logs Toolbar
l Export: Exports all log entries into a .csv file. These columns will display identical to the
information in the grid. In the top left corner of your .csv file you will see the time that you
exported the file. Refer to the example below:
Partial Commit: When only a part of the request is committed successfully. These log messages
vary based on whether the request is a metadata import or a user-initiated request.
l User-Initiated Example: You have multiple line items in a user-initiated request and for
one of the lines, the parent member doesn’t exist. This will fail the commit for that single line
item but will commit all the other line items.
Request Activity
The Request Activity log can be found on the requests details page and shows a running log of
the current activity specific to a selected request. For more information on the request details
page, see Request Details Page.
Upon installation, nine default reports are available to users. For information on creating a custom
report, see Create Custom Reports.
l Metadata Bridge Report: Displays the requester, all metadata changes made, action and
status in Application Control Manager.
l Request Audit: Displays all requests made in a specified time (in days).
l Request Audit by Request Type: Displays the audit report specified by request type.
l Request Audit by Step Type: Displays the audit report by step type.
l Automated Request Audit with Item Detail: Displays all requests that were automated
from a source system into Application Control Manager.
l Request Activity Audit: Displays all activity that has happened in a specified audit time (in
days).
l Excel XML
l CSV
l Text
l HTML
To send the data from the report tab, click the Export or Send selector from the toolbar and then
select the format for export:
3. Click the SAVE button, and you should see the changes saved in the Dimension grid.
Dimension setup is now complete.
4. Go to the Properties page to create the custom property for use in the enrich step. Click the
New icon to open the editing page.
5. We are going to create a custom property named Effective Date with a default date format
of mm/dd/yyyy.After we create the layout, we will assign a validation to this property.
6. Navigate to Layouts and click on the New icon to open the editing page. We are going to
create three different layouts, one for each of the steps.
7. First we will create a layout for the requester to input the changes. Give the layout a unique
name and description. Then, in the Filter field, enter the first property (Name) to search for
it instantly.
8. Select the check box next to the Name property, then click the UPDATE button, and you
should see the property move to the Assigned Properties grid on the right.
TIP: You can select multiple properties in the Available Properties list and then
click the UPDATE button to move all selectedproperties to the grid at one time.
10. To make the Name and Parent Member properties a required field, select the check box in
the Required column. We also want to give the custom label name of Account Name. Click
Save and it should look like this:
11. Now we want to move the Description to the last position. Click on the Change Order icon
to open the editing page.
12. Click Description and then SelectParentMember and you will see their positions swap.
Click the SAVE button to close the window.
13. Click the Save icon to save the layout. Navigate to the Layouts page and you should see
CorpAccount_Initiate in the grid.
14. Now we will create a layout for the Enrich step. Follow previous instructions to open a new
Layout editor page.
This time we will use the Copy Properties feature to quickly copy the same properties from
the CorpAccount_Initiate layout.
15. From the Copy Properties window, select the CorpAccount_Inititate layout. Click the
COPY button and you should see the properties copied over in the Assigned Properties
grid.
16. Add the Effective Date custom property to this enrich layout. To protect data integrity, we
also want to prevent the enricher from changing values that the requester has input. Make
the properties un-editable by clearing the Editable check box.
The result should look like this:
TIP: Use the Toggle Editable and Toggle Required to quickly clear all check
boxes.
17. Now we will assign the Check Date Format validation (which is a pre-installed validation)
to the Effective Date. In the grid, select the Effective Date property, then click the Assign
Validation icon to open the assign window.
18. Select the check box next to CheckDateFormat and click the ADD button to move it to the
Assigned Validations pane. Close the window and you should see the Validations column
in the grid updated.
19. Next, repeat previous steps and create a read-only layout for the Approve step. The result
should look like the following image. Save the three layouts.
20. Next, navigate to the Request Profiles page and click the New icon to open the editing
page
21. Here we will name the profile CorpAccounts, with a description of CorpAccounts
Request. The request type is Metadata and the Dimension is what we have set up,
CorpAccounts. Select the Enabled check box to make it visible for the user to select.
22. On the Request Profile Steps grid, change the description for the Initiate step and the
action group as needed. Then, click the Add Step icon to open the editing page.
23. The next step in the request is Enrich. We will select the step type, Process, and type the
description Enrich CorpAccts. Set the Action Group to the appropriate security group.
Click the SAVE button.
24. Repeat the previous step and add the Approval and Commit steps. The result should look
like this:
25. Next, in the grid, select the Initiate step. On the right-side pane above the Layout
Assignment grid, you should see the title change to Initiate CorpAccts (Initiate).
26. Since we want to allow Add, Update, and Move for this profile, we need to assign a layout to
these actions to activate them. Click the Add column cell to open a drop-down list. Select
the CorpAccounts_Initiate layout that we just created.
27. Assign the same layout to Update and Move actions. Make sure to click Save before you
continue. The result should look like this:
28. Select the Enrich step, and assign the enrich layout to the same Add, Update, and Move
actions.
TIP: Check the title to confirm you are on the correct step.
29. Repeat the process to assign the layout to the Approve step.
30. Save the Request Profile and navigate to the Request Profile page. Select the
CorpAccounts Request line and click the Create icon to generate the dynamic
dashboard. The request profile setup is now complete.
Our objectives in this exercise are to submit a single change request with the following three line
items:
l Create a new parent called Sample Parent under ACM_Demo and create a new child called
Sample Child under this new parent.
l Move the ACM Test Account under the new Sample Parent.
1. On the left navigation panel, select Requests and click the Create icon. A window will
open. Select CorpAccounts Request and click the Save button.
2. On the Request Detail page, click the Add icon and select CorpAccounts (ADD).
TIP: If there are no properties showing, make sure you have click on Create on the
Request Profile page to generate the dynamic dashboard.
4. The item grid should be refreshed and the first line item is displayed.
5. Next, we will add the Sample Child member. Click Add and select CorpAccounts (ADD)
again. Since ACM_Demo is a new parent, we will select the Is the Parent included in the
current request? check box.
Click Save to save the line item.
6. Next, click Add and select CorpAccounts (MOVE). Select the member ACM Test
Account and click the Add button.
7. In the ITEMDETAIL, you should see the Current Value and the New Value columns.
Select the Is the Parent included in the current request? check box and change the
new parent to be Sample Parent.
Click the Save icon to save the line item.
8. Next, click Add and select CorpAccounts (UPDATE). Change the description for ACM_
Demo to be Demo Account Hierarchy.
9. The Items grid should look like this. Click the Submit icon to go to the next Enrich step.
10. You should now be on the Request Home Page and the request status and step label
should be changed to Waiting and Enrich CorpAccts. The Initiate step is now complete.
11. As an Enricher, select the request and select Manage to open the Request Detail page.
Select the new member Sample Child line item and you should see the Effective Date
property in the ITEM DETAIL section. Notice the other properties are not editable.
12. To test the date format validation, type Feb 1, 2023 in the box and click Save. You should
receive an error message.
13. Now enter 02/01/2023 and click Save again. It should save this time. Click Submit to
proceed to the next Approval step.
14. The request status and step label have now changed to Waiting and Approve.
15. As an Approver, select the request and click Manage to open the Request Detail page.
Notice all properties are now read-only. Click Submit to proceed to the next step.
16. The request status and step label have now changed to Waiting and Commit. Notice the
Ready to Commit is selected by default. As an Administrator, click the Commit icon on the
home page to commit the request.
17. Finally, navigate to Application > Dimension Library and you should now see your
changes reflected in the CorpAccounts dimension. The change request process is now
complete.
Tips
After you familiarize yourself with the various administration components needed to complete a
Request Profile, there are some tips to make the setup process even easier with fewer clicks.
l Instead of going to the Layouts page to create a new layout, you can create a layout on the
Request Profile editing page using the New Layout icon.
l Rather than using the Properties page to create a new custom property, you can do so
directly on the Layout editing page. Use the + icon at the bottom of the Available
Properties pane to open the properties editing page.
l On the Layout editing page, you can assign a validation to a property by clicking the
Assigned Validation icon rather than going to the Validations page to do the assignment.
1. Navigate to Application > Dashboard > Workspaces > Application Control Manager
(ACM)
3. Change the Default Value to True to turn on the testing mode or False to turn it off.
This is accomplished by using the REST API built into OneStream. The REST API in the source
environment requires setup on the server side to ensure that the correct configuration is in place.
Request the following details for your Azure Single Sign-on configuration from your technical
support representative:
l Azure AD Tenant ID
NOTE: If the remote server is a Legacy Azure SSO Environment, TenantID, Client
ID, ClientKey, ClientUrl, and ClientApp options are necessary. PAT is not needed.
The TenantID, ClientID, ClientKey, and ClientUrl can all be found in the Server XFConfig file
under the following keys:
TenantID: AzureADTenantId
ClientID: AzureADClientId
ClientKey: AzureADWebApiSecretKey
ClientUrl: XFWebApiUrl (only the URL's protocol and domain are needed)
ClientApp is the remote server's application that is being used for Migration.
As with other features in Application Control Manager, there is a step associated with each of the
dimensions in OneStream. To complete the setup, you must update the Parameters section of
the step. The default parameters are entered in the initial setup step from Application Control
Manager:
l The EnvironmentName is set to the environment name previously created in the Setup
Remote Source Server Environment section.
l The FlowName is set to the Request Profile Description that you plan to use for the
Migration.
Execution
When any of the Data Management Load steps are executed, the following processes occurs:
l After the data is loaded into the database, the same processing that occurs during a
metadata import takes place. If any updates are required, the system automatically
generates a request, which can be committed using the Application Control Manager
Metadata Migration (ACM) > Commit All Metadata Updates Data Management step.
Before continuing, follow the setup steps outlined in the Metadata Synchronization section. You
must set up a destination environment where requests will be sent.
If you have a large data set to migrate (>100k of data), make sure to increase your Command
Timeout or Task Inactivity Timeout (minutes) settings under Database Server Connections >
Connection String Settings > Command Timeout or Application Server Configuration
Settings > Task Inactivity Timeout (minutes).
Add a new step to any request profile you have configured in the system. In the Application
Control Manager administration screen, select Request Profiles and edit or create a profile to use
for the migration. Add a new step to the profile after the Initiate step and select Migrate.
Select the appropriate target environment to commit the request to. This was defined in the prior
configuration step. Select your Target Environment:
When you manage this request and advance to the next step, the system automatically connects
to the target environment REST API and pushes the request information from the source system
to the destination environment and automatically commits the request. After reviewing and testing
in that environment, return to the source system and continue processing as you typically would.
File Tabs
Create a new Excel file with two tabs: Tree and Members.
Headers
On the Tree tab, the first rows should be fixed to:
l Row 4: Property name with a prefix of xfText#:[ ] or xflnt#. The order of column names must
match the order in the associated Layouts.
NOTE: The property field type can be found in the database columns definition. For
example, nvarchar is a Text type.
l Row 4: Property name with a prefix of xfText#:[ ] or xflnt:#. The order of column names
must match the order in the associated Layouts.
Named Range
Application Control Manager looks for the Named Range defined in the Excel file to determine
what to import. Ensure the ranges cover the entire data set in your file. The two required name
ranges are:
Example showing a shared member with varying properties by Time in the Members tab:
Example showing a shared member with varying properties by Scenario type and Time in the
Members tab:
You can give the file any name and save it in any folder location. To upload the Excel template,
select Metadata File Import from the left navigation panel. Click Import, and the Windows File
Explorer browser will display for you to navigate to the file within your selected folder.
You can also automate the import and commit steps to no longer include user interaction before
committing the request. Additionally, you can add a required step for individuals on the Finance
team to review and enrich the request before manually committing it into the system.
Manage the following components if you are setting up a custom Metadata File Import process in
Application Control Manager:
NOTE: It is important that both the properties and the order of properties match
between the layouts and the Business Rules.
1. Navigate to the Administration > Dimensions page and ensure the dimensions you want
to group are assigned to a Cube and Dimension Name.
2. Select the Create icon to create a new Dimension assignment. Select the desired
dimensions under the Grouped Dimensions drop-down.
3. Next, create a Request Profile and select the newly created Grouped Dimension.
5. Return to the Request Profiles summary page and click on Create to generate the dynamic
dashboards for the profile.
6. After a request is submitted, a line item will automatically be generated for the same
member in both the Entity and UD1 dimensions.
When the option to allow users to modify the approvers is enabled in the Request Profile, users
will see the Approvers icon on the request page.
Within the Approval Matrix, additional users can be added as a Reviewer, Mandatory Approver, or
Approver. The User Name drop-down displays all users in the applications. People listed in the
matrix will have access to manage the request regardless of whether or not they belong to the
security group configured in the Request Profile steps.
NOTE: Any custom reports that use custom components are removed when
performing an Uninstall UI. The ACM_Reports business rule is overwritten during
an upgrade. Any customizations to this business rule must be backed up and
merged into the updated business rule.
Follow the sample steps below to add a new custom report to show the values of the custom
properties FlowReason and FlowPriority.
1. Add the report definition to the ACM_Reports by navigating to Business Rules > Dashboard
Data Set > ACM_Reports.
2. Add the report to the list of reports. Be sure to add the comma to the previous line.
3. Copy and paste rows 112-121 and update for the new report name.
1. Click Application Dashboards > Dashboard Maintenance Units > Data Adapters.
6. For Method Query, click the ellipsis and add the following:
{ACM_Reports}{MyCustomReport1}{StartTime=|!Report_StartDateTime_ACM!|,
EndTime=|!Report_zEndDateTime_ACM!|}
Display Settings
OneStream and MarketPlace solutions frequently require the display of multiple data elements for
proper data entry and analysis. Therefore, the recommended screen resolution is a minimum of
1920 x 1080 for optimal rendering of forms and reports.
Additionally, OneStream recommends that you adjust the Windows System Display text setting to
100% and do not apply any Custom Scaling options.
Identifier Description
ACM Solution ID
See also: Managing a OneStream Environment in the Design and Reference Guide.
1. In the production OneStream application, install the solution and create the data tables.
See "Setup and Installation" on page 2 for Database Server Connection settings and
installation details.
2. Data tables are created in the OneStream Development application during the solution
installation. Using the Microsoft Data Migration Assistant, copy the data from the tables to
the Production Microsoft SQL Server Database. Only the Microsoft SQL Administrator
should run the migration assistant.
IMPORTANT: This process has the potential to overwrite existing table data in the
production application database if data already exists.
l Major changes to business rules or custom tables within a MarketPlace solution will not be
supported through normal channels as the resulting solution is significantly different from
the core solution.
l If changes are made to any dashboard object or business rule, consider renaming it or
copying it to a new object first. This is important because if there is an upgrade to the
MarketPlace solution in the future and the customer applies the upgrade, this will overlay
and wipe out the changes. This also applies when updating any of the standard reports and
dashboards.
l If modifications are made to a MarketPlace solution, upgrading to later versions will be more
complex depending on the degree of customization. Simple changes such as changing a
logo or colors on a dashboard do not impact upgrades significantly. Making changes to the
custom database tables and business rules, which should be avoided, will make an
upgrade even more complicated.