|
| DisableGalleryUpdates | | Set to True to prohibit deletion of panels from this Gallery file. |
| GalleryCaption | | When there are multiple galleries defined with ExtraGalleryFile elements, there may be a caption set for each. When the galleries are displayed, the user may select one from a drop-down list. Making a selection shows only visualizations from that gallery. |
| GalleryFile | | (Required) With the AnalysisGrid's CustomDashboardPanels element, charts and tables may be copied to a SaveFile to be added by the user later to a Dashboard or ReportAuthor report.
The GalleryFile allows the visualizations to be stored outside of a specific dashboard file, so that they may be copied into multiple dashboards.
There are two methods for creating gallery files.
This first method uses a dashboard save file as a gallery file, so the gallery has panels that have been added to a dashboard. This method makes it easier to add and remove gallery items by working directly with a dashboard. Set the CustomDashboardPanels' DashboardSaveFile to a gallery xml file. This file will be created and updated as the user adds visualizations. Then, in the Dashboard or ReportAuthor element, set the GalleryFile to this same file.
The second method gets gallery items from a report definition .lgx file which has its own Dashboard and Panel elements. The panels will make up the gallery items.
Specify the gallery file's full path and filename.
GalleryFile information may be stored in a relational database. See the Settings FileToDatabaseMapping element. |
| ID | | (Required) The ID attribute is a pervasive attribute that uniquely identifies an element within a definition file. The ID needs to be a unique value within the definition. |
| ReportAuthorMode | | ViewExtracted |
| ViewEdit |
| ViewContained |
| DesignEdit |
| ReportAuthorMode sets the display mode for the report.
"ViewEdit" shows the report first in view mode, without the design controls. The user may click "Design" to switch to design mode.
"DesignEdit" shows the report in design mode. The user may click "View" to switch to view mode.
"ViewContained" shows the report in view mode, without the ability to switch to design mode. The "Design" button is not available. Elements above and below the ReportAuthor element are also included in the report display.
"ViewExtracted" shows the report in view mode, without the ability to switch to design mode, showing only the designed report. Elements outside the ReportAuthor are not shown, so the report is just what was designed.
The "View" modes all require loading an existing designed report from a bookmark or SaveFile.
Default Values:
"ViewExtracted" is the default for exports.
"ViewEdit" is the default for existing/bookmarked reports.
"DesignEdit" is the default for new reports. |
| SaveFile | | (Required) Specifies a file to save the end-user's changes for the current element. When the element is reloaded it is shown in the same state as when it was last used.
The file will be created if it does not exist. The containing folder is not automatically created. Ensure that the ASPNET process (Process Identity) has "write" access rights to the folder.
To have a different save file for each user, include the @Function.UserName~ token in part of the filename.
c:\myWeb\SavedFolder\@Function.UserName~.xml
It's often useful to specify the folder in the Constants element in the settings definition file.
@Constants.SaveFolder~\@Function.UserName~.xml
Do not set the SaveFile when using an AutoBookmark element. |
| SaveFileStarter | | Specifies a file used as the initial SaveFile in cases when the SaveFile does not exist yet. For example, when the SaveFile is different for each user, SaveFileStarter can include a set of default Tabs and Panels.
To create a SaveFileStarter, first set a SaveFile. Then run the element, making the desired changes. Finally, copy or rename the SaveFile into the SaveFileStarter location. |
| TemplateModifierFile | | Some elements employ a definition file as a template. The definition contains language and culture specific Caption attributes that you may want to change. Or you may simply want to change the captions to better suit your application.
The TemplateModifierFile is an XML file with elements pointing to other elements in the template to be changed. All other attributes get applied in the template.
For example, the Dashboard2 element has a template file (rdTemplate\rdDashboard\rdDashboard2Template.lgx) several Label elements. One has an ID="lblAddPanelsTitle". The Caption can be changed with the following XML in the TemplateModifierFile:
You can set attributes for any number of elements. Examine the template file to learn the ID and Caption attributes you may want to modify.
The above example shows how to identify template elements with an ID attribute. Alternatively, you can also identify elements with an XPath expression. In this example, we change an attribute of the InteractivePaging element:
For a more detailed list of modifier actions see the following DevNet article.
TemplateModifierFiles can be in any folder accessable to the web application. When a directory location is not specified, the default location is the _SupportFiles folder.
|
| UploadedFileFolder | | UploadedFileFolder specifies the location of image files uploaded by the user for inclusion in a ReportAuthor report.
This folder must be a path under the web application, so that uploaded files are accessible to client browsers.
Alternatively, uploaded files can be stored outside the application. This requires setting a path in the Settings/General element's ReportAuthorUploadFolder attribute instead. It overrides this attribute. |
| ViewExtractedElementIDs | | When running a ReportAuthor element in "ViewExtracted" mode, only the elements added with the ReportAuthor UI are shown. In some cases, it's helpful to include additional child elements of the elements such as , , etc.
To include these in "ViewExtracted" mode, add their ID values in a comma-separated list of this attribute. |