Create an app, event, or configuration library
You can create an app, event, or configuration library by:
- Starting with a template, or
- Duplicating an existing app
To create a new app, event, or configuration library from a template:
- Navigate to the Design module.
- Expand the folder that relates to the purpose of the app, event, or configuration library you which to create.
- Expand the folder of the specific type of app, event, or configuration library.
- Click New.
- A new tab appears with the properties page open.
To create a new app, event, or configuration library by duplicating an existing one:
- Navigate to the Design module.
- Expand the folder that relates to the purpose of the app you which to create.
- Expand the folder of the specific type of app, event, or configuration library.
- Expand the Existing folder under the specific type of app, event, or configuration library.
- Right-click on the item you wish to copy and select Duplicate.
- A new tab appears with the properties page open, containing all the settings and documents in the duplicated item.
To customize an out of box app, event, or configuration library
- Navigate to the Design module.
- Expand the folder that relates to the purpose of the app you which to create.
- Expand the folder of the specific type of app, event, or configuration library.
- Expand the Existing folder under the specific type of app, event, or configuration library.
- Click on the item you wish to customize. The item opens in a tab.
You will see a yellow message bar indicating that the item is read-only. - Click the Customize button in the toolbar and make any changes you require.
- When finished making changes, click Save.
Specifying properties
Properties are general information about the app, event, or configuration library. The name of an app is displayed in the app publisher interface and Longview Client’s navigation pane. The name of an event or configuration library is only referenced in configuration and generally should be kept short.
Theme and window size properties are only available for apps.
Property values for name, description, version, template name, and template version can be retrieved during the execution of an app using the GetAppConfig procedure function.
Field | Notes |
|---|---|
Name | Type a name for the app. The name must be unique and can have a maximum of 94 characters, including spaces. You cannot include the slash ( / ), backslash ( \ ), colon ( : ), ampersand (&), asterisk ( * ), question mark ( ? ), double quotation mark ( " ), the right-angle bracket ( > ), left angle bracket ( < ), pipe ( | ), or period ( . ) in the app name. |
Description | Type a description for the app. The description can have a maximum of 100 characters, including spaces. |
Version | Type a version to display in brackets after the description in the title bar for the data import app. The version can have a maximum of 100 characters, including spaces. This field is optional. |
Template version | Type a version to display in brackets after the description in the title bar for the data import app. The version can have a maximum of 100 characters, including spaces. This field is optional. |
Theme | Specify the look and feel of the app using one of the following values:
Note: Theme only applies when the app is launched outside of Longview Client. |
Window size | Select the window size of the data import app using one of the following options:
Note: Window Size only applies when the app is launched outside of Longview Client. |
Setting troubleshooting options
Troubleshooting settings are used to set optional output to help find and correct issues related to apps or events. Troubleshooting options are not available for configuration libraries, but the troubleshooting options of the app or event that uses the configuration library are applied.
Caution: Some troubleshooting options a have performance impact and it is important to only enable troubleshooting when absolutely required. Be sure apps are deployed to production systems with troubleshooting mode disabled.
Field | Notes |
|---|---|
Enable troubleshooting mode | Check this to enable troubleshooting mode. When disabled no troubleshooting occurs, so options can be left checked for future use. When enabled any error messages provide full detail, instead of just the description of the error. |
Re-use file for log and history | Check this to re-use the same history and log file name on subsequent execution of an app. This results in all files generated during execution to be written to the log path without the date-time sub-folder. The content of each file will only hold the content of the last execution of the app. This aids in using monitoring tools on files during development troubleshooting. Note: This setting applies to only Apps and does not impact events, even when selected. |
Enable troubleshooting messaging | Check this to enable troubleshooting specific messages to be displayed during execution. Trouble shooting messages must be configured in the app or event. |
Enable performance profiling | Check this to have a report of the execution performance output at the end of execution. You can use this output to identify where performance issues are occurring. For detailed information on the output, see “the Profile command in the Longview Developer’s Guide”. |
Enable detailed history logging | Check this to create a log containing all the commands executed. Caution: Detailed history logging has a large performance impact and should be used as required, and never enabled in a production system. |
Enable history timer | When detailed history logging is enabled, check this to output the execution time of each command recorded in the log. |