Report Author Attributes
The Report Author element has the following attributes:
Attribute | Description |
---|---|
Gallery File | (Required) Specifies the fully-qualified path and file name for the XML data Gallery file. This file contains the charts and tables that can be added when the New Visual component is dropped on the report canvas. The file is created using an Analysis Grid's "Add to Dashboard" feature, but a Dashboard is not required. The path must be within the application root folder. If Logi Security has been used to control access, the current user's name will be available in the @Function.UserName~ token. This can be embedded into this attribute to provide separate Gallery files for individual users. For example, the attribute value might be: @Function.AppPhysicalPath~\GalleryFiles\@Function.UserName~.xml which might translate to: C:\inetpub\wwwroot\MyReportApp\GalleryFiles\BGates.xml
Gallery files can also be stored in a database, see Bookmarks. |
ID | (Required) Specifies a unique element ID. |
Save File | (Required) Specifies the fully-qualified file path and name of an XML "Save" file where the report design changes users make at runtime are saved. Tokens may be used in this attribute, however, @Request tokens are not recommended as they're not persistent. If the file doesn't exist it will be created at first use; however any folder containing it will not be automatically created - you must create it manually. The path must be within the application root folder. Do not set this attribute when using the Auto Bookmark element in conjunction with Report Author. If Logi Security has been used to control access, the current user's name will be available in the @Function.UserName~ token. This can be embedded into this attribute to provide separate Save files for individual users. For example, the attribute value might be: @Function.AppPhysicalPath~\SaveFiles\@Function.UserName~.xml which might translate to: C:\inetpub\wwwroot\MyReportApp\SaveFiles\MZuckerberg.xml Save files can also be stored in a database, see Bookmarks. |
Disable Gallery Updates | Specifies whether users can delete visuals at runtime from the gallery specified above in the Gallery File attribute. The default value is True. |
Gallery Caption | Specifies a caption for the gallery specified above in the Gallery File attribute. This caption appears in the list of galleries in the Visual Gallery panel. |
Report Author Mode | Specifies the display mode and editing options for the report. Options include: |
Save File Starter | Specifies the fully-qualified file path and name of an XML data file that will provide a default report design. It will be used only when the Save File does
not exist. For example, when the Save File is different for each user,
the Save File Starter file can provide a set of default components. @Function.AppPhysicalPath~\SaveFiles\DefaultDesign.xml |
Template Modifier File | Specifies the name of an optional Template Modifier File, used to programmatically modify the Report Author super-element UI or behavior at runtime. See Customizing Report Author Appearance for more information about template modifiers. You can provide a fully-qualified file path and name for the file, within the application root folder or, if a fully-qualified file path is not provided, the application expects the file to be in its _SupportFiles folder. |
Uploaded File Folder | (Required prior to v12.2.116 SP3) Specifies the fully-qualified file path and name of a folder, within the application root folder, where uploaded images will be stored. These are optionally uploaded from the Images component Settings panel, and uploaded files appear in the list of available images in that panel. If Logi Security has been used to control access, the current user's name will be available in the @Function.UserName~ token. This can be embedded into this attribute to provide separate image folders for individual users. For example, the attribute value might be: @Function.AppPhysicalPath~\ReportImages\@Function.UserName~ which might translate to: C:\inetpub\wwwroot\MyReportApp\ReportImages\MMayer
Uploaded files can also be stored in a database, see Storing Bookmark, Gallery, and Save Files in a Database. |
View Extracted Element ID | Specifies one or more element IDs, in a comma-separated list, of elements that may be necessary for the proper functioning of the report, such as Definition Modifier File or Plugin Call. These are stored in the report's bookmark and included when the report is generated. |