Switch to Builder View Option

Within the Builder View Screen, users can select the folder icon next to "Currently configuring" in the top right to determine which users the changes made will affect. By default, the selected user will be whichever User is currently logged in. Changes can be made at specific user levels or at the Environment level to have changes affect all users.

Builder View Main Screen

 

Building Charts

Users have the option of creating charts within Builder View. Users will first need to select the Chart section and then click the "+" icon at the top left of the screen.

Create New Chart

New Chart Main Screen

Model Manager

Users will then proceed to the Model Manager where they will be given an option to select the type of model they wish to create. "Standard Model" and "Query Model" are the two options. Query Model is the option that will most often be used for creating Charts. Users may also select a pre-existing model to either modify or base their new model on. 

Model Manager Screen

Query Builder Screen

Selecting "Query Model" brings the user to the "Query Data Model Creator" screen which displays what queries will be associated with the chart.

Query Data Model Creator Screen

Users should select the "Manage Queries" button to access the "Select Query" pop-up screen. This screen allows users to select existing queries from the list at the top section. Users may also create new queries directly from this screen.

Select Query Pop-up

Adding New Queries

Selecting the "Add Query" button gives users the ability to create a new query.

Add Query Button

Add TimeSeries Query

The TimeSeries Query allows users to generate queries based on tables that have monthly or weekly level data fields. Users choose a table, select a function, select a time-based field name, and set a start and end. Users may select the option to "Use Transactional Data" which considers row based data rather than arrayed data. This information will produce a Sql statement and populate the Dates Relative to option. As shown in the example below, the time-based field name is "y1m" and selecting a start of 1 and an end of 12 populates the query with SUM(y1m1) through SUM(y1m12).

Add TimeSeries Query Button

Add TimeSeries Query Display

TimeSeries Query Display

Transactional Data

Users may select the option to "Use Transactional Data" which considers row based data rather than arrayed data. The table chosen should have the column "period" because this field is used for criteria. As shown in the images below, a user will check the "Use Transactional Data" box, name the Query, select the appropriate table, select the aggregation function, select the plan period, select the field which will be displayed, and finally a start and end date range. This will populate a time series query.

Add Time Series Query: Transactional Data

Transactional Data Query

Add TimeSeries Queries

The Add TimeSeries Queries allows users to generate multiple queries simultaneously based on tables that have monthly or weekly level data fields. Users choose several tables, select functions, select the time-based field names, and set start and ends. This information will produce a Sql statement and populate the Dates Relative to option for several queries.

Add TimeSeries Queries

Add TimeSeries Queries Display

TimeSeries Queries Display

Remove Query

This option allows users to remove any queries that are not desirable anymore. This may be used if a query was added by mistake or if a query is not necessary anymore. 

Remove Query Button

Dates Relative to

Checking the "Dates Relative to" box allows users to customize which dates will be displayed in the grid based on an offset value. The table below explains the different options users can select. 

Dates Relative to Options

Field	Description
Plan Period Options	Users can select between Monthly, Weekly, and Daily Plan periods depending on the relevant planning period of the query
+ or - offset	Users can select whether the offset will be adding or subtracting from the current date
Offset Number	Users can select the amount of time that will be offset from the query
Frequency Options	Users can select between Months, Weeks, and Days
Date Formatting Options	Users can select different date formatting options. They can choose between mmm-yy, yyyy-wk, and yyyy-wk-dd

Chart Builder

Users will then proceed to the Chart Builder main screen where specific details may be modified. 

Chart Builder Main Screen

Component Setup

Users have the option to change the type of graph they want to display along with how they want the data to display on the graph. 

Chart Options

Line Options

Model Definition

Users can customize the characteristics of each column of their chart using the Model Definition Section. Users have the option to determine the color of each data type in the graph as shown in the figure below. Furthermore, GAINS allows for display of dual y-axes by customizing the "Use Axis" for columns as "Y-Left" or "Y-Right".

Chart Color Options

Dual Y-Axes Option

Chart Properties

Users may configure the chart properties including the placement of the legend as well as which data labels are displayed. The data label display effects are shown in the Graph Preview section below.

Chart Properties

Axis Properties

Users may also modify specific details about the Y-Axis and the X-Axis. 

Axis Properties

X&Y-Axis Grid Options

Fields	Description
Data Type	There are two options, numeric or category.
Minor Ticks Count	Determines the number of ticks shown in the chart.
Rotate Labels	Determines the angle of which to rotate the labels.
Title	This is where the user types in the title of the axis..
Data Format	The options are none, currency, quantity, percentage, and date.
Show Grid	Check mark to determine whether or not the grid is shown.
Vary Color	Check mark to determine whether user wants variations in color

X & Y-Axis Grid Options

Graph Preview

Any changes made to the graph will be represented by the preview on the right. 

Graph Preview with Labels

Graph Preview without Labels

Launch Details

At the bottom of the Chart Builder screen, users may select which assemblies and/or queries are connected to the chart through the "Set Launch Details For" section. Users may right click in the assembly view and select "launch details" to open up the associated assembly.  Further details may be found in the GAINS Portal Wiki Section.

Set Launch Details For

Save Chart

Once all desired specifications to the graph have been made, users must name the component and save the chart. This chart will then be available to view in the Builder Screen. 

Save Chart

Building Grids

Users may build Grids in the Builder view. The Grid is a table of data for the desired aliases. Users may create a new Grid by going to the Grid tab on the Builder Home Screen and selecting the "+" icon.

Builder Home Grid Option

Grid Builder Screen

Model Manager

Users will then proceed to the Model Manager where they will be given an option to select the type of model they wish to create. "Standard Model" and "Query Model" are the two options. Standard Model will be used primarily for creating Grids. Users may also select a pre-existing model to either modify or base their new model on. 

Model Manager Screen

Standard Model Builder

Selecting "Standard Model" brings the user to the "Standard Model Builder" screen where users will select which aliases they want displayed in the chart. A user may double click any alias at the top to add it to the comprehensive list at the bottom. An alias can also be removed from the bottom section by double clicking it. Once the desired aliases have been selected, users proceed by typing in a name for the chart and clicking the "Apply" button at the bottom right.

Standard Model Builder Screen

Calculation Column

Furthermore, a calculation column can be added to the list of aliases displayed by selecting the "Add Calc Column" button. The "Calculation Column Setup" pop-up will display where users can write formulas using the alias list to be displayed in the inspectors. As shown in the example Calculation below for On Hand*Cost, aliases that can be used in the formula will be represented by Alias IDs.

Calculation Column Pop-up

Calculation Column Example

Grid Builder

Users will then proceed to the Grid Builder main screen where specific details may be modified. Users should select the "Refresh" button in the top right or check the "Auto Refresh Preview" button to see the grid populated. 

Grid Builder Screen

Users may additionally check the "Enable Grouping" or "Enable Totals" options within Model Definition. "Enable Grouping" brings up the "Set Aggregation Type" selection field for each alias where users can sum, average, take the minimum, take the maximum, or count of any alias. "Enable Totals" brings up the "Set Total" selection field for each alias which creates a row for totaling at the bottom of each field selected. 

Model Definition Options

Pre-Condition

Pre-Conditions can be added/removed at the bottom of the Model Definition section of this screen. Pre-Conditions filter the data that will be displayed in the grid similar to the function of the WHERE clause in a SQL statement. Multiple Pre-Conditions can be added with AND/OR determining the relationship between them. 

Pre-Condition Option

Grouped Header

Grouped Headers can be customized and added at the bottom of the screen. Grouped Headers represent groupings of the selected fields that will display on the grids. Selecting the + button brings up the "Adding Grouped Header" pop-up window which allows users to choose the title of the header and select the range of columns contained in the Grouped Header.

Grouped Header Pop-up

Save Grid

Once all the desired modifications are made, users must enter a component name and save. 

Save Grid

Creating Assemblies

Users have the option of creating assemblies within Builder View. Users will first need to select the Assembly section and then click the "+" icon at the top left of the screen. This screen dictates how the screen will appear for other users who decide to use this Assembly.

Assembly Tab

Assembly Builder Screen

Add Component

In this screen, users may select any type of component (charts, grids, inspectors, etc.) that have been made in GAINS to display within the Assembly by selecting the "Add Component" button on top. 

Add Components

Layout Management

Users may then adjust the location and size of the components using the "Layout Management" button.

Layout Management

Set Category

Users can select where the assembly is displayed in the GAINS menu by selecting the "Set Category" drop down and selecting the category. Multiple categories can be chosen. 

Set Category

Moving Components

Once components are added to the assembly, they can be moved with the mouse to the desired positions.

Moving Components

Default Query

Users may select a default query so that a specific query is populated when the assembly is opened.

Default Query

Save Changes

Once all modifications have been made, users must enter the name for their Assembly and save changes. 

Saving Changes

Retrieval Builder

Users have the option of creating Retrievals within Builder View. Users will first need to select the Retrieval section and then click the "+" icon at the top left of the screen

Creating New Retrieval

Model Manager

Upon creating a new Retrieval, the "Model Manager" pop-up will appear. Users will be given the option to select the type of model they wish to create. "Standard Model" and "Query Model" are the two options. Standard Model will be used primarily for creating Retrievals. Users may also select a pre-existing model to either modify or base their new model on. 

Model Manager

Standard Model Builder

Selecting "Standard Model" brings the user to the "Standard Model Builder" screen where users will select which aliases they want displayed in the chart. An alias can also be removed from the bottom section by double clicking it. Once the desired aliases have been selected, users proceed by typing in a name for the chart and clicking the "Apply" button at the bottom right.

Standard Model Builder

Calculation Column

Furthermore, a calculation column can be added to the list of aliases displayed by selecting the "Add Calc Column" button. The "Calculation Column Setup" pop-up will display where users can write formulas using the alias list to be displayed in the inspectors. As shown in the example Calculation below for On Hand*Cost, aliases that can be used in the formula will be represented by Alias IDs.

Calculation Column Pop-up

Calculation Column Example

Retrieval Builder Home Screen

After the model selection is complete, users will be taken to the Retrieval Builder home screen. Users can select the "Refresh" button or check the "Auto Refresh Preview" box on the right side to preview what the Retrieval will look like. Users can also enable grouping by checking the "Enable Grouping" box next to Set Models. Once the retrieval is complete, users should name the component and then select the save icon at the top left. 

Retrieval Builder Home Screen

Pre-Condition

Pre-Conditions can be added/removed at the bottom of the Model Definition section of this screen. Pre-Conditions filter the data that will be displayed in the grid similar to the function of the WHERE clause in a SQL statement. Multiple Pre-Conditions can be added with AND/OR determining the relationship between them. 

Pre-Condition Option

Inspectors Builder

Users have the option of creating Inspectors within Builder View. Users will first need to select the Inspector section and then click the "+" icon at the top left of the screen

Creating New Inspector

Model Manager

Upon creating a new Retrieval, the "Model Manager" pop-up will appear. Users will be given the option to select the type of model they wish to create. "Standard Model" and "Query Model" are the two options. Standard Model will be used primarily for creating Inspectors. Users may also select a pre-existing model to either modify or base their new model on. 

Model Manager

Standard Model Builder

Selecting "Standard Model" brings the user to the "Standard Model Builder" screen where users will select which aliases they want displayed in the chart. An alias can also be removed from the bottom section by double clicking it. Once the desired aliases have been selected, users proceed by typing in a name for the chart and clicking the "Apply" button at the bottom right.

Standard Model Builder

Calculation Column

Furthermore, a calculation column can be added to the list of aliases displayed by selecting the "Add Calc Column" button. The "Calculation Column Setup" pop-up will display where users can write formulas using the alias list to be displayed in the inspectors. As shown in the example Calculation below for On Hand*Cost, aliases that can be used in the formula will be represented by Alias IDs.

Calculation Column Pop-up

Calculation Column Example

Inspector Home Screen

After the model selection is complete, users will be taken to the Inspector Builder home screen. Users can select the "Refresh" button or check the "Auto Refresh Preview" box on the right side to preview what the Inspector will look like. Users can also enable grouping by checking the "Enable Grouping" box next to Set Models. Selecting this will display the "Set Aggregation Type" column. Users may also change the orientation of the inspector to be Horizontal or Vertical by clicking the drop down "Fields Orientation" menu. The "Category" column is used to set which inspectors each alias will appear in as shown in the figure below. Once the inspector is complete, users should name the component and then select the save icon at the top left. 

Inspector Home Screen

Pre-Condition

Pre-Conditions can be added/removed at the bottom of the Model Definition section of this screen. Pre-Conditions filter the data that will be displayed in the grid similar to the function of the WHERE clause in a SQL statement. Multiple Pre-Conditions can be added with AND/OR determining the relationship between them. 

Pre-Condition Option

Subassembly Builder

Users have the option of creating Subassemblies within Builder View. Users will first need to select the Subassembly section and then click the "+" icon at the top left of the screen.

Create New Subassembly

Subassembly Home Screen

On this screen, a name for the Subassembly must be added on the top left. A title can be given to the subassembly and users may check the "Show Title" box to have it display in assembly view. The Layout option allows users to choose whether the components are displayed as "Tabbed", "Horizontal", or "Vertical". The Default Tab option applies to the "Tabbed" layout and will allow users to pick which component will display first. 

Subassembly Home Screen

Add Component

At the bottom right of the screen, users can select the "Add Component" button to bring up the available components that can be added to the subassembly. The subassembly can be deleted by selecting the "Delete" button. It can be saved after changes are made by clicking the "Save" button. 

Add Component