  |
GoFiler Legato Script Reference
Legato v 1.5d Application v 5.25a
|
| Table of Contents | < < Previous | Next >> |
Appendix E — Application Parameter Names
Introduction
Overview
Scope
This document describes various application named parameters (environmental variables) available within GoFiler projects. Not all parameters are available in all products.
Parameters can be used by Legato or within templates and other sections of the program to access data. The main purpose of Application Parameters is to allow easy access of data from any module without have any intimate knowledge of location of the data or how it is managed.
For certain activities, such as Legato programming, there may be specific module SDK function that provide a much greater level of control than that provided here.
Use
Parameters can be access and changed on a module by module basis. Many of the parameter names employ a prefix to filter the serving module. For example, ‘ProjectInfo’ leads all project information items. Parameter names can also be formatted depending on the module. If a complex name is used, in most cases it will appear as follows:
Name:Qualifier
Where:
Name — Is the parameter name
Qualifier — Provides addition data such as a filename or index.
Depending on the environment, errors can be captured with respect to the success of reading or writing a parameter. For certain activities such as proof templates, failure to retrieve data is simple indicated by an empty result.
Read and Write
Some fields are read or write only. The type is designated as ‘RO’ or ‘WO’ if it is read or write only.
Projects and Project Module
General Project Information
Notes
Accesses or modifies project properties. In most cases a project must be open to access these items.
Parameter Names
| Project-Filename | RO | Name of the project with path. | |
| Project-Name | — | Project name, user definable and accessible. | |
| Project-Description | — | Project description, user definable and accessible. | |
| Project-Application | — | Project application. This is presently not on the user interface. | |
| Project-Matter | — | Project matter or job number, user definable and accessible. | |
| Project-Client-Name | — | Project client name, user definable and accessible. | |
| Project-Client-ID | — | Project client id, user definable and accessible. | |
| Project-Agent-Name | — | Project agent name, user definable and accessible. | |
| Project-Manager | — | Project manager name, user definable and accessible. | |
| Project-Revision | — | Project revision, user definable and accessible. | |
| Project-Comments | — | Project general comments, user definable and accessible. |
Project Entry Information
Notes
Project entry names are expected to qualifier as the entry name or filename. The filename can be fully qualified path or simple match the entry name.
Parameter Names
| Project-Entry-Type | RO | Project entry type or document type. | |
| Project-Entry-Description | RO | Description of the entry. | |
| Project-Entry-Comment | RO | Comments associated with the entry. | |
| Project-Entry-Edit-Status | RO | Edit status for entry. |
Project Info/Keywords
Notes
Accesses or modifies project information. A project must be open to access these items. Project Info prefix items allow for the storage and retrieval of any information in a user name space. The application uses certain names for certain activities.
When setting a parameter, any data set with the prefix ‘ProjectInfo’ will be added or updated. Use caution on spelling and not to interfere with defined application data.
Parameter Names
| ProjectInfoLastModified | RO | Date and time of latest project entry modified. | |
| ProjectInfoSelectList | RO | Returns a list of selected files by name. Entries in the list are delimited with vertical bars ‘|’. | |
| ProjectInfoLock | — | Collaboration lock information. | |
| ProjectInfoTasknnnn | — | Collaboration task information. The items are numbered serially. | |
| ProjectInfoAlertnnnn | — | Collaboration notify information. The items are numbered serially. |
Tools and Help
Help Resources
Notes
These value are generally set by the application during the initialization sequence. They can also be changed by other processes. The values are used as a reference for various functions.
These values only apply to applications that have the Tools module installed.
URIs may be located on the web or local to the machine.
Parameter Names
| HelpSupportURI | — | Location of support/technical service home page. | |
| HelpTutorialURI | — | Location of tutorial home page. | |
| HelpReportURI | — | Problem report URI home page. | |
| HelpWelcomeURI | — | Location of application first run welcome page. | |
| HelpRSSFeedURI | — | Location of RSS/Atom news feed file. | |
| HelpSystemURI | — | Location of application help system or index page. | |
| HelpSDKHelpURI | — | Location of Legato help system or index page. | |
| HelpUpdaterURI | — | Location of application update page. |
| Table of Contents | < < Previous | Next >> |
© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.