Solution Guide Template

This template outlines the information to include when creating a Guide for a OneStream Solution.

Solution Overview

Overview of the solution. What are the benefits to the customer? What pain points does it help with?

Setup and Installation

Information for planning, configuring, and installing the solution.

Dependencies

What is the minimum OneStream Platform version required to install this solution?

Are other 3rd party tools needed? If so, what versions.

Select the [Solution] Development Location

This is usually boilerplate documentation.

Create the OneStream Development Application

This is usually boilerplate documentation.

Application Server Settings

This is usually boilerplate documentation.

Install [Solution]

Steps for installing from the MarketPlace. This is usually very similar for all Solutions.

Set Up [Solution]

This is the table setup process for the first time you run the solution. This is usually very similar for all Solutions.

[Solution] Dashboard

The sections in this heading will be different for each Solution.

• Describe the home page. Provide information on the buttons, filters, toolbars, and so on.
• Describe each page that the user can access. Describe what they can do on those pages and how they do it. If there are toolbars or buttons unique to a page, describe them.
• Describe any settings that the user can change. Are there preferences they can set?

Administration Tasks

The sections in this heading will be different for each Solution.

• Describe any tasks that only administrators can do.
• Describe settings that only an administrator can change.

Data Structures

The sections will list all data tables that are created and data structure for the tables

• List of all the Databases and Tables created for this solution
• Data structure for each database and tables that are created or imported.

Other Headings as Needed

Each solution is different and may need additional headings. Add them here. The last topic in the guide is always the Help topic.

Help and Miscellaneous Information

This is always the last topic in the guide. Other than the version numbers for the solution and platform, this information is boilerplate.

Display Settings

This is usually boilerplate documentation.

Package Contents and Naming Conventions

Other than making the example and table information specific to the solution, this information is usually boilerplate.

Solution Database Migration Advice

This is usually boilerplate documentation.

MarketPlace Solution Modification Considerations

This is usually boilerplate documentation.