Module Manager Widget

<< Click to Display Table of Contents >>

Navigation:  Enterprise > Widgets >

Module Manager Widget

Deploying Modules

Uploading Reports

Widget Properties

 

Introduced in Enterprise 7, the Module Manager widget is a beta widget that makes deployment of modules (widget or dashboard) easier for administrators.

Ent-Module_Manager_Widget

 

The Module Manager widget has three columns that show the name of the module, version, and type.

Name – Displays the name of the module.

Version – Indicates the version of the module.

Type – Indicates whether the module is a widget or dashboard.

 

The widget also includes a search box for each of these fields. Enter a search term (three or more characters) in the appropriate search box beneath the column header. The display of modules will be limited to the search string.

 

Beneath the grid displaying the modules, the Module Manager widget contains paging controls for displaying a limited number of modules 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 modules to be displayed per page by using the drop-down menu.

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

 

 

Deploying Modules

 

The bottom part of the widget contains an upload box to upload dashboards and widgets as follows:

1.Click on the Browse button.

2.Navigate to the module file to be deployed. The Module Manager widget allows deployment of the *.dashboard, *.widgettype, *.widget, *.dataset, *.sql, *.zip file types.

3.Click Open.

4.Complete the deployment step by appending "action=deploy" to the Enterprise URL (e.g., https://localhost/equis7/default.aspx?action=deploy).

5.Clear the browser cache. See the Clearing Cache article for more information.

 

Alternatively, files can be dragged and dropped  in the upload box.

 

Modifying – Redeploying a module will modify the module, with the older file(s) getting replaced by the newer file(s).

 

 

Uploading Reports

 

Report dependencies and some module-specific reports must be in the EQuIS Enterprise installation's bin folder for use within Enterprise. An administrator can upload a report to the bin folder via the Module Manager as follows:

 

1. In Windows Explorer, create a folder called "bin" in a directory where there is full user access (for example, a personal folder like Documents or the Desktop, rather than within Program Files).

 

2. Copy the report *.DLLs into this folder.

 

3. Right-click on the "bin" folder and zip it by selecting Send to > Compressed (zipped) folder. This folder structure must exist in the zip file, so the zip should contain a "bin" folder after being created.

 

4. Double-check that the file size does not exceed the site's maximum upload limits, typically 10 MB.

 

5. Click and drag the zip file into the Upload area of the Module Manager.

 

6. Follow any additional prompts to upload the files accordingly.

 

 

Widget Properties

 

This widget has no specific properties. To change the title or color of the Module Manager widget, open the Widget Editor by selecting the More Options Ent-More_Options-Icon icon in the upper right corner of the widget to open the drop-down menu and then select the Edit menu option.

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

Widget Color – The color of the widget can be changed using the Widget ThemeEnt-Theme_Color_Iconicon to the left of the widget title.

Widget Object Editor – To set various appearance properties of the widget, select the Object Editor Ent-Widget-Editor_Properties icon in the widget header to open the Widget Object Editor. See the Widget Editor article for more details.

Help – The Help Ent-Help-Icon icon connects to the online documentation related to the specific widget.

Copy Settings – Select the Copy Settings Ent-Copy_Settings-Icon icon to to copy the settings from another widget of the same type. See the Copy Widget Settings article for more information.

Cancel – Select the Close without Saving Ent-Close_icon icon to exit the Widget Editor without saving changes.

Save – Changes will be applied to the widget by clicking on the Save Ent-Widget_Save-Icon icon. The Widget Editor screen will close after the save operation is complete.