The actuate.ReportExplorer class retrieves and displays a navigable repository or file system interface that enables users to navigate folders and select files. This generic user interface enables the user to browse and select repository contents.
Constructor
Syntax
actuate.ReportExplorer(string container)
Constructs a ReportExplorer object, initializing the ReportExplorer component.
Parameter
container
String. The name of the HTML element that displays the rendered ReportExplorer component or a container object. The constructor initializes the ReportExplorer component but does not render it.
Unloads JavaScript variables that are no longer needed by ReportExplorer.
Example
This example cleans up unused JavaScript variables for myReportExplorer:
myReportExplorer.onUnload( );
registerEventHandler
Syntax
void ReportExplorer.registerEventHandler(string eventName, function handler)
Registers an event handler to activate for parameter eventName. This function can assign several handlers to a single event.
Parameters
eventName
String. Event name to capture.
handler
Function. The function to execute when the event occurs. The handler must take two arguments: the ReportExplorer instance that fired the event and an event object specific to the event type.
Example
This example registers the errorHandler( ) function to respond to the ON_EXCEPTION event:
Sets the name of the root folder for this ReportExplorer.
Parameter
folderName
String. The name of the repository folder to use as the root folder. Use a repository path to use subfolders for the root folder. The string '~/' maps to the current user’s home folder.
Example
This example sets the report explorer root folder to /Public:
Array of strings. Valid values are: "Name", "FileType", "Version", "VersionName", "Description", "Timestamp", "Size", and "PageCount". iHub requires the Name, FileType, and Version fields in the results definition array to identify all files.
Example
This example sets the result set to five columns of data including name, file type, version, version name, and description:
var resultDef = "Name|FileType|Version|VersionName|Description";
Sets the target service URL to which this explorer links. When the service URL is not set, this viewer links to the default service URL which is set on the actuate object.
Parameters
iPortalURL
String. The target Actuate web application URL, either a Java Component or iPortal.
requestOptions
actuate.RequestOptions object. Optional. requestOptions defines URL parameters to send with the authentication request, such as the iHub URL, volume, or repository type. The URL can also include custom parameters.
Example
This example sets the URL for the Actuate iPortal web application service:
Sets the explorer to display the folder description as the folder label instead of the folder name.
Parameter
useDescription
Boolean. True displays descriptions for folders instead of folder names.
Example
This example displays descriptions for folders instead of folder names:
myExplorer.setUseDescriptionAsLabel(true);
showFoldersOnly
Syntax
void ReportExplorer.showFoldersOnly(boolean flag)
Sets ReportExplorer to display folders but not files.
Parameter
flag
Boolean. True displays folders but not files.
Example
This example displays folders in ReportExplorer but not files:
myExplorer.showFoldersOnly(true);
submit
Syntax
void ReportExplorer.submit(function callback)
Submits requests to the server for ReportExplorer. When this function is called, an AJAX request is triggered to submit all the operations. When the server finishes the processing, it returns a response and the results are rendered on the page in the ReportExplorer container.
Parameter
callback
Function. The function to execute after the asynchronous call processing is done.
Example
This example submits ReportExplorer with a root folder that set with setStartingFolder( ) and result definition set with setResultDef( ):