Creating free form apps
You can use Longview Designer to create free form apps.
Specifying properties
You can use Longview Designer to specify properties for a new free form app.
For more information, see “Specifying properties.”
Specifying troubleshooting settings
You can use troubleshooting settings and tools to track down issues in a free form app.
For more information see "Setting troubleshooting options".
Specifying the execute procedure
You can use Longview Designer to specify the execute procedure for your free form app. The Execute procedure uses commands to control the flow of the free form app.
Specifying Calculated Journal Entry Specs
A Calculated Journal Entry Spec (.lvcje) is an ASCII file that specifies information about a calculated journal entry such as the journal entry type and description, as well as a line of detail for each adjustment that the calculated journal entry contains.
For more information, see “Developing Longview CalculatedJESpecs” in the Longview Developer’s Guide.
For more information on using the code editor, see “Using the code editor”.
Specifying Data Area Definitions
Use Data Area Definitions to create a dataspec document (.lvdsp) used to define an area in the database. For each data area definition to be created, right-click on Data Area Definitions and select New Document.
Note: If you would like to use a code editor instead of a UI to create the Data Area Definition, see “Specifying Data Area Definitions – Script".
- For the Name, enter the name of your Data Area
- In the Options table, complete the following field
Field Description Data Type Specify the data to be queried using one of the following options:
- ADJUSTED—Indicates that data queries include adjustments made via journal entries
- UNADJUSTED—Indicates that data queries exclude adjustments made via journal entries
Default is ADJUSTED
- In the Data Area table, complete the following fields for each dimension:
Note: The Spec and Level fields are not applicable if a symbol contains a variable.
Field
Description
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.
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.
- 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
- Add an attribute filter using the AttributeFilter function
- Add a schedule to the using the Schedule function
- Add a temporary symbol using the TempSym function
Specifying Data Area Definitions - Script
Data Area Definitions - Script allows you to create a DataSpec document (.lvdsp) using a code editor. This defines an area in the database.
For more information, see “Developing Longview DataSpecs” in the Longview Developer’s Guide.
For more information on using the code editor, see “Using the code editor”.
Note: If you would like to use a UI instead of a code editor to create the Data Area Definition, see “Specifying Data Area Definitions”.
Specifying Data Area Views
Use Data Area Views to create a data view document (.lvdvw) used 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 you would like to use a code editor instead of a UI to create the Data Area Views, see “Specifying Data Area Views - Script”.
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.
Dimension 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:
- In the Orientation section for the dimension, you want to reorient, select the dimension.
- 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: The Spec and Level fields are not applicable if a symbol contains a variable.
Field | Description |
---|---|
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. |
Spec | Indicate the symbol specification using one of the following values:
|
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 | Description |
---|---|
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 Title | 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 | Description |
---|---|
Default decimals | Enter the number of decimals to display for each numeric value. 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 options
Use Options to specify additional view settings.
In the Options table complete the following fields:
Field | Description |
---|---|
Allow dynamic rollup of input | Select Yes to have parent totals automatically calculated as the user enters numeric values. |
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 dynamic calculations to the view using the DynamicModel function
- 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 Data Area Views - Script
Data Area Views - Script allows you to create a Data View document (.lvdsp) using a code editor. A Data View document defines the way in which the data area is rendered as a Data Grid.
For more information, see “Designing Longview Data Grids” in the Longview Developer’s Guide.
For more information on using the code editor, see “Using the code editor.”
Note: If you would like to use a UI instead of a code editor to create the Data Area Views, see “Specifying Data Area Views.”
Specifying Data Area Export Specs
Data area export specs (.lvexp) can be run from a procedure to export data to a file. The target file may contain a single column of values or multiple columns of values.
Note: If you would like to use a code editor instead of a UI to create the Data Area Export Spec, see “Specifying Export Specs – Script.”
To create a data area export spec:
- Right click on one of the Data Area Export Specs folders and select New Document.
- For the Name, enter the name of your Export Spec.
- Fill in the data target
- In the File Options table, complete the following fields:
Field Description Target File
Specify the path and name of the data target.
Field Delimiter
Specify whether the character used to separate fields in the data source is the brace ( { ), comma ( , ), semicolon ( ; ), pipe ( | ), or regional delimiter for comma separated values (Regional). Alternatively, you can type a field delimiter of your choice.
The default is the regional delimiter for comma separated values.
- For a multiple value, file-based export: in the Values Dimension table complete the following field:
Field Description Dimension corresponding to values
Specify the dimension for which there are multiple value fields.
- The Dimension Definitions section is used to specify how each dimension is processed during export. For Dimension Definitions, complete the following:
- Schedule: This field displays only if your system is configured to use schedules and you have access to schedules.
- The default of None indicates the export spec is for base data only.
- Specify the schedule to use for the import spec, and the schedule dimensions appear at the bottom of the list of Dimensions.
- For each dimension, complete the following fields:
Field Description Dimension
The name of the dimension.
Type
Specify the type of relationship between dimension symbols and field values in the data source using one of the following values:
- Map—The dimension symbols are mapped to values as specified in the indicated map
- Match—The dimension symbols are written out with their names.
- Unique—Values for the symbol specified are exported, but the symbol name is not written in the target file.
Note: For a multiple values export spec, the dimension you indicated has Values for the Type field and cannot be changed.
Field Position
This field is available only when Type is Map or Match.
Specify the field position to assign the dimension to using a positive integer. For example, for the Accounts dimension, type 3 if the account will be the third column of the data target.
Symbol
This field is available only when Type is Unique. Type the symbol name for the specified dimension to which the data is imported. Alternatively, you can use the symbol selector.
Note: You can also use a variable to define the symbol
Map Location
This field is available only when Type is Map. Indicate the location of the map using one of the following values:
- Internal—Indicates the map exists inside the database, created using the Mappings editor. For more information, see “Maintaining mappings.”
- External—Indicates the map exists as a file, such as a text file on your local machine or network location.
- Document—Indicates the map exists as a document within the Symbol Maps folder of the app.
Map
This field is available only when Type is Map. Do one of the following:
- If you selected Internal as the Map Location, select a map from the list of available maps in the system.
- If you selected External as the Map Location, type the path of the external map, or click the ellipsis button ( ... ) to select the external map.
- If you selected Document as the Map Location, select a map from the list of available maps in the app.
Note: You can use a variable for the Mao field if the map location is Internal or External
- Schedule: This field displays only if your system is configured to use schedules and you have access to schedules.
- For a single value, file-based export: in the Value Field table complete the following field:
Field Description Value Field Number
Specify the field position at which the data value will be written using a number.
- If the data target contains multiple value fields, the Value Fields section is available. Complete the following fields:
Field Description Field Position
Specify the field position of the value field using a positive integer, where the field position is the corresponding column in the data source containing the data. For example, if the value is exported to the third column in the target file, type 3.
Symbol
Type the name of a symbol from the dimension indicated in Multiple Value Fields for Dimension for the value in the corresponding field position. Alternatively, you can use the symbol selector.
Note: You can use a variable for the Symbol field.
Note: You can delete a value field by selecting a value field row and clicking Delete.
- In the Data Options table, complete the following fields:
Field Description Reverse value for credit accounts
Select this option to reverse the sign for numeric values for accounts with Credit as the Balance Type.
For more information on the balance type in the ACCOUNTS dimension, see “Working with dimensions” in the Longview Application Administrator Guide.
The default is No.
Decimal character
Specify the decimal character for the data import app using one of the following values:
- “ . ”—The period is the decimal character.
- “ , ”—The comma is the decimal character.
- “Regional”—Use the regional character for the decimal.
The default is the regional character for decimal.
Allow duplicate mappings
This option applies only when at least one dimension Type is Map.
Select this option to indicate that duplicate mappings are permitted. If multiple mappings are found, the system does the following for each type of mapping:
- Exact—All duplicate Exact mappings are used so that the same value is imported to multiple data cells. If there are duplicate Exact and Wildcard or Range mappings, the Exact mapping is used, and the Wildcard or Range mapping is ignored.
- Wildcard—If no Exact mappings are found, the value is imported to the first Wildcard or Range mapping listed.
- Range—If no Exact mappings are found, the value is imported to the first Wildcard or Range mapping listed.
If you do not select this option, duplicate mappings are not permitted. If multiple mappings are found, the system reports an error for each mapping.
The default is No.
Handling for duplicate records
Specify the way duplicate records are handled for the data import app using one of the following values:
- Output all—Specifies that each duplicate record will be written to the target file.
- Error—Specifies that duplicate records should not be allowed. The first entry is submitted. If a duplicate record is encountered, the system reports an error.
- Sum values—Specifies that duplicate records should be allowed and the value of all such records summed. If a duplicate record is encountered that contains text (versus numeric) data, it is treated as an invalid/error record.
The default is Error.
Number of errors before processing stops
Specify the maximum number of error records to permit before stopping the import process.
The default is 0.
Header option
Specify whether to create a header in the target file, using one the following values:
- None—Specifies that no header will be created and the first record in the file is a data record.
- Auto—Specifies that a single header record is created in the target file. The header will contain the description of the dimension for each field that is a dimension, and
- "Value” for the value field in a single value export.
- The description of each symbol in a multiple value export.
- Custom—Specifies that the header records will be manually entered in the Custom header field.
Custom header
When the header option is set to Custom, enter the header records in the form: “header record,” “...”, “header record.” Each header record is output on a new line in the target file.
- You can optionally specify filters to apply when exporting data. For each filter type an expression using the following guidelines:
- The expression can be joined together by two or more expressions using AND or OR grouped by brackets, as appropriate.
- Each expression uses field names, operators, and values as follows: FieldName EQ|NE|LE|LT|GE|GT Value. If Value is a string, enclose the string in double quotation marks. • You can optionally include wildcard characters (? and *) and symbols for Value.
Note: In this case do not enclose Value in double quotation marks.
- You can optionally use symbols for operators, such as ==, !=, <=, <, >=, and >.
- You must use Field# for FieldName to refer to a specific field on which you want to filter. For example, if Products is the fourth column in your target file and you want to filter Products to import only the Products_Default symbol, use Field4 == "Products_Default" as the expression.
Note: For more information on creating expressions, see “Using conditional operators” and “Search” in the Longview Developer’s Guide.
Specifying Export Specs - Script
An Export Spec (.lvexp) is used to export data to an external file.
For more information, see “Developing Longview ImportSpecs, ExportSpecs, and external Maps” in the Longview Developer’s Guide.
For more information on using the code editor, see “Using the code editor.”
Note: If you would like to use a UI instead of a code editor to create the Export Spec, see “Specifying Data Area Export Specs".
Specifying Forms
A Form (.lvfrm) defines the layout, format, and controls to display forms for user input.
For more information, see “Designing Longview Forms” in the Longview Developer’s Guide.
For more information on using the code editor, see “Using the code editor.”
Specifying HTML Documents
HTML files can be used to create any custom HTML pages, input forms or instructions for users.
For more information, see “Designing HTML pages” in the Longview Developer’s Guide.
Specifying Data Area Import Specs
Data area import specs (.lvimp) can be run from a procedure to import data to a data area. The source data may be contained in an external file, or a query run via an ODBC connection. The source data may contain a single column of values or multiple columns of values.
Note: If you would like to use a code editor instead of a UI to create the Data Area Import Spec, see “Specifying Import Specs - Script”
To create a data area import spec:
- Right click on one of the Data Area Import Specs folders and select New Document.
- For the Name, enter the name of your Import Spec.
- Fill in the data source.
- For a single value, file-based import: in the File Options table, complete the following fields:
Field Description Source file
Specify the path and name of the data source.
Field delimiter
Specify whether the character used to separate fields in the data source is the brace ( { ), comma ( , ), semicolon ( ; ), pipe ( | ), or regional delimiter for comma separated values ( , (regional) ). Alternatively, you can type a field delimiter of your choice.
The default is the regional delimiter for comma separated values ( , (regional) ).
Number of header records to filter
Specify the number of header rows to filter on import. If you leave the value as the default value of 0, the system assumes your data source starts with data records with no header rows.
Number of footer records to filter
Specify the number of footer rows to filter on import. If you leave the value as the default value of 0, the system assumes your data source ends with data records with no footer rows.
- For a single and multiple value, ODBC-based import, in the ODBC Parameters table, complete the following fields:
Field Description ODBC connection string
Specify the connect string required to connect to the ODBC source.
SQL query specification
Select the document that contains the SQL query to execute.
SQL query batch size
Enter the number of records that should be returned in the query batch.
Default is 1000.
- For a single value, file-based import: in the File Options table, complete the following fields:
- For a multiple value, file-based import, and ODBC-based import: in the Values Dimension table, complete the following fields:
Field Description Dimension corresponding to values
Specify the dimension for which there are multiple value fields.
- The Dimension Definitions section is used to specify how each dimension is processed during import. For Dimension Definitions, complete the following:
- Schedule: This field displays only if your system is configured to use schedules and you have access to schedules.
- The default of None indicates the import spec is for base data only.
- Specify the schedule to use for the import spec, and the schedule dimensions appear at the bottom of the list of Dimensions.
- For each dimension, complete the following fields:
Field Description Dimension
The name of the dimension.
Type
Specify the type of relationship between dimension symbols and field values in the data source using one of the following values:
- Consecutive—The values encountered in the data source are placed consecutively in the dimension starting at the indicated symbol, moving in priority order through the indicated symbol’s siblings.
Note: Consecutive is designed to work with a symbol existing in only one hierarchy. If the symbol belongs to more than one hierarchy, the behavior used to determine the siblings is undefined and may be affected by hierarchy reorganizations and imports/exports. You can specify only one dimension as Consecutive.
- Map—The values encountered in the data source are mapped to dimension symbols as specified in the indicated map.
- Match—The values encountered in the data source are matched to the dimension symbols exactly.
- Unique—All values encountered in the data source are placed in the specified dimension symbol. If you select this option, you can use the variables you defined on the Variables page for the specified symbol.
Note: For a multiple value import spec, the dimension you indicated has Values for the Type field and cannot be changed.
Field Position
This field is available only when Type is Map or Match.
Specify the field position corresponding to the dimension using a positive integer. For example, for the Accounts dimension, type 3 if the account is in the third column of the data source.
Symbol
This field is available only when Type is Consecutive or Unique.
Type the symbol name for the specified dimension to which the data is imported. Alternatively, you can use the symbol selector.
Note: You can also use a variable to define the symbol.
Map Location
This field is available only when Type is Map.
Indicate the location of the map using one of the following values:
- Document—Indicates the map exists as a document within the Symbol Maps folder of the app.
- Internal—Indicates the map exists inside the database, created using the Mappings editor. For more information, see "Maintaining mappings".
- External—Indicates the map exists as a file, such as a text file on your local machine or network location.
- Document—Indicates the map exists as a document within the Symbol Maps folder of the app.
Map
This field is available only when Type is Map.
Do one of the following:
- If you selected Internal as the Map Location, select a map from the list of available maps in the system.
- If you selected External as the Map Location, type the path of the external map, or click the ellipsis button ( ... ) to select the external map.
- If you selected Document as the Map Location, select a map from the list of available maps in the app.
Note: You can use a variable for the Map field if the map location is Internal or External.
- Consecutive—The values encountered in the data source are placed consecutively in the dimension starting at the indicated symbol, moving in priority order through the indicated symbol’s siblings.
- Schedule: This field displays only if your system is configured to use schedules and you have access to schedules.
- For a single value, file-based import, and ODBC-based import: in the Value Field table complete the following field:
Field Description Value Field Number
Specify the field position at which the data value will be written using a number.
- If the data source contains multiple value fields, the Value Fields section is available. Complete the following fields:
Field Description Field Position
Specify the field position of the value field using a positive integer, where the field position is the corresponding column in the data source containing the data. For example, if the value is in the third column in the import file, type 3.
Symbol
Type the name of a symbol from the dimension indicated in Multiple Value Fields for Dimension for the value in the corresponding field position. Alternatively, you can use the symbol selector. You can use a variable for the symbol field
Note: You can delete a value field by selecting a value field row and clicking Delete.
- In the Data Options table, complete the following fields:
Field Description Reverse value for credit accounts
Select this option to reverse the sign for numeric values for accounts with Credit as the Balance Type.
For more information on the balance type in the ACCOUNTS dimension, see “Working with dimensions” in the Longview Application Administrator Guide.
The default is cleared.
Decimal character
Specify the decimal character for the data import app using one of the following values:
- “ . ”—The period is the decimal character.
- “ , ”—The comma is the decimal character.
- “ . (regional) ”—Use the regional character for the decimal.
The default is the regional character for decimal “ . (regional) ”.
Allow duplicate mappings
This option applies only when at least one dimension Type is Map.
Select this option to indicate that duplicate mappings are permitted. If multiple mappings are found, the system does the following for each type of mapping:
- Exact—All duplicate Exact mappings are used so that the same value is imported to multiple data cells. If there are duplicate Exact and Wildcard or Range mappings, the Exact mapping is used, and the Wildcard or Range mapping is ignored.
- Wildcard—If no Exact mappings are found, the value is imported to the first Wildcard or Range mapping listed.
- Range—If no Exact mappings are found, the value is imported to the first Wildcard or Range mapping listed.
- If you do not select this option, duplicate mappings are not permitted. If multiple mappings are found, the system reports an error for each mapping.
The default is No.
Handling for duplicate records
Specify the way duplicate records are handled for the data import app using one of the following values:
- Error—Specifies that duplicate records should not be allowed. The first entry is submitted. If a duplicate record is encountered, the system reports an error.
- Sum values—Specifies that duplicate records should be allowed and the value of all such records summed. If a duplicate record is encountered that contains text (versus numeric) data, it is treated as an invalid/error record.
- Use first record—Specifies that the first entry of duplicate records should be used. If a duplicate record is encountered, the system does not report an error.
- Use last record—Specifies that the last entry of duplicate records should be used. If a duplicate record is encountered, the system does not report an error.
The default is Error
Number of errors before processing stops
Specify the maximum number of error records to permit before stopping the import process.
The default is 0.
- If the data source is a file, the Filters section is available. For each filter type an expression using the following guidelines:
- The expression can be joined together by two or more expressions using AND or OR grouped by brackets, as appropriate.
- Each expression uses field names, operators, and values as follows: FieldName EQ|NE|LE|LT|GE|GT Value. If Value is a string, enclose the string in double quotation marks.
- You can optionally include wildcard characters (? and *) and symbols for Value.
Note: In this case do not enclose Value in double quotation marks.
- You can optionally use symbols for operators, such as ==, !=, <=, <, >=, and >.
- You must use Field# for FieldName to refer to a specific field on which you want to filter. For example, if Products is the fourth column in your import file and you want to filter Products to import only the Products_Default symbol, use Field4 == "Products_Default" as the expression.
Note: For more information on creating expressions, see “Using conditional operators” and “Search” in the Longview Developer’s Guide.
Specifying Import Specs - Script
Import specs (.lvimp) can be run from a procedure and used to import data from an external file.
For more information, see “Developing Longview ImportSpecs, ExportSpecs, and external Maps” in the Longview Developer’s Guide.
For more information on using the code editor, see "Using the code editor".
Specifying Models
Models (.lvmod) support the logic and calculations for the Longview App.
For more information, see “Developing Longview Models” in the Longview Developer’s Guide.
For more information on using the code editor, see "Using the code editor".
Specifying Model Subroutines
Model Subroutines (.lvsub) can be used to avoid repeating common calculations in multiple Longview model documents. You can also create a subroutine when you have to create a complex calculation.
For more information, see “Subroutine Documents and Call function” in the Longview.
For more information on using the code editor, see "Using the code editor".
Specifying Procedures
Procedures (.lvpro) define a sequence of commands to perform activities.
For more information, see “Developing Longview Procedures” in the Longview Developer’s Guide.
For more information on using the code editor, see "Using the code editor".
Specifying Symbol Maps
Symbol Maps(.lvmap) specify instructions when the symbol names in your data source do not match the symbol names in your Longview database.
For more information, see “Developing Longview ImportSpecs, ExportSpecs, and external Maps” in the Longview Developer’s Guide.
For more information on using the code editor, see "Using the code editor".
Specifying Persistent Table Definitions
Persistent table definitions allow you to define the content from the persistent app table that is downloaded to the in-memory DataTable object.
For more information on this file, see “Defining DataTable objects” in the Longview Developer’s Guide.
For more information on using the code editor, see "Using the code editor".
Note: If you would like to use a code editor instead of a UI to create the Persistent Table Definition, see "Specifying Table Definitions - Script".
To create a table definition:
- Right click on Persistent Table Definition and select New Document.
- For the Name, enter the name of your Table Definition.
- In the columns section the table and columns are defined.
- For the table name, select the table to use. The list includes all app tables defined in the system.
- If you pick a table based on a view it will display an information icon indicating that the table will be read-only.
- After selecting a table, the columns in the table will be displayed. All columns will be selected by default. Also, the columns that define the primary key will be indicated with a key icon. If some or all the primary key columns are not included, the table will be read only.
- You may add or remove temporary columns using the Add Column and Remove Column buttons.
Note: Temporary columns are added to the table for use with an app but are not submitted to the database.
- For each column complete the following fields:
Field Description Include
Check each column to be included in the query. Use the check box in the header to select all columns.
Column
For persistent table columns, displays the name of the column. For temporary columns, enter the name of the column.
Nullable
Indicates whether the column can be saved with no value specified. If any non-nullable columns are excluded the table will be read-only.
Type
For persistent table columns, displays the data type of the column.
For temporary columns, select the data type for the column.
If you select Symbol[Dimension], you will be prompted to select the dimension that applies.
If you select Symbol[DimensionColumnName], you will be prompted to select a column (of type Dimension).
Values (String)
For String columns allows you to optionally define a list of values the user can select from.
Enter a | delimited list of values.
Optionally enter a | delimited list of display values by placing a semi-colon after the list of values.
Note: You can also use variables to define the list of values and display values.
Values (Symbol)
For Symbol columns allows you to limit the symbols available.
Enter a | delimited list of symbol specifications. You can also use a form to select the symbol specifications by clicking the search icon.
Note: You can also use a variable to define the list of symbol specifications
Values (User)
For User columns, allows you to limit the users available for selection.
Enter (or select) a | delimited list of user and group names.
Note: You can also use a variable to define the list of users and groups.
Values (UserList)
For UserList columns, allows you to limit the users available for selection.
Enter (or select) a | delimited list of user and group names.
Note: You can also use a variable to define the list of users and groups.
Allow Override
For String columns with Values defined, indicates whether the user can enter a value that is not in the list of values.
Min/Max (Date)
For date columns, allows you to set a valid range of selectable dates.
Note: The interface only supports explicit dates. To specify the valid date range using variables use the Additional Configuration section to define the date range using the SetColumn function.
Default (Boolean)
For Boolean columns, allows you to indicate if the default value for the column is checked.
Default (Dimension)
For Dimension columns, allows you to set he default dimension to be selected when a new row is added.
Default is no default selection.
- Use additional configuration to:
- Define sort order.
- Define any filters (SymbolFilter, UserFilter, or Where)
Specifying Virtual Table Definitions
Virtual table definitions allow you to define a table to be created as an in-memory DataTable object.
For more information on using the code editor, see "Using the code editor".
Note: If you would like to use a code editor instead of a UI to create the Virtual Table Definition, see Specifying Table Definitions – Script.
To create a table definition:
- Right click on Virtual Table Definition and select New Document.
- For the Name, enter the name of your Table Definition.
- In the columns section the table and columns are defined.
- You may add or remove columns using the Add Column and Remove Column buttons.
- For each column complete the following fields:
Field Description Include
Check each column to be included in the query. Use the check box in the header to select all columns.
Column
Enter the name of the column.
Nullable
Not selectable. Columns in a virtual table are nullable by default.
Type
Select the data type for the column.
If you select Symbol[Dimension], you will be prompted to select the dimension that applies.
If you select Symbol[DimensionColumnName], you will be prompted to select a column (of type Dimension).
Values (String)
For String columns allows you to optionally define a list of values the user can select from.
Enter a | delimited list of values.
Optionally enter a | delimited list of display values by placing a semi-colon after the list of values.
Note: You can also use variables to define the list of values and display values.
Values (Symbol)
For Symbol columns allows you to limit the symbols available.
Enter a | delimited list of symbol specifications. You can also use a form to select the symbol specifications by clicking the search icon.
Note: You can also use a variable to define the list of symbol specifications.
Values (User)
For User columns, allows you to limit the users available for selection.
Enter (or select) a | delimited list of user and group names.
Note: You can also use a variable to define the list of users and groups.
Values (UserList)
For UserList columns, allows you to limit the users available for selection.
Enter (or select) a | delimited list of user and group names.
Note: You can also use a variable to define the list of users and groups.
Allow Override
For String columns with Values defined, indicates whether the user can enter a value that is not in the list of values.
Min/Max (Date)
For date columns, allows you to set a valid range of selectable dates.
Note: The interface only supports explicit dates. To specify the valid date range using variables use the Additional Configuration section to define the date range using the SetColumn function.
Default (Boolean)
For Boolean columns, allows you to indicate if the default value for the column is checked.
Default (Dimension)
For Dimension columns, allows you to set he default dimension to be selected when a new row is added.
Default is no default selection.
- Use additional configuration to:
- Define sort order.
Specifying Table Definitions - Script
Table Definitions Script allows you to create a Table Definition document (.lvdtd) using a code editor. Table definitions allow you to define the content from the App table that is downloaded to the in-memory DataTable object.
For more information on this file, see “Defining DataTable objects” in the Longview Developer’s Guide.
For more information on using the code editor, see "Using the code editor".
Note: If you would like to use a UI instead of a code editor to create the Table Definition, see "Specifying Persistent Table Definitions" or "Specifying Virtual Table Definitions".
Specifying Table Views
Use Table Views to define the way in which a DataTable object is rendered as a Table. There is a separate folder for views based on persistent and virtual data tables. The only difference is the list of available table definitions in the Columns section.
Note: If you would like to use a code editor instead of a UI to create the Table View, see "Specifying Table Views - Script".
Fill in the table view sections:
- For the Columns, select the Table Definition that will be used with the view. The columns selected in the Data Table Definition appear in the table. For each column complete the following fields:
Field Description Include
Check each column to be included in the query. Use the check box in the header to select all columns.
Column
Displays the name of the column.
Type
Displays the data type of the column.
Description
Allows you to enter a description for the column to be displayed in the view
Width
Allows you to specify the width of the column in the view.
Protect
Check to protect the column from input.
Decimals (Number)
Allows you to specify the number of decimals displayed for numeric values.
Enabled Criteria
Allows you to specify criteria which allows the user to modify the value of the column in each row of the table.
- In the Parameters table, complete the following fields:
Field Desciption Default number of decimals for numeric values Specifies the number of decimals to display for numeric numbers (0-9).
Note: The number of decimals for a specific column can be overridden using the ColumnDecimals function in the View Column Settings section.
Default column width Specifies the width of each column in the view.
Note: The width for a specific column can be overridden using the ColumnWidth function in the View Column Settings section.
Apply users’ layout preferences Select Yes to allow the user’s modifications to the view to be saved and applied when the app is accessed. Select No to lock the settings of the initial view each time the app is accessed.
Note: The user can modify the view while using the app, but the next time it is executed the view will revert to the one saved in the app.
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. - In the Values Pane Options, complete the following fields
Field Description Enable values pane Select whether the user will be able to open the values pane within the view. Default is Yes. Values pane title Enter text to appear in the title area of the values pane. Default is Row Details
Hide values pane initially Select whether the values panel in initially hidden, if enabled. Default is Yes.
- Use Additional Configuration to further configure the 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 View Column Settings in this app would be to:
- Sort the rows in the view by one or more columns using the SortOrder function.
- Adding summary rows to the view using the SummaryRow function.
- Adding dynamic calculations to the table using the DynamicProcedure function.
- Adding a custom editor for a column using the EditProcedure function.
Specifying Table Views - Script
Table Views Script allows you to create a Table View document (.lvtvw) using a code editor. Table Views define the way in which a DataTable object is rendered as a Table.
For more information on this file, see “Creating Table View definition files” in the Longview Developer’s Guide.
For more information on using the code editor, see "Using the code editor".
Note: For persistent tables only, if you would like to use a UI instead of a code editor to create the Table View, see "Specifying Table Views".
Specifying UIs
UIs define the behavior and format of Apps.
For more information, see “Formatting Longview Apps” in the Longview Developer’s Guide.
For more information on using the code editor, see "Using the code editor".
Specifying Supporting Files
Supporting Files can be any additional files you require within the free form app. For example, supplemental text (.txt) files, or sql query files (.sql).