Explorer Widget

<< Click to Display Table of Contents >>

EQuIS 7  >>  Enterprise > Widgets >

Explorer Widget

The Explorer Widget is used to browse, search, and organize items within folders. Users have the ability to create folders to group items. This widget can also be used to create new files and facilities. An administrator can right-click the context menu for cut and paste functions as well as viewing and editing files and facility information.

 

The Explorer widget is divided into sections, as depicted in the image below:

Tree of all file folders and contents (left pane)

Information grid (main pane)

Top frame above the grid that contains an advance search option and the New File/New Facility buttons

Paging control beneath the grid

 

Explorer_Widget_Sample

 

On the left is the Folder Tree section of the widget, where the existing folder structures are displayed. By clicking a node, the information grid is populated with the contents of that folder. To create a new folder, right-click on All Items in the left panel and select New Folder. Reports and files can be cut and pasted into the folder by administrator users. The folders can be accessed in other widgets where the folder icon is visible (e.g., the EZView widget) for selecting/grouping reports.

 

The Explorer widget displays a grid that lists all objects in the selected folder as well as the attributes of the object. The icons indicate the object type. The object attributes include name, code, remark, type, and owner. The following table details the attributes displayed in the grid by object type, except for the remark field, which is an optional field for any of the object types.

 

Icon

Name

Code

Type

Owner

Dashboard_iconDashboard

Dashboard Title
Links to that dashboard

Dashboard Title

DASHBOARD_ID

Creator of Dashboard

Facility_Icon_Explorer_Widget Facility

Facility Name
(if not set, Facility Code)

Facility Code
Link to open the facility editor form

FACILITY_ID

Facility Project Manager

File_Icon_Explorer_Widget File

File Title
Links to download the file

File Name
Link to open the file editor form

FILE_ID

File Author

Report_Icon_Explorer_Widget Report

For user reports, this is the Report Name.

 

For base (build) reports, this is the Report Display Name.

For user reports, this is the base report specific name of the report.

 

For base (build) reports, this is the specific name of the report.

USER_REPORT_ID

If created in Enterprise, the creator of the user report. Otherwise left Blank.

Widget_Icon_Explorer_Widget Widget

Widget Type Name

Widget Type Name

WIDGET_TYPE_ID

N/A

 

The grid columns of the Explorer widget can be sorted or filtered based on these attributes.

Sorting – The columns are sortable by clicking on the column header (click again to reverse the sort). Note that sorting does not change the current page, and the first or last values of the sorted column may not be displayed, unless on the first or last page of the list.

Filtering – To filter the attributes, enter a search term (three or more characters) in the appropriate search box beneath the column header. Note that there is a three (3) character minimum on search strings by design; searching one or two characters will not return results. Only attributes that contain the search term will be displayed.

 

The widget contains Layout Divider indicated by the two parallel bars | | that can be dragged to re-size the tree and grid portions of the widget. Each of the columns in the information grid can also be re-sized by dragging along the column dividers.

 

The bottom of the widget contains paging controls for displaying a limited number of items at a time, as described below.  

Arrows – Use the left/right arrows to navigate through pages.

Go to Page List – Select a specific page to navigate directly to that page.

Rows per Page – Change the number of items to be displayed per page by using the drop-down menu.

Count of Pages and Total Items – This control indicates the total number of items available in the widget, how many pages to display the items, and which page is currently selected.

 

Context Menu

 

If the user is an administrator, a context menu is available when a node in the folder tree is right-clicked, as shown below. This includes the following options:

Cut and Paste – Cut will remove a folder from the tree after it is pasted. Paste will insert a folder or a table item into the right-clicked folder.

Delete – After clicking Yes on a confirmation window, this will delete the right-clicked folder.

Rename – Gives the ability to rename the folder's display text in a pop-up window.

New Folder – Allows the user to create a new folder within the currently selected folder. Right-click on the root folder to create a top-level folder.

New Facility – Opens the New Facility window. This is the same as clicking on the New Facility button in the widget header, except that the new facility will be inserted into the right-clicked folder.

Permissions – Opens a permissions window to set the right-clicked folder's permissions. The administrator will be able to grant or deny different permissions to users or roles.

Context_Menu_Explorer_Widget

 

A context menu is also available on table items. If a user is an administrator, this context menu will include Cut, Paste, and Permissions. If the user has at least viewer permission on a file or a facility, the context menu will include a View. This context menu includes the following options:

View – If the table item is a file or a facility, the option will open up the file viewer or the facility viewer, which are described above.

Delete – If the table item is a user report, and the user has owner permission on the report, this option will be available. Clicking this option will remove the user report from Enterprise, although it will remain in the database (the STATUS_FLAG set to R). If the report is associated with an EIA, the delete action will fail, and a message will be displayed.

Cut and Paste – If the user is an administrator, these options will be available. Cut will put the table item into the clipboard and after paste, the item will be removed from the table and the folder it is in. Paste will insert the item into the table and the currently selected folder in the Explorer tree.

Permissions – If the user is an administrator, this option will be available. This opens up the permissions dialog allowing an administrator the ability to grant/deny permission on the right-clicked object to a user or a role.

Unselect all rows – This option is available to all users and will unselect all rows in the table.

 

Advanced File Search

 

The Advanced File Search button can be used to search and/or filter information. The Advanced File Search button opens up an Advance File Search form, which can be used to drill-down to specific file items in Enterprise based on search criteria specific to file meta-data fields. This includes folder structure path, title, author, the user name or email who uploaded the file, whether the file is confidential, facility, location, date, file content (if full-text index has been enabled in the database), remarks, and file name.

 

Explorer_Widget_Advanced_Search

 

New Facility

 

The New Facility button can be clicked to create a new facility. A New Facility window opens that can be completed with the desired settings. The Facility Code is a required field, but all other parameter options are optional and can be updated later after the facility has been created.

Explorer_Widget_New Facility

 

Upload Files

 

New File Button

 

The New File button can be clicked to upload a single new file. An Upload File window opens that can be completed with the desired settings. This button is only available to users that have creator permission on the file type object.

 

Explorer_Widget_Upload

 

The Upload File form includes the following options:

Save To – Allows user to select a folder to save the file. Defaults to the All Items root folder if no folder is selected. The user needs at least editor permission on the folder being saved to.

Title – Create a title for the file. This is a required field.

Author – Name of file author. This field is optional.

Confidential (Y/N) – Can use radio buttons to mark file as confidential. This value is optional.

Facility – Can use the facility chooser to select a facility. This field is optional.

Location – Select a location to associate the file to that location in DT_FILEPLACE_TYPE = SYS_LOC_CODE and DT_FILEP.PLACE_CODE = {SYS_LOC_CODE value of the location} (e.g., B-30). This field is optional. If left blank, no value is assigned related to location in DT_FILE.

Date – The DT_FILE.FILE_DATE field will automatically populate with the date the file is upload if a date is not selected. Select a past date to assign that date to the file to denote when files were created rather than uploaded.

Remark – A description of the file. This value is optional.

File Source – Allows user to select a local file or use a URL.

File – The file path (for local) or URL (for Internet) where the file is located.

Use Enterprise as Proxy – Allows the file to be routed to and downloaded from the Enterprise server, rather than the original URL/file path.

Upload – Select the file to upload by browsing to the file or by dragging and dropping it. An Upload Box will appear. This box displays the name, size and status of the file being uploaded. Click the Upload button. If the file is successfully uploaded, the Upload Box will display a white check mark within a green circle under the Status column. Select the Close button to exit this box.

EDD_Upload_Widget_Upload_Box

 

Batch Upload Files

 

While the New File button on the Explorer widget allows for a single file to be uploaded to the EQuIS database, users may want to load many files. There are two ways to batch upload files into the DT_FILE table in the database:

1.Doc & Photos Form – The Docs & Photos Form can upload an entire folder of files at one time. These files may include images that can then be associated with a location or location types, spreadsheets or templates for use in report output. The file type associations are stored in RT_FILE_TYPE. The form will populate DT_FILE, RT_GROUP and RT_GROUP_MEMBER. These files will then be available in the Explorer widget.

2.EQEDD Format Files_v1 Section  – This section of the format file is used to specify the details for each non-data file (without needing to manually edit the DT_FILE table after the files are added to the database). For the non-data files to be processed by Enterprise EDP, they must be included in the EDD .zip file (ex: EB1608796a.FAIRVIEW.EQEDD.zip) and referenced in the Files_v1 section of the format file. For each non-data file, there should be a row in the Files_v1 section that is matched with the zip file entry.

The EXTERNAL_URL field in the Files_v1 section of the EQEDD format can be used to load a record into the DT_FILE table that references an external file (i.e., a file that resides outside of EQuIS). The value in the EXTERNAL_URL field must be one of the following:

NULL = This field is left blank when physically loading the file into EQuIS. The file must exist in the EDD and will be loaded normally.

<url> = EDP will check to make sure the URL is valid and accessible. A record will be created in the DT_FILE table (during Commit). When the corresponding file is downloaded via the Explorer widget, Enterprise will redirect the user's browser to the original URL. The user must have appropriate credentials to access the original URL or the file will not download.

proxy.<url> = The URL will be checked and the record will be loaded into the DT_FILE table as described above. When the corresponding file is downloaded via the Explorer widget, the Enterprise application will make the request to the external URL, download it to a temporary folder on the web server, and then send it to the user's browser. The user will never see the external URL. The external URL must be accessible from the Enterprise web server.

 

 

Widget Properties

 

To change the title or color of the Explorer widget, open the Widget Editor by selecting the More Options dashboard_chooser icon in the upper right corner of the widget to display the drop-down menu and then select the Edit menu option.

Widget Title – By default, the widget title is Explorer. The title can be modified.

Widget Color – The color of the widget can be changed using the Change Widget Themecolor_iconicon to the left of the widget title.

Root Folder Name – This property is only available to administrators. The Explorer Widget tree has a default root folder whose name defaults to All Items. This can be changed on a widget-by-widget basis, either here or by using the context menu Rename when right-clicking on the root folder in the tree.

Object Type Filter – The table listing on the Explorer Widget can be filtered by object type. Selecting one or more of the object types in this list box will cause the table to only list objects of the selected type(s). When no type is selected in this property, all object types will be displayed.

Show Object Filter selection on widget – If this property is checked, the selected types will be shown on the Explorer widget header. If no object types are selected when this property is checked, the related widget header message will display All.

Default Folder – Selecting a default folder will cause the Explorer widget to show items from that folder, hide the search box and the folder tree. Once enabled, the default folder can only be changed to a different folder. The feature cannot be unset, other than by deleting the widget and adding a new Explorer widget to the dashboard.

Cancel – Select the Close without Saving Close_icon button to exit the Widget Editor without saving changes.

Save – Changes will be applied to the widget by clicking on the Save Widget_Save_icon button. The Widget Editor screen will close after the save operation is complete.