Setup and Installation

This section contains important details related to the planning, configuring, and installation of your solution. Before you install the solution, familiarize yourself with these details.

Dependencies

Component

Description

OneStream 8.5 or later

Minimum OneStream Platform version required to install this version of Application Control Manager.

Microsoft SQL Server

2016 Standard SP1 or later

 Application Control Manager requires an instance of Microsoft SQL Server 2016 Standard SP1 or later.

Select the Application Control Manager Development Location

Before installation, decide whether to build the solution directly in the Production OneStream application or in a separate Development OneStream application. This section provides some key considerations for each option.

Production OneStream Application: The primary advantage of building the solution in a Production application is that you will not have to migrate the resulting work from a Development application. However, there are intrinsic risks when making design changes to an application used in a Production capacity and it is not advised.

NOTE: OneStream strongly recommends that you implement the solution in the Development environment with a fresh copy of the Production application before starting work.

Development OneStream Application: As a best practice, use the Development OneStream application to build the solution.

Create the OneStream Development Application

  1. Ensure all the OneStream artifacts relating to Application Control Manager, such as Workflow Profiles and Entities, are in the Production application.

  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.

Install Application Control Manager

NOTE: If you are installing a version older than PV820 SV100, 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.

IMPORTANT: Open requests do not need to be closed when installing Application Control Manager version PV820 SV100. When loading a config, close out the request to prevent errors.

  1. In the OneStream Solution Exchange website, go to OneStream Solutions > Application Control Manager tile.

  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.

  5. On the Application tab, click Tools > Load/Extract.

  6. On the Load tab, locate the solution package using the Select File icon and click Open.

  7. When the solution file name displays, click Load.

  8. Click Close to complete the installation.

  9. Navigate to Application Control Manager and you will see a screen with two steps: Setup Tables and Launch Solution.

  10. Click Setup Tables. The application will inform you when this is complete.

  11. Click Launch Solution. Upon launch, the screen will refresh and take you to the solution.

Set Up Application Control Manager

The first time you run Application Control Manager, tables are set up from the installer.

Package Contents

The Application Control Manager is the user interface for settings and application governance. The following Business Rules are included:

  • ACM_MetadataSource

  • ACM_DataSet

  • ACM_Reports

  • ACM_Config

  • ACM_Engine

  • ACM_FlowHelpers

  • ACM_Globals

  • ACM_Helpers

  • ACM_ItemHelper

  • ACM_Logging

  • ACM_Objects

  • ACM_RequestHelper

  • ACM_SolutionHelper

  • ACM_SQLHelpers

  • ACM_Validations

  • ACM_Param

  • ACM_CreateFlowViews

  • ACM_CreateRequest

  • ACM_MetadataCommit

  • ACM_PrepareMetadata

The following items are included with the installation to import metadata from source.

  • Dimensions:

    • Entity dimension: ACM_MetadataImportMember

    • Scenario dimension: ACM_MetadataImportScenario

    • Account dimension: ACM_MetadataImportParent

  • Cubes:

    • ACM_MetadataImport

  • Workflow Profiles:

    • ACM_MetadataImport

  • Data Management Group:

    • ACM MetadataImport

  • Parser:

    • ACM_ImportMetadata

  • Connector Business Rules:

    • ACM_AccountSource Business Rule

    • ACM_EntitySource Business Rule

    • ACM_FlowSource Business Rule

    • ACM_ScenarioSource Business Rule

    • ACM_MetadataSource Business Rule

    • ACM_UD1-8Source Business Rule

  • Transformation Rules:

    • ACM_ImportMetadata_View

    • ACM_ImportMetadata_Account

    • ACM_ImportMetadata_Entity

  • Transformation Rule Profile:

    • ACM_ImportMetadata

  • Standard default Metadata, Layouts, Properties, Validations, and Request Profiles

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.

NOTE: It is not recommended to modify any standard default Dimensions, Request Profiles, Layouts, or Properties provided with installation as they may get over-written during the upgrade. Make a copy of them with a different name instead.