Skip to main content
insightsoftware Documentation insightsoftware Documentation
{%article.title%}
Published:
Was this article helpful?
0 out of 0 found this helpful

Creating Data View Input Apps

You can use data view input apps to create single or multi-tabbed data input apps to allow users to enter data as required.

Specifying overall settings

You can specify settings for a data view input app that control the type of data displayed, whether the interface has tabs or not, and some of the options available to the user.

Field Notes

Layout type

Use this to specify the layout type of the data view. Select Tabbed for a multi-tabbed data view layout. Select Single for a single view layout.

Note:

  • If Single layout type is selected, only one Data Area View can be defined.
  • If Tabbed layout type is selected, at least one Tab must be created. Tabs are not required for a Single layout type.

Use comments

Select Yes to allow the user to enter comments in the data view.

Use line item detail

Select Yes to allow the user to enter line item detail in the data view.

Note: This will only be available if line item detail is configured for the time periods in the view.

Use attachments

Select Yes to allow the user to attach files in the data view.

Note: This will only be available in the data view if file attachments are enabled in the system.

Use validations

Select Yes to validate the data entered prior to it being submitted.

Note: This option requires validations to be configured for the app.

Data type

Select Adjusted to query adjusted data (unadjusted + journal entries) or Unadjusted to query data excluding journal entries.

Note: The option selected will apply to all data areas that are downloaded. This can be overridden per data area if required by using the AdjustedDetail function in the Data Area Definition’s “Additional Configuration” section.

Specifying pre-selection commands

Use pre-selection to perform any commands before symbol selection. The typical use of pre-selection is to perform advanced logic to determine default selections or set the range of possible symbols. Pre-selection commands are executed after symbol selection settings are applied from the app configuration, so all symbol selection variables have been created at this point.

See Generating a symbol selection form for details on symbol selection variables.

Note: Using pre-select commands to set default or symbols overrides the settings in User Selections.

Variable Notes

<Dimension>Default

Specify the default selection in the symbol selector, for the Dimension.

<Dimension>Symbols

Specify the list of available selections in the symbol selector for the Dimension.

Example: Setting the list of possible symbols to all YTD periods

Create VARIABLE ytdPeriodList AS RANGE

Set VARIABLE ytdPeriodList = "[[SYSTEM,SGPTimePeriodsYTD,DBDEFAULT]]"

For EACH ytdPeriod in ytdPeriodList

    Set VARIABLE TIMEPERIODSSymbols = ListAppend(TIMEPERIODSSymbols, "$ytdPeriod$#99")

Next

Specifying user selections

Use user selections to specify dimensions for which the user will be prompted to choose symbol(s). For each dimension that the user will choose symbols, right-click on the User Selections folder and choose Add Dimension. The dimension settings page will appear.

Variable Notes

Dimension

Select the dimension the user will be prompted to select symbol(s) for.

Available selections

Select a symbol to limit the possible symbols available to the user. If left blank the user will be able to select from all symbols available in the dimension. The available symbols will always be limited by user access.

Default selection

Select a symbol to specify as the default selection. This can either be a database symbol, an attribute symbol, or a floating time period.

Note: Attribute symbols and floating time periods will only be available if they are defined in your system.
For more information, see “Specifying attributes in Longview Application Administrator” in the Longview Analysis and Reporting Guide.

Selection required

Check this to force the user to select a symbol to continue.

Allow leaf selection

Check this to allow the user to select a leaf symbol.

Allow parent selection

Check this to allow the user to select a parent symbol.

Allow read-only selection

Check this to allow the user to select a read-only symbol.

Allow multiple selections

Check this to allow the user to select more than one symbol.

Attribute filter

Enter an attribute filter expression to further limit the possible symbol selections.
For more information see SymbolSelector in the Longview Developer’s Guide.

Specifying attribute-based selections

Use Attribute Based Selections to specify selections for dimensions that are deter- mined by an attribute value. For each dimension to be determined via an attribute, right-click on Attribute Based Selections and select Add Dimension.

Variable Notes

Dimension

Select the dimension to select symbol(s) using an attribute value.

Attribute class

Select the class of attribute to use.

Attribute name

Select the attribute.

Source dimension (SYMBOL class)

If the attribute class is SYMBOL, select the source dimension.

Note: The source dimension must be a dimension specified as a user selection or attribute-based selection.

Note: The variable created to hold the attribute-based symbol will have the same name as the dimension. The variable created will be a STRING type.

Example, to set the currency selection to be the functional currency of the selected entity:

  1. Select the CURRENCIES dimension.
  2. Set the attribute class to SYMBOL.
  3. Enter “ZGPNativeCurrency” for the attribute name.
  4. Select ENTITIES for the source dimension.

Example, to set the time period selection to be the current period:

  1. Select the TIMEPERIODS dimension.
  2. Set the attribute class to SYSTEM.
  3. Enter “SGPCurrentPeriod” for the attribute name.

Specifying post-selection commands

Use post-selection to perform any commands after symbol selection, but before any data areas are created. The typical use of post-selection commands is to perform advanced symbol selection tasks. For example, you might use post-selection to create a list of all standard intercompany accounts. In addition, you may want to use a form to further refine selection, or instead of the template provided symbol selection.

Caution: Post-selection commands are executed as part of symbol selection within a view. Any Create VARIABLE commands will cause an error during symbol reselection. If “Allow user to change selections in view” is allowed, either create variables only in pre-selection, or wrap variable creation in VariableExists checks.

Example: Get a list of all standard intercompany accounts

If Not(VariableExists("ACCOUNTS"))

    Create VARIABLE ACCOUNTS AS RANGE

END If

 

Set VARIABLE ACCOUNTS = CreateList(SYMBOLS, DATABASE, ACCOUNTS, "TB###")

Set VARIABLE ACCOUNTS = FilterList(ACCOUNTS, "[[SYMBOL,ZElimICSchTransactions,THIS]] == 'ICStandard'")

Example: Specifying multiple attribute time periods (current forecast and budget period)

If Not(VariableExists("TIMEPERIODS"))

    Create VARIABLE TIMEPERIODS AS RANGE

END If

Set VARIABLE TIMEPERIODS = "[[SYSTEM,SGPForecastPeriod,DBDEFAULT]]" Set VARIABLE TIMEPERIODS = ListAppend(TIMEPERIODS, "[[SYSTEM,SGPBudgetPeriod,DBDEFAULT]]")

Example: Specify temporary symbols mixed with real symbols

If Not(VariableExists("TIMEPERIODS"))

    Create VARIABLE TIMEPERIODS AS RANGE

END If

Set VARIABLE TIMEPERIODS = "[[SYSTEM,SGPForecastPeriod,DBDEFAULT]]"

Set VARIABLE TIMEPERIODS = ListAppend(TIMEPERIODS, DIFF")

Set VARIABLE TIMEPERIODS = ListAppend(TIMEPERIODS, "[[SYSTEM,SGPBudgetPeriod,DBDEFAULT]]")

To capture additional user input via a form, it is required that the button clicked be copied to the FORM_ButtonClicked variable to ensure expected app execution. Specifically, app execution continues if FORM_ButtonClicked has a value of “OK”.

Example: Capture additional user input via a form

Show FORM USING Custom.lvfrm

Set VARIABLE FORM_ButtonClicked = $LVS_BUTTONCLICKED$

Allowing currency re-selection in a data view input app

There may be cases where the initial selection in the app is based on the functional currency of the selected entity, but you want the user to be able to change the currency.

To accomplish this, follow these steps:

Note: Substitute CURRENCY for the name of your currency dimension, or use an attribute token or $CORE.DimensionInfo.KeyDimensionList[4]$ for CURRENCY for flexibility.

  1. In the pre-selection add the following to support currency selection:

    //Configure currency selections for re-select in view

    Create GLOBALVARIABLE CURRENCYDefault AS STRING

    Create GLOBALVARIABLE CURRENCYOptions AS STRING

    Create GLOBALVARIABLE CURRENCYSymbols AS RANGE

    Create GLOBALVARIABLE oldSelectDimensionList[] AS STRING //used to restore symbol selection to original options

     

    Set VARIABLE CURRENCYOptions = "11000"

    Set VARIABLE CURRENCYSymbols = "SOURCEC###"

     

    Create VARIABLE isCurrencySelection AS NUM //used to track in post-selection if the is changing currency only

  2. In the Post-Selection add logic to set the native currency on entity selection:

    If Not(VariableExists("CURRENCY"))

        Create VARIABLE CURRENCY AS STRING

    END If

     

    If $isCurrencySelection$ //reset selection options to allow regular symbol selections

        Set VARIABLE FORM_SelectDimensionList = ListAppend(CORE_EmptyList, oldSelectDimensionList)

        Set VARIABLE isCurrencySelection = 0

    Else

        Set VARIABLE CURRENCY = "[[SYMBOL,ZGPNativeCurrency,$ENTITIES$]]" //apply currency of selected entity

    END If

  3. Add a View Action to allow the user to change currency (this will be a new button on the toolbar)

    Set VARIABLE oldSelectDimensionList = ListAppend(CORE_EmptyList, FORM_SelectDimensionList)

    Set VARIABLE isCurrencySelection = 1

     

    Set VARIABLE FORM_SelectDimensionList = ListAppend(CORE_EmptyList, "CURRENCY")

     

    Run PROCEDURE "VIEW\OnReselect.lvpro"

Specifying the data area definition

Use Data Area Definitions to specify the data areas to be used in the data input view. For each data area definition to be created, right-click on Data Area Definitions and select New Document.

  1. For the Name, enter the name of your Data Area

    Note: The name must 29 or fewer characters and only contain alphanumeric characters and underscore “_”. The actual name of the data area in application framework will be “da” + Name, so if you need to refer to the Main data area in application framework, use daMain as the name.

  2. In the Options table, complete the following fields
    Field Notes

    Download this data area

    Select this option if you would like to download and display data in this data area.

    Note:

    • If your data area is only being used to lock data, the “Download this data area” option is not required.

    • If you have more than one data area set to download, the last on in the list will be displayed in a single layout data input app.

    Submit from this data area

    Select this option if you would like to submit from this data area to the database once the submit button is clicked within the data view.

    Note:

    • You cannot set a data area to Submit without enabling the “Download this data area” option as well.

    • At least one data area definition in your data view input app must be set to Submit.

    • Only data that is covered by a lock will be submitted.

    Submit comment

    Enter the submit comment that will be associated with this data area submission.

    Note: This is only required if “Submit from this data area” is enabled.

    Lock this data area

    Select this option if you would like to lock this data area.

    Note: The user will be able to enter values for any cells that are downloaded and part of the lock area and to which the user has write access.

    Lock comment

    Enter the Lock comment that will be associated with this data area lock.

    Note: This is only required if “Lock this data area” is enabled.
  3. In the Data Area table, complete the following fields for each dimension:
    Field Notes

    Symbols

    Type a symbol name. Alternatively, you can use the symbol selector.

    To add more than one symbol for a dimension, select a row containing the dimension for which you want to add another symbol and click Symbol.

    To move a symbol up or down within a dimension, click Move Up or Move Down.

    Note: To use the symbol selected by the user or defined by an attribute, enter the name of the dimension as a variable, for example $ENTITIES$

    Spec

    Indicate the symbol specification using one of the following values:

    • All: Includes all symbols within the selected symbol’s hierarchy.
    • Leaf: Includes only leaf symbols within the selected symbol’s hierarchy.
    • Parent: Includes only parent symbols within the selected symbol’s hierarchy.
    • Root and Parent: Includes only root and parent symbols within the selected symbol’s hierarchy.

    Note: To use the symbol selected by the user or defined by an attribute, enter the name of the dimension as a variable, for example $ENTITIES$

    Level

    Specify the number of levels down from the symbol to be included in the data area.

  4. Use Additional Configuration to specify any other Data Area Definition features you wish to use. Additional Configuration is a code editor that allows you to enter data area definition functions to be included in the data area.

    For more information on the code editor, see Using the code editor.

    Typical use of Additional Configuration in a data area definition would be to

    1. Add an attribute filter using the AttributeFilter function
    2. Add a schedule to the using the Schedule function
    3. Add a temporary symbol using the TempSym function
    4. Override the query type specified in Settings using the AdjustedDetail function.

Specifying the data area views

Use data area views to specify how the data areas will be displayed to the user. For each data area view to be created, right-click on Data Area Views and select New Document.

Note: If using a Single Layout type for your data view, only one Data Area View can be defined.

Name

Specify the name of the data area view

Setting view orientation

Use orientation to determine how each dimension is presented to the user. At least one dimension must be in the rows and columns orientation. Multiple dimensions in rows or columns are nested outer to inner, based on their left to right position.

Use the following table to determine the way dimensions display in the view.

Orientation View Appearance

Columns or rows

The left-most dimension listed in the orientation section is the outermost dimension in the view.

Slice

Each dimension in the slice dimension is presented to the user as a symbol selector. Dimensions are presented in the view in the order that they appear in the Slice orientation.

Fixed

The view opens displaying fixed symbols in dimension order on the Fixed Symbols tab.

Dimensions appear on the Fixed Symbols tab in their natural order regardless of the order listed in the Fixed orientation.

To modify dimension orientation:

  1. In the Orientation section for the dimension you want to reorient, select the dimension.
  2. Drag and drop the selected dimension into the desired position.

Specifying symbols

Use symbol selection to specify the symbols that are displayed in the view. In the Symbol Selection table, complete the following fields for each dimension:

Note: You can copy the symbol selections from a particular Data Area Definition into the Symbol Selection table by selecting the Data Area Definition in the from drop list and clicking the Copy Default Selections button. For dimensions set as fixed in the orientation, the first symbol specified in the data area will be copied into the selections. The Spec and Level fields are not applicable if a symbol contains a variable.

Field Notes

Symbol

Type a symbol name. Alternatively, you can use the symbol selector. If you specified a data area definition for the view, symbol selections are limited by the it.

To add more than one symbol for a dimension, select a row containing the dimension for which you want to add another symbol and click Symbol.

To move a symbol up or down within a dimension, click Move Up or Move Down.

Note: To use the symbol selected by the user or defined by an attribute, enter the name of the dimension as a variable, for example $ENTITIES$

Spec

Indicate the symbol specification using one of the following values:

  • All — Includes all symbols within the selected symbol’s hierarchy.
  • Leaf — Includes only leaf symbols within the selected symbol’s hierarchy.
  • Parent — Includes only parent symbols within the selected symbol’s hierarchy.
  • Root and Parent — Includes only root and parent symbols within the selected symbol’s hierarchy.

Level

Specify the number of levels down from the symbol to be included in the data area.

Levels to expand

For dimensions in the rows and column orientation only, you can specify the number of levels to expand the hierarchy of each symbol included.

Specifying dimension display settings

Use dimension display settings to specify how symbols are displayed in the view.

In the Dimension Display Settings table, complete the following fields for each dimension:

Note: Show Name and Show Description only affect dimensions in the Rows or Columns orientation.

Field Notes

Show name

Check this to display the name of the symbol in the view. If both Show Name and Show Description are selected the symbol name and description will be displayed separated by a hyphen for symbols in the dimension.

Show description

Check this to display the description of the symbol in the view. If both Show Name and Show Description are selected the symbol name and description will be displayed separated by a hyphen for symbols in the dimension.

Fit to tile

Check this to make the view auto-size to fit symbol titles. For Rows this affects the width of the title. For Columns this can only be selected for the inner dimension and affects the width of the column.

Column width

If Fit to Title is not selected, enter the width in pixels.

Wrap

If Fit to Title is not selected, check this to wrap titles onto new lines if the text does not fit in the specified width.

Specifying number formatting

Use Number Formatting to specify how numbers are displayed in the view. In the Number Formatting table complete the following fields:

Field Notes

Default decimals

Enter the number of decimals to display for each numeric value. Generally, this should be from 0 to 9. This can be overridden for a specific symbol using the SymbolDecimals function in the Additional Configuration section.

Use parentheses for negative numbers

Select Yes to display negative numbers with parentheses.

Select No to display negative numbers with a negative sign.

Use thousands separator for numbers

Select Yes to display a locale-specific thousands separator based on the operating system setting.

Select No to not display a thousand separator.

Specifying the left title

Use Left Title to optionally specify the left title that appears in the view.

Field Notes

Left title

Enter text to display in the left title area of the view. This is optional and can be left blank.

Include entity in title

Check this to include the entity in the left title area of the view. Entities can only be included in the title under one of the following conditions.

  • Entities must be a dimension specified as a user selection and that selection must not allow multiple selections, or
  • Entities must be a dimension specified as an attribute-based selection and the source dimension (SYMBOL class) must not allow multiple selections, or
  • A variable must be created as the name of the dimension with a type STRING. This can be done in the Pre or Post Selection sections of the DVI.

Include currency in title

Check this to include the currency in the left title area of the view. Currencies can only be included in the title under one of the following conditions.

  • Currencies must be a dimension specified as a user selection and that selection must not allow multiple selections, or
  • Currencies must be a dimension specified as an attribute-based selection and the source dimension (SYMBOL class) must not allow multiple selections, or
  • A variable must be created as the name of the dimension with a type STRING. This can be done in the Pre or Post Selection sections of the DVI.

Include time period in title

Check this to include the time period in the left title area of the view. Time Periods can only be included in the title under one of the following conditions.

  • Time Periods must be a dimension specified as a user selection and that selection must not allow multiple selections, or
  • Time Periods must be a dimension specified as an attribute-based selection and the source dimension (SYMBOL class) must not allow multiple selections, or
  • A variable must be created as the name of the dimension with a type STRING. This can be done in the Pre or Post Selection sections of the DVI.

Specifying options

Use Options to specify additional view settings. In the Options table complete the following fields:

Field Notes

Allow user to change selections in view

Select Yes to allow the user to change selections once the view is displayed. This allows the user to update the user selections without closing the app and re-opening it.

Note: Select No if no user selections are defined in the app.

Allow dynamic rollup of input

Select Yes to have parent totals automatically calculated as the user enters numeric values.

Use on demand calculations

Select Yes to allow the user to run on demand calculations. An additional icon Calculate will be added to the toolbar to allow the user to perform the calculation(s) set to run on demand.

Dynamic Calculations

Select calculations to be performed as the user manually changes values in the view. The selections available are determined by the contents of the Calculations folder.

Note: Calculations are executed in the order listed.

Use on demand validations

If validations are defined for the input app, select Yes to display a toolbar icon to allow the user to run validations on demand. Validations are still executed on save regardless of this setting.

Selecting tools

Use Tools to enable the use of input tools within the view. See Input tools for information on the input tools. In the Tools table complete the following fields:

Field Notes

Allow use of adjust values tool

Select Yes to allow the user to right-click on a leaf cell to invoke the adjust values tool.

Allow use of copy across tool

Select Yes to allow the user to right-click on a leaf cell to copy the value across to all other leaf cells under the root in the view.

Allow use of pattern spread tool

Select Yes to allow the user to right-click on a parent cell and use the pattern spread tool to populate all leaf cells under the parent using a pattern.

Allow use of quick input tool

Select Yes to allow the user to right-click on a parent cell and use the quick input tool to populate all leaf cells under the parent.

Allow use of quick spread tool

Select Yes to allow the user to right-click on a parent cell and use the quick spread tool to populate all leaf cells under the parent using a trend.

Allow use of import

Select Yes to allow the user to import data from a file. The file to be imported must specify the symbol in each dimension and the value. The user will be able to clear all data in the view and select the field delimiter used in the file.

Allow use show underlying adjustments

Select Yes to allow the user to access underlying adjustments via the cell context menu. Any adjustments impacted the selected cell will be displayed in the Show Adjustments table

Allow use show audit trail

Select Yes to allow the user to access audit trail via the cell context menu. Any data changes impacting the selected cell will be displayed in the Show Audit Trail table.

Allow use show underlying comments

Select Yes to allow the user to access underlying comments via the cell context menu and toolbar. Any comments related to the selected cell will be displayed in the Show Comments table.

If executed from the toolbar, all comments related to the entire data area will be displayed in the Show Comments table.

Customizing the data view

Use Additional Configuration to specify any other view features you wish to use in the data view. Additional Configuration is a code editor that allows you to enter view functions to be included in the configuration of the view.

For more information on the code editor, see Using the code editor.

Typical use of Additional Configuration in this app would be to

  • Add protected areas to the view using the Protect function
  • Add conditional style to the view using the ConditionalStyle function
  • Restrict input to numeric values or text values using the NumericInputOnly and/ or TextInputOnly functions
  • Hiding specific symbols in the view using the Hide function
  • Overriding the decimals displayed for certain symbols using the SymbolDecimals function
  • Adding separators between symbols using the InsertSeparator function.

Specifying view actions

Use Actions to specify custom toolbar and context menu actions with a view. For each action to be created, right-click on Actions and select New Document.

For each action complete the following fields:

Field Notes

Name

Enter the name of the action.

Action location

Select whether the action will appear in the toolbar or on the cell context menu.

Views to add action to

Select the data area views to assign the action to.

Action text

Enter text to display for the action. For a toolbar location, the text will appear to the right of the icon, if specified. For a context menu this will be the menu text.

Note: This is required for a context action, but is only required for a toolbar action, if an icon is not specified.

Action icon

Enter the path to the icon to display for the action

Note: This is optional for a context action but is required for a toolbar if action text is not specified.

Action tooltip text

Enter additional information that will appear when the user hovers the mouse on the action. This is optional.

Cell restriction expression

Enter an expression to limit the cells the context menu appears on. This is optional and only applied when the action location is Cell. You can use Not, And, and Or in conjunction with PARENT, LEAF, STATIC, WRITABLE, and READONLY.

For more information on the expression, see Action in the Longview Developer’s Guide.

Action

Enter the commands to execute for this action via the code editor.

For more information on the code editor, see Using the code editor.

Specifying tabs

Use Tabs to add tabs to the data grid. Each tab can display a different data area view. For each Tab to be created, right-click on Tabs and select Add Tab.

Note: Tabs are only required if using a Tabbed Layout Type. For more information, see Specifying overall settings.

Field Notes

Data area

Select the data area definition to be used with this tab.

Data view name

Select the data area view to be used with this tab.

Tab name

Use this to provide a label to display on the tab

Action to run when switching to this tab

Select the command to execute when this tab is switched to by the user. The selections available are determined by the contents of the Tab Commands folder. This parameter is optional.

Note: If this is the first tab this command will be executed when the view first appears.

Action to run when switching from this tab

Select the command to execute when this tab is switched from by the user. The selections available are determined by the contents of the Tab Commands folder. This parameter is optional.

Background color

Use this to select the background color for the tab. The default color is transparent.

Specifying post-refresh commands

Use Post-Refresh to perform any commands after the data areas are downloaded but before any refresh calculations are performed. Use Post-Refresh to perform any processing that requires data to be downloaded into the data areas.

Note: Post-refresh commands are executed prior to any calculations with the “Run calculation when data is refreshed” option.

Specifying a tab action

Use Tab Actions to define commands and functions to be executed when switching between tabs in a tabbed view.

For more information on the code editor, see Using the code editor.

Specifying calculations

Use calculations to create models that are executed as part of the input app. Each model can be executed at various points in the app and is executed in the order listed in the Calculations folder. Use the calculation code block to specify the calculations using the code editor.

For more information on using the code editor, see Using the code editor.

For each model specify the run properties:

Field Notes

Data areas to run calculation on

Select the data area definitions to which this calculation applies.

Run calculation when data is refreshed

Check this to cause the calculation to occur when data is downloaded initially and whenever the user clicks Refresh.

Prompt for submit on close

If run calculation when data is refresh is enabled, check this option to indicate that the values calculated will be treated as data changes and submitted to the database. The user will be prompted to submit changes when the view is closed even if no other changes were made.

Run calculation after user imports data

Check this to cause the calculation to occur after the user imports data via the import tool.

Note: Allow use of import tool must be enabled.

Run calculations after user uses an input tool

Check this to cause the calculation to occur after the user enters data using an input tool.

Note: At least one input tool must be enabled.

Run calculation before data is submitted

Check this to cause the calculation to occur when the user clicks Submit, but before the data is uploaded.

Note: This calculation will only be executed if other data has been changed in prior to submission.

Run calculation after data is submitted

Check this to cause the calculation to occur when the user clicks Submit, but after the data is uploaded. This is mostly useful when the calculation before submitting changes the data in ways that are confusing to a user remaining in the app, for example clearing data that should not be submitted.

Run calculation on demand

Check this to cause the calculation to occur when the user clicks Calculate.

Specifying data validations

Use Validations to specify data validations to perform when the user clicks the submit or validate icon. Validation failures can be specified as errors or warnings. Errors will prevent the user from submitting data, while warnings will inform the user of validation failures, but still allow the user to proceed with submitting data.

Note: For the Data View Input app there is a single validation procedure for all data views. Be sure to reference the correct data area name in any validation functions.

Field Notes

Validation dimensions

Use this to specify dimensions to include in validation results. This is normally used in cases where slice dimensions are used in the view to give the user better feedback as to where the data validation failure occurred.

Repeat for each validation:

  1. Create a variable to store the validation result.

    Note: You can use the same result variable for each validation.

  2. Write an expression to determine the validation result. Store the result in the variable created in step 1.
  3. Write a condition to check the validation result against the expected result.
  4. If the validation result does not pass the check, Set the VALD_Result variable and run procedure VALD\AddResult.lvpro to add the validation failure result to the list of validation failures.

    Note: You can type in Template_Validation into the validation area in your Data View Input app to get the sample syntax code below.

Example:

Create VARIABLE val as NUM

Set VARIABLE val = Value("daMain", "BS", "$TIMEPERIODS$", "$ENTITIES$", "GL", "SCENARIOS_Working", "$CURRENCIES$")

If $val$ != 0

    Set VARIABLE VALD_Result = "ERROR|Balance sheet is out of balance|$val$"    

    Run PROCEDURE "VALD\AddResult.lvpro"

END If

Setting variable VALD_Result

The VALD_Result variable is a string list variable, set as follows (separate each item with a pipe character “|”):

  1. ERROR or WARNING to specify the validation failure level
  2. The validation failure message to display to the user
  3. The validation failure amount
  4. If validation dimensions are specified, the symbol for each dimension

Specifying forms

Use Forms to capture user input:

  1. In an action within an input template
  2. During post-selection in an app

For each form complete the following fields:

Field Notes

Name

Enter the name of the form.

Title

Enter the title for the form. This is optional. If left blank the title of the form will be the same as the description of the app.

Width (in pixels)

Enter the width of the form. If not specified, the default width of 450 is used.

Height (in pixels)

Enter the height of the form. If not specified, the height is determined by the number of controls in the form.

Format for the date value returned

Enter the format a date is stored in an application framework variable when returned from a form. The format in the form is determined by the user’s regional settings.

Form controls

Add the controls to be displayed in the form via the code editor. For more information on the code editor, see Using the code editor.

Specifying instructions

Use Instructions to specify instructions to be displayed in the instructions tab in the view. Instructions are specified using HTML. A general layout for instructions is provided. For each instruction page to be created, right-click on Instructions and select New Document.

  1. Add list items <li> to the Data Entry list to specify data entry instructions.
  2. Add list items <li> to the Note list to specify any notes related to the input.
  3. Modify the Comments section as required to remove any features not used in the app.
Published:

Creating Data View Input Apps

You can use data view input apps to create single or multi-tabbed data input apps to allow users to enter data as required.

Specifying overall settings

You can specify settings for a data view input app that control the type of data displayed, whether the interface has tabs or not, and some of the options available to the user.

Field Notes

Layout type

Use this to specify the layout type of the data view. Select Tabbed for a multi-tabbed data view layout. Select Single for a single view layout.

Note:

  • If Single layout type is selected, only one Data Area View can be defined.
  • If Tabbed layout type is selected, at least one Tab must be created. Tabs are not required for a Single layout type.

Use comments

Select Yes to allow the user to enter comments in the data view.

Use line item detail

Select Yes to allow the user to enter line item detail in the data view.

Note: This will only be available if line item detail is configured for the time periods in the view.

Use attachments

Select Yes to allow the user to attach files in the data view.

Note: This will only be available in the data view if file attachments are enabled in the system.

Use validations

Select Yes to validate the data entered prior to it being submitted.

Note: This option requires validations to be configured for the app.

Data type

Select Adjusted to query adjusted data (unadjusted + journal entries) or Unadjusted to query data excluding journal entries.

Note: The option selected will apply to all data areas that are downloaded. This can be overridden per data area if required by using the AdjustedDetail function in the Data Area Definition’s “Additional Configuration” section.

Specifying pre-selection commands

Use pre-selection to perform any commands before symbol selection. The typical use of pre-selection is to perform advanced logic to determine default selections or set the range of possible symbols. Pre-selection commands are executed after symbol selection settings are applied from the app configuration, so all symbol selection variables have been created at this point.

See Generating a symbol selection form for details on symbol selection variables.

Note: Using pre-select commands to set default or symbols overrides the settings in User Selections.

Variable Notes

<Dimension>Default

Specify the default selection in the symbol selector, for the Dimension.

<Dimension>Symbols

Specify the list of available selections in the symbol selector for the Dimension.

Example: Setting the list of possible symbols to all YTD periods

Create VARIABLE ytdPeriodList AS RANGE

Set VARIABLE ytdPeriodList = "[[SYSTEM,SGPTimePeriodsYTD,DBDEFAULT]]"

For EACH ytdPeriod in ytdPeriodList

    Set VARIABLE TIMEPERIODSSymbols = ListAppend(TIMEPERIODSSymbols, "$ytdPeriod$#99")

Next

Specifying user selections

Use user selections to specify dimensions for which the user will be prompted to choose symbol(s). For each dimension that the user will choose symbols, right-click on the User Selections folder and choose Add Dimension. The dimension settings page will appear.

Variable Notes

Dimension

Select the dimension the user will be prompted to select symbol(s) for.

Available selections

Select a symbol to limit the possible symbols available to the user. If left blank the user will be able to select from all symbols available in the dimension. The available symbols will always be limited by user access.

Default selection

Select a symbol to specify as the default selection. This can either be a database symbol, an attribute symbol, or a floating time period.

Note: Attribute symbols and floating time periods will only be available if they are defined in your system.
For more information, see “Specifying attributes in Longview Application Administrator” in the Longview Analysis and Reporting Guide.

Selection required

Check this to force the user to select a symbol to continue.

Allow leaf selection

Check this to allow the user to select a leaf symbol.

Allow parent selection

Check this to allow the user to select a parent symbol.

Allow read-only selection

Check this to allow the user to select a read-only symbol.

Allow multiple selections

Check this to allow the user to select more than one symbol.

Attribute filter

Enter an attribute filter expression to further limit the possible symbol selections.
For more information see SymbolSelector in the Longview Developer’s Guide.

Specifying attribute-based selections

Use Attribute Based Selections to specify selections for dimensions that are deter- mined by an attribute value. For each dimension to be determined via an attribute, right-click on Attribute Based Selections and select Add Dimension.

Variable Notes

Dimension

Select the dimension to select symbol(s) using an attribute value.

Attribute class

Select the class of attribute to use.

Attribute name

Select the attribute.

Source dimension (SYMBOL class)

If the attribute class is SYMBOL, select the source dimension.

Note: The source dimension must be a dimension specified as a user selection or attribute-based selection.

Note: The variable created to hold the attribute-based symbol will have the same name as the dimension. The variable created will be a STRING type.

Example, to set the currency selection to be the functional currency of the selected entity:

  1. Select the CURRENCIES dimension.
  2. Set the attribute class to SYMBOL.
  3. Enter “ZGPNativeCurrency” for the attribute name.
  4. Select ENTITIES for the source dimension.

Example, to set the time period selection to be the current period:

  1. Select the TIMEPERIODS dimension.
  2. Set the attribute class to SYSTEM.
  3. Enter “SGPCurrentPeriod” for the attribute name.

Specifying post-selection commands

Use post-selection to perform any commands after symbol selection, but before any data areas are created. The typical use of post-selection commands is to perform advanced symbol selection tasks. For example, you might use post-selection to create a list of all standard intercompany accounts. In addition, you may want to use a form to further refine selection, or instead of the template provided symbol selection.

Caution: Post-selection commands are executed as part of symbol selection within a view. Any Create VARIABLE commands will cause an error during symbol reselection. If “Allow user to change selections in view” is allowed, either create variables only in pre-selection, or wrap variable creation in VariableExists checks.

Example: Get a list of all standard intercompany accounts

If Not(VariableExists("ACCOUNTS"))

    Create VARIABLE ACCOUNTS AS RANGE

END If

 

Set VARIABLE ACCOUNTS = CreateList(SYMBOLS, DATABASE, ACCOUNTS, "TB###")

Set VARIABLE ACCOUNTS = FilterList(ACCOUNTS, "[[SYMBOL,ZElimICSchTransactions,THIS]] == 'ICStandard'")

Example: Specifying multiple attribute time periods (current forecast and budget period)

If Not(VariableExists("TIMEPERIODS"))

    Create VARIABLE TIMEPERIODS AS RANGE

END If

Set VARIABLE TIMEPERIODS = "[[SYSTEM,SGPForecastPeriod,DBDEFAULT]]" Set VARIABLE TIMEPERIODS = ListAppend(TIMEPERIODS, "[[SYSTEM,SGPBudgetPeriod,DBDEFAULT]]")

Example: Specify temporary symbols mixed with real symbols

If Not(VariableExists("TIMEPERIODS"))

    Create VARIABLE TIMEPERIODS AS RANGE

END If

Set VARIABLE TIMEPERIODS = "[[SYSTEM,SGPForecastPeriod,DBDEFAULT]]"

Set VARIABLE TIMEPERIODS = ListAppend(TIMEPERIODS, DIFF")

Set VARIABLE TIMEPERIODS = ListAppend(TIMEPERIODS, "[[SYSTEM,SGPBudgetPeriod,DBDEFAULT]]")

To capture additional user input via a form, it is required that the button clicked be copied to the FORM_ButtonClicked variable to ensure expected app execution. Specifically, app execution continues if FORM_ButtonClicked has a value of “OK”.

Example: Capture additional user input via a form

Show FORM USING Custom.lvfrm

Set VARIABLE FORM_ButtonClicked = $LVS_BUTTONCLICKED$

Allowing currency re-selection in a data view input app

There may be cases where the initial selection in the app is based on the functional currency of the selected entity, but you want the user to be able to change the currency.

To accomplish this, follow these steps:

Note: Substitute CURRENCY for the name of your currency dimension, or use an attribute token or $CORE.DimensionInfo.KeyDimensionList[4]$ for CURRENCY for flexibility.

  1. In the pre-selection add the following to support currency selection:

    //Configure currency selections for re-select in view

    Create GLOBALVARIABLE CURRENCYDefault AS STRING

    Create GLOBALVARIABLE CURRENCYOptions AS STRING

    Create GLOBALVARIABLE CURRENCYSymbols AS RANGE

    Create GLOBALVARIABLE oldSelectDimensionList[] AS STRING //used to restore symbol selection to original options

     

    Set VARIABLE CURRENCYOptions = "11000"

    Set VARIABLE CURRENCYSymbols = "SOURCEC###"

     

    Create VARIABLE isCurrencySelection AS NUM //used to track in post-selection if the is changing currency only

  2. In the Post-Selection add logic to set the native currency on entity selection:

    If Not(VariableExists("CURRENCY"))

        Create VARIABLE CURRENCY AS STRING

    END If

     

    If $isCurrencySelection$ //reset selection options to allow regular symbol selections

        Set VARIABLE FORM_SelectDimensionList = ListAppend(CORE_EmptyList, oldSelectDimensionList)

        Set VARIABLE isCurrencySelection = 0

    Else

        Set VARIABLE CURRENCY = "[[SYMBOL,ZGPNativeCurrency,$ENTITIES$]]" //apply currency of selected entity

    END If

  3. Add a View Action to allow the user to change currency (this will be a new button on the toolbar)

    Set VARIABLE oldSelectDimensionList = ListAppend(CORE_EmptyList, FORM_SelectDimensionList)

    Set VARIABLE isCurrencySelection = 1

     

    Set VARIABLE FORM_SelectDimensionList = ListAppend(CORE_EmptyList, "CURRENCY")

     

    Run PROCEDURE "VIEW\OnReselect.lvpro"

Specifying the data area definition

Use Data Area Definitions to specify the data areas to be used in the data input view. For each data area definition to be created, right-click on Data Area Definitions and select New Document.

  1. For the Name, enter the name of your Data Area

    Note: The name must 29 or fewer characters and only contain alphanumeric characters and underscore “_”. The actual name of the data area in application framework will be “da” + Name, so if you need to refer to the Main data area in application framework, use daMain as the name.

  2. In the Options table, complete the following fields
    Field Notes

    Download this data area

    Select this option if you would like to download and display data in this data area.

    Note:

    • If your data area is only being used to lock data, the “Download this data area” option is not required.

    • If you have more than one data area set to download, the last on in the list will be displayed in a single layout data input app.

    Submit from this data area

    Select this option if you would like to submit from this data area to the database once the submit button is clicked within the data view.

    Note:

    • You cannot set a data area to Submit without enabling the “Download this data area” option as well.

    • At least one data area definition in your data view input app must be set to Submit.

    • Only data that is covered by a lock will be submitted.

    Submit comment

    Enter the submit comment that will be associated with this data area submission.

    Note: This is only required if “Submit from this data area” is enabled.

    Lock this data area

    Select this option if you would like to lock this data area.

    Note: The user will be able to enter values for any cells that are downloaded and part of the lock area and to which the user has write access.

    Lock comment

    Enter the Lock comment that will be associated with this data area lock.

    Note: This is only required if “Lock this data area” is enabled.
  3. In the Data Area table, complete the following fields for each dimension:
    Field Notes

    Symbols

    Type a symbol name. Alternatively, you can use the symbol selector.

    To add more than one symbol for a dimension, select a row containing the dimension for which you want to add another symbol and click Symbol.

    To move a symbol up or down within a dimension, click Move Up or Move Down.

    Note: To use the symbol selected by the user or defined by an attribute, enter the name of the dimension as a variable, for example $ENTITIES$

    Spec

    Indicate the symbol specification using one of the following values:

    • All: Includes all symbols within the selected symbol’s hierarchy.
    • Leaf: Includes only leaf symbols within the selected symbol’s hierarchy.
    • Parent: Includes only parent symbols within the selected symbol’s hierarchy.
    • Root and Parent: Includes only root and parent symbols within the selected symbol’s hierarchy.

    Note: To use the symbol selected by the user or defined by an attribute, enter the name of the dimension as a variable, for example $ENTITIES$

    Level

    Specify the number of levels down from the symbol to be included in the data area.

  4. Use Additional Configuration to specify any other Data Area Definition features you wish to use. Additional Configuration is a code editor that allows you to enter data area definition functions to be included in the data area.

    For more information on the code editor, see Using the code editor.

    Typical use of Additional Configuration in a data area definition would be to

    1. Add an attribute filter using the AttributeFilter function
    2. Add a schedule to the using the Schedule function
    3. Add a temporary symbol using the TempSym function
    4. Override the query type specified in Settings using the AdjustedDetail function.

Specifying the data area views

Use data area views to specify how the data areas will be displayed to the user. For each data area view to be created, right-click on Data Area Views and select New Document.

Note: If using a Single Layout type for your data view, only one Data Area View can be defined.

Name

Specify the name of the data area view

Setting view orientation

Use orientation to determine how each dimension is presented to the user. At least one dimension must be in the rows and columns orientation. Multiple dimensions in rows or columns are nested outer to inner, based on their left to right position.

Use the following table to determine the way dimensions display in the view.

Orientation View Appearance

Columns or rows

The left-most dimension listed in the orientation section is the outermost dimension in the view.

Slice

Each dimension in the slice dimension is presented to the user as a symbol selector. Dimensions are presented in the view in the order that they appear in the Slice orientation.

Fixed

The view opens displaying fixed symbols in dimension order on the Fixed Symbols tab.

Dimensions appear on the Fixed Symbols tab in their natural order regardless of the order listed in the Fixed orientation.

To modify dimension orientation:

  1. In the Orientation section for the dimension you want to reorient, select the dimension.
  2. Drag and drop the selected dimension into the desired position.

Specifying symbols

Use symbol selection to specify the symbols that are displayed in the view. In the Symbol Selection table, complete the following fields for each dimension:

Note: You can copy the symbol selections from a particular Data Area Definition into the Symbol Selection table by selecting the Data Area Definition in the from drop list and clicking the Copy Default Selections button. For dimensions set as fixed in the orientation, the first symbol specified in the data area will be copied into the selections. The Spec and Level fields are not applicable if a symbol contains a variable.

Field Notes

Symbol

Type a symbol name. Alternatively, you can use the symbol selector. If you specified a data area definition for the view, symbol selections are limited by the it.

To add more than one symbol for a dimension, select a row containing the dimension for which you want to add another symbol and click Symbol.

To move a symbol up or down within a dimension, click Move Up or Move Down.

Note: To use the symbol selected by the user or defined by an attribute, enter the name of the dimension as a variable, for example $ENTITIES$

Spec

Indicate the symbol specification using one of the following values:

  • All — Includes all symbols within the selected symbol’s hierarchy.
  • Leaf — Includes only leaf symbols within the selected symbol’s hierarchy.
  • Parent — Includes only parent symbols within the selected symbol’s hierarchy.
  • Root and Parent — Includes only root and parent symbols within the selected symbol’s hierarchy.

Level

Specify the number of levels down from the symbol to be included in the data area.

Levels to expand

For dimensions in the rows and column orientation only, you can specify the number of levels to expand the hierarchy of each symbol included.

Specifying dimension display settings

Use dimension display settings to specify how symbols are displayed in the view.

In the Dimension Display Settings table, complete the following fields for each dimension:

Note: Show Name and Show Description only affect dimensions in the Rows or Columns orientation.

Field Notes

Show name

Check this to display the name of the symbol in the view. If both Show Name and Show Description are selected the symbol name and description will be displayed separated by a hyphen for symbols in the dimension.

Show description

Check this to display the description of the symbol in the view. If both Show Name and Show Description are selected the symbol name and description will be displayed separated by a hyphen for symbols in the dimension.

Fit to tile

Check this to make the view auto-size to fit symbol titles. For Rows this affects the width of the title. For Columns this can only be selected for the inner dimension and affects the width of the column.

Column width

If Fit to Title is not selected, enter the width in pixels.

Wrap

If Fit to Title is not selected, check this to wrap titles onto new lines if the text does not fit in the specified width.

Specifying number formatting

Use Number Formatting to specify how numbers are displayed in the view. In the Number Formatting table complete the following fields:

Field Notes

Default decimals

Enter the number of decimals to display for each numeric value. Generally, this should be from 0 to 9. This can be overridden for a specific symbol using the SymbolDecimals function in the Additional Configuration section.

Use parentheses for negative numbers

Select Yes to display negative numbers with parentheses.

Select No to display negative numbers with a negative sign.

Use thousands separator for numbers

Select Yes to display a locale-specific thousands separator based on the operating system setting.

Select No to not display a thousand separator.

Specifying the left title

Use Left Title to optionally specify the left title that appears in the view.

Field Notes

Left title

Enter text to display in the left title area of the view. This is optional and can be left blank.

Include entity in title

Check this to include the entity in the left title area of the view. Entities can only be included in the title under one of the following conditions.

  • Entities must be a dimension specified as a user selection and that selection must not allow multiple selections, or
  • Entities must be a dimension specified as an attribute-based selection and the source dimension (SYMBOL class) must not allow multiple selections, or
  • A variable must be created as the name of the dimension with a type STRING. This can be done in the Pre or Post Selection sections of the DVI.

Include currency in title

Check this to include the currency in the left title area of the view. Currencies can only be included in the title under one of the following conditions.

  • Currencies must be a dimension specified as a user selection and that selection must not allow multiple selections, or
  • Currencies must be a dimension specified as an attribute-based selection and the source dimension (SYMBOL class) must not allow multiple selections, or
  • A variable must be created as the name of the dimension with a type STRING. This can be done in the Pre or Post Selection sections of the DVI.

Include time period in title

Check this to include the time period in the left title area of the view. Time Periods can only be included in the title under one of the following conditions.

  • Time Periods must be a dimension specified as a user selection and that selection must not allow multiple selections, or
  • Time Periods must be a dimension specified as an attribute-based selection and the source dimension (SYMBOL class) must not allow multiple selections, or
  • A variable must be created as the name of the dimension with a type STRING. This can be done in the Pre or Post Selection sections of the DVI.

Specifying options

Use Options to specify additional view settings. In the Options table complete the following fields:

Field Notes

Allow user to change selections in view

Select Yes to allow the user to change selections once the view is displayed. This allows the user to update the user selections without closing the app and re-opening it.

Note: Select No if no user selections are defined in the app.

Allow dynamic rollup of input

Select Yes to have parent totals automatically calculated as the user enters numeric values.

Use on demand calculations

Select Yes to allow the user to run on demand calculations. An additional icon Calculate will be added to the toolbar to allow the user to perform the calculation(s) set to run on demand.

Dynamic Calculations

Select calculations to be performed as the user manually changes values in the view. The selections available are determined by the contents of the Calculations folder.

Note: Calculations are executed in the order listed.

Use on demand validations

If validations are defined for the input app, select Yes to display a toolbar icon to allow the user to run validations on demand. Validations are still executed on save regardless of this setting.

Selecting tools

Use Tools to enable the use of input tools within the view. See Input tools for information on the input tools. In the Tools table complete the following fields:

Field Notes

Allow use of adjust values tool

Select Yes to allow the user to right-click on a leaf cell to invoke the adjust values tool.

Allow use of copy across tool

Select Yes to allow the user to right-click on a leaf cell to copy the value across to all other leaf cells under the root in the view.

Allow use of pattern spread tool

Select Yes to allow the user to right-click on a parent cell and use the pattern spread tool to populate all leaf cells under the parent using a pattern.

Allow use of quick input tool

Select Yes to allow the user to right-click on a parent cell and use the quick input tool to populate all leaf cells under the parent.

Allow use of quick spread tool

Select Yes to allow the user to right-click on a parent cell and use the quick spread tool to populate all leaf cells under the parent using a trend.

Allow use of import

Select Yes to allow the user to import data from a file. The file to be imported must specify the symbol in each dimension and the value. The user will be able to clear all data in the view and select the field delimiter used in the file.

Allow use show underlying adjustments

Select Yes to allow the user to access underlying adjustments via the cell context menu. Any adjustments impacted the selected cell will be displayed in the Show Adjustments table

Allow use show audit trail

Select Yes to allow the user to access audit trail via the cell context menu. Any data changes impacting the selected cell will be displayed in the Show Audit Trail table.

Allow use show underlying comments

Select Yes to allow the user to access underlying comments via the cell context menu and toolbar. Any comments related to the selected cell will be displayed in the Show Comments table.

If executed from the toolbar, all comments related to the entire data area will be displayed in the Show Comments table.

Customizing the data view

Use Additional Configuration to specify any other view features you wish to use in the data view. Additional Configuration is a code editor that allows you to enter view functions to be included in the configuration of the view.

For more information on the code editor, see Using the code editor.

Typical use of Additional Configuration in this app would be to

  • Add protected areas to the view using the Protect function
  • Add conditional style to the view using the ConditionalStyle function
  • Restrict input to numeric values or text values using the NumericInputOnly and/ or TextInputOnly functions
  • Hiding specific symbols in the view using the Hide function
  • Overriding the decimals displayed for certain symbols using the SymbolDecimals function
  • Adding separators between symbols using the InsertSeparator function.

Specifying view actions

Use Actions to specify custom toolbar and context menu actions with a view. For each action to be created, right-click on Actions and select New Document.

For each action complete the following fields:

Field Notes

Name

Enter the name of the action.

Action location

Select whether the action will appear in the toolbar or on the cell context menu.

Views to add action to

Select the data area views to assign the action to.

Action text

Enter text to display for the action. For a toolbar location, the text will appear to the right of the icon, if specified. For a context menu this will be the menu text.

Note: This is required for a context action, but is only required for a toolbar action, if an icon is not specified.

Action icon

Enter the path to the icon to display for the action

Note: This is optional for a context action but is required for a toolbar if action text is not specified.

Action tooltip text

Enter additional information that will appear when the user hovers the mouse on the action. This is optional.

Cell restriction expression

Enter an expression to limit the cells the context menu appears on. This is optional and only applied when the action location is Cell. You can use Not, And, and Or in conjunction with PARENT, LEAF, STATIC, WRITABLE, and READONLY.

For more information on the expression, see Action in the Longview Developer’s Guide.

Action

Enter the commands to execute for this action via the code editor.

For more information on the code editor, see Using the code editor.

Specifying tabs

Use Tabs to add tabs to the data grid. Each tab can display a different data area view. For each Tab to be created, right-click on Tabs and select Add Tab.

Note: Tabs are only required if using a Tabbed Layout Type. For more information, see Specifying overall settings.

Field Notes

Data area

Select the data area definition to be used with this tab.

Data view name

Select the data area view to be used with this tab.

Tab name

Use this to provide a label to display on the tab

Action to run when switching to this tab

Select the command to execute when this tab is switched to by the user. The selections available are determined by the contents of the Tab Commands folder. This parameter is optional.

Note: If this is the first tab this command will be executed when the view first appears.

Action to run when switching from this tab

Select the command to execute when this tab is switched from by the user. The selections available are determined by the contents of the Tab Commands folder. This parameter is optional.

Background color

Use this to select the background color for the tab. The default color is transparent.

Specifying post-refresh commands

Use Post-Refresh to perform any commands after the data areas are downloaded but before any refresh calculations are performed. Use Post-Refresh to perform any processing that requires data to be downloaded into the data areas.

Note: Post-refresh commands are executed prior to any calculations with the “Run calculation when data is refreshed” option.

Specifying a tab action

Use Tab Actions to define commands and functions to be executed when switching between tabs in a tabbed view.

For more information on the code editor, see Using the code editor.

Specifying calculations

Use calculations to create models that are executed as part of the input app. Each model can be executed at various points in the app and is executed in the order listed in the Calculations folder. Use the calculation code block to specify the calculations using the code editor.

For more information on using the code editor, see Using the code editor.

For each model specify the run properties:

Field Notes

Data areas to run calculation on

Select the data area definitions to which this calculation applies.

Run calculation when data is refreshed

Check this to cause the calculation to occur when data is downloaded initially and whenever the user clicks Refresh.

Prompt for submit on close

If run calculation when data is refresh is enabled, check this option to indicate that the values calculated will be treated as data changes and submitted to the database. The user will be prompted to submit changes when the view is closed even if no other changes were made.

Run calculation after user imports data

Check this to cause the calculation to occur after the user imports data via the import tool.

Note: Allow use of import tool must be enabled.

Run calculations after user uses an input tool

Check this to cause the calculation to occur after the user enters data using an input tool.

Note: At least one input tool must be enabled.

Run calculation before data is submitted

Check this to cause the calculation to occur when the user clicks Submit, but before the data is uploaded.

Note: This calculation will only be executed if other data has been changed in prior to submission.

Run calculation after data is submitted

Check this to cause the calculation to occur when the user clicks Submit, but after the data is uploaded. This is mostly useful when the calculation before submitting changes the data in ways that are confusing to a user remaining in the app, for example clearing data that should not be submitted.

Run calculation on demand

Check this to cause the calculation to occur when the user clicks Calculate.

Specifying data validations

Use Validations to specify data validations to perform when the user clicks the submit or validate icon. Validation failures can be specified as errors or warnings. Errors will prevent the user from submitting data, while warnings will inform the user of validation failures, but still allow the user to proceed with submitting data.

Note: For the Data View Input app there is a single validation procedure for all data views. Be sure to reference the correct data area name in any validation functions.

Field Notes

Validation dimensions

Use this to specify dimensions to include in validation results. This is normally used in cases where slice dimensions are used in the view to give the user better feedback as to where the data validation failure occurred.

Repeat for each validation:

  1. Create a variable to store the validation result.

    Note: You can use the same result variable for each validation.

  2. Write an expression to determine the validation result. Store the result in the variable created in step 1.
  3. Write a condition to check the validation result against the expected result.
  4. If the validation result does not pass the check, Set the VALD_Result variable and run procedure VALD\AddResult.lvpro to add the validation failure result to the list of validation failures.

    Note: You can type in Template_Validation into the validation area in your Data View Input app to get the sample syntax code below.

Example:

Create VARIABLE val as NUM

Set VARIABLE val = Value("daMain", "BS", "$TIMEPERIODS$", "$ENTITIES$", "GL", "SCENARIOS_Working", "$CURRENCIES$")

If $val$ != 0

    Set VARIABLE VALD_Result = "ERROR|Balance sheet is out of balance|$val$"    

    Run PROCEDURE "VALD\AddResult.lvpro"

END If

Setting variable VALD_Result

The VALD_Result variable is a string list variable, set as follows (separate each item with a pipe character “|”):

  1. ERROR or WARNING to specify the validation failure level
  2. The validation failure message to display to the user
  3. The validation failure amount
  4. If validation dimensions are specified, the symbol for each dimension

Specifying forms

Use Forms to capture user input:

  1. In an action within an input template
  2. During post-selection in an app

For each form complete the following fields:

Field Notes

Name

Enter the name of the form.

Title

Enter the title for the form. This is optional. If left blank the title of the form will be the same as the description of the app.

Width (in pixels)

Enter the width of the form. If not specified, the default width of 450 is used.

Height (in pixels)

Enter the height of the form. If not specified, the height is determined by the number of controls in the form.

Format for the date value returned

Enter the format a date is stored in an application framework variable when returned from a form. The format in the form is determined by the user’s regional settings.

Form controls

Add the controls to be displayed in the form via the code editor. For more information on the code editor, see Using the code editor.

Specifying instructions

Use Instructions to specify instructions to be displayed in the instructions tab in the view. Instructions are specified using HTML. A general layout for instructions is provided. For each instruction page to be created, right-click on Instructions and select New Document.

  1. Add list items <li> to the Data Entry list to specify data entry instructions.
  2. Add list items <li> to the Note list to specify any notes related to the input.
  3. Modify the Comments section as required to remove any features not used in the app.
For an optimal Community experience, Please view on Desktop