Server-side resources and folders

Web Dashboard allows you to use server-side folders using the Folder object. You can use folders to save different types of documents generated with tasks (see Tasks) or to upload files for the XML import (see Import and export objects.)

Create folders

You can create Folder objects from the main menu, under Administration > Folder. Make sure the directory path associated with the Folder object points to an existing folder on the server-side host. Although the application allows you to create a Folder object pointing to nonexistent path, processes relying on that Folder object will fail.

For example, if you create a periodic Task object to automatically generate reports and, for the target folder, you choose a Folder object that refers to a nonexistent physical folder, your task will fail at execution time.

The following directories referred to by predefined folders are created automatically by Web Dashboard:

<WEBSERVER_HOME>/webapps/SentinelWebDashboard/webdashboard/pub/theme3/img (see Folder object Default Image Path)

<WEBSERVER_HOME>/webapps/SentinelWebDashboard/webdashboard/var/xsl (see Folder object Default XSL Path)

When defining the path for the Folder object (see the field Directory) you can use the variable {WEBDASHBOARD-DIR} to build your path relative to the currently configured base directory on the server side. For example, {WEBDASHBOARD-DIR}/myfolder/foo. If you omit the variable, the path is considered relative to the base directory. For example, a path /myfolder/foo is equivalent to {WEBDASHBOARD-DIR}/myfolder/foo.

The default value of the {WEBDASHBOARD-DIR} parameter is <WEBSERVER_HOME>/webapps/SentinelWebDashboard/webdashboard, where <WEBSERVER_HOME> is the full path of the home directory of the Jetty/Tomcat installation.

The value of the {WEBDASHBOARD-DIR} can be customized in:

  • Jetty: the jetty-web.xml file associated with Web Dashboard (<JETTY_HOME>/webapps/SentinelWebDashboard/META-INF/jetty-web.xml) by adding the following entry:

<New class="org.eclipse.jetty.plus.jndi.EnvEntry">

<Arg></Arg>

<Arg>webdashboardBase</Arg>

<Arg type="java.lang.String">C:/myfolder/foo</Arg>

<Arg type="boolean">false</Arg>

</New>

  • Tomcat: the context.xml file associated with Web Dashboard (<TOMCAT_HOME>/webapps/SentinelWebDashboard/META-INF/context.xml) by adding the following entry:

<Environment name="webdashboardBase" value="C:/myfolder/foo" type="java.lang.String" override="false"/>

For this change to take effect, you must restart Sentinel Server or, if you are using external Tomcat, restart your Tomcat server. If you personalize the base directory, make sure you manually create the folder referred to on the server-side host.

Note   When you define the folder path (see field Directory) you cannot use the ".." notation. Also, you can use personalized fields in the directory path. See Personalized fields.

Access files from and upload files to folders

You can access files from folders created on the server or upload new files directly from the Web Dashboard UI. You must add the folder object you have created in the menu and grant the appropriate rights. See the User management > Workspace > Sessions tab. When accessing this object from the menu all the files in the folder will be displayed. This is useful when you want to give web access to different documents, like reports and dashboards.

  • Delete or rename -You can delete or rename files directly from the interface. You can also define Read-only access at the workspace level. In this case, you can only visualize the available files; you cannot delete, edit or upload.
  • Upload - You can upload new files to be saved on server side. For example, if you want to share a document with other users. When a file is uploaded with the same name as an existing file, you can choose to overwrite it.

Related Links