Hub Usage

Mail & Deploy Hub can be accessed by using a standard web-browser such as Internet Explorer, Edge, Chrome, Firefox etc. In order to access the hub, the correct URL needs to be entered; the general form of the URL is http://<servername>:<port>/<relativeurlpath>


However, the following rules need to be considered:

  • The port can be omitted if it is set to be the default HTTP port 80.
  • The relative URL path can be omitted if it is empty. 
Example: If you have set up the hub to use the default HTTP port and to have no relative URL path, then the hub can be reached by entering http://<servername>. If you have a relative URL path and the default HTTP port, you can access the hub by entering http://<servername>/<relativeurlpath>.


General

Repository Selection 

If the user with which you log in to the hub has access to more than one repository, a page will be displayed that allows you to select the repository with which you want to work. In order to switch to another repository, you can simply click the option General Switch Repository in the left menu. If the user with which you log in to the hub only has access to a single repository, you will automatically be redirected to the home page.


Home 

After entering the repository, you will get to the home page; this page displays:

  • The newest report documents that have been added to your report library. The table displays the following attributes:
CreatedThe time at which the report document has been created in the local time according to the time zone of the currently logged-on user.
TypeAn icon that identifies the file type of the report document.
Name & Description
The name and description of the report document. The name is a hyperlink that you can click in order to open or download (depending on the file type) the report document.
  • The most recent exceptions that occurred when executing on-demand report requests, report subscriptions or task executions that are associated with the user currently logged-on.

Reports

Available Reports 

This page displays a list of all reports to which the currently logged on user has access to (see Hub Authorizations). For each available report, the name and description are shown in the table. Below the description, there is an option to perform a one-time request of a report document and if the hub authorization of the user allows subscriptions to create a subscription.


Requesting Report Documents

If you want to perform a one-time request of a report, you can click the hyperlink Request Now which can be found immediately below the description of the report. This will open a new page where you can set the following attributes:

ParametersIf the report has any parameters (see Report Parameters), they will be displayed and can be entered by the user. Depending on the report parameter settings, the user may be able to enter a free text or select a value from a given range of values.
NameThe name you want to give the created report document. This name is used to identify the report document within Mail & Deploy. The default value is automatically set to the name of the report on which the created report document will be based.
Description The description you want to give the created report document.
File Type The file type in which you want to create the report document. The range of available file types depends on the report type (see Report Types).
CultureThis is an optional setting that depends on whether the report on which the report document will be based supports culture awareness (see Culture Awareness) and allows custom cultures. If that is the case, you can select the culture to use for the creation of the report.
Distribute by E-Mail to ...This setting determines whether the created report document shall send by e-mail to the e-mail address of the currently logged-on user. If that user does not have an e-mail address, this option is not applicable. This option is only available if the repository supports e-mail distribution (see Hub Settings).
E-Mail AddressesYou can tick this box and then enter a list of additional e-mail addresses separated by a semicolon to which you want to distribute the report document. This option is only available if the repository supports e-mail distribution (seeHub Settings).
Add to my LibraryIf you tick this box, the created report document will be added to the report document library of the currently logged-on user.
File PathIf you tick this box, you can enter a file path to which you want the created report document to be saved. It is important to note that the report document will be saved to the file system by Mail & Deploy Server and therefore the following requirements have to be met: 
  • The user that runs Mail & Deploy Server needs to have sufficient user rights to write to the directory.
  • The file path needs to be reachable from the computer on which Mail & Deploy Server runs; this might require to use UNC file paths in some cases. Please note that mapped network drive letters cannot be used, even if the user that runs Mail & Deploy Server has a mapped network drive set up.


Please note you can set up any combination of distribution methods; so it is possible to not send the report document by e-mail at all while just saving it to a file system and/or adding it to the report document library. However, at least one distribution method needs to be selected in order to successfully submit the request.

Once you have set up everything to your needs, you can click SUBMIT REQUEST which will send the request to Mail & Deploy Server; you will automatically be re-directed to the status page of the request you have just submitted.


Subscriptions 

This page lists all subscriptions for the creation of report documents. Basically a subscription is the regular creation and distribution of a report document; in other words: it's similar to a report document request which will be executed on a regular basis.


Creating Subscriptions 

You can create a subscription by clicking Create Subscription in the list of available reports.

Please note that whether a subscription for a specific report may be created depends on the authorization of the user (see Report Authorizations).

After clicking Create Subscription, a new page will open which allows you to enter all the attributes as if you would request a single creation and distribution of a report document. In addition to that, the following attributes can be set:

Time Zone
The time zone to apply to the subscription; all times in the subscription are always local times according to this time zone.
Start DateThe date-time where you want the next execution of the subscription to take place (see Execution Sequence).
End DateThe end date is optional; if enabled, you can specify until when the subscription shall be valid.
Frequency The frequency determines how often the subscription is due to be executed.

Daily.

If you choose this frequency, the subscription will be executed on a daily basis.

Weekdays.

If you choose this frequency, the subscription will be executed on the specified weekdays.

Weekly.

If you choose this frequency, the subscription will be executed on a weekly basis.

Monthly. 

If you choose this frequency, the subscription will be executed on a monthly basis (this does not equal a 30-day period, but rather to a full month; e.g. April 3rd plus 1 month will be May 3rd).

Yearly. 

If you choose this frequency, the subscription will be executed on a yearly basis (this does not equal a 365-day period, but rather to a full year; e.g. April 3rd 2018 plus 1 year will be April 3rd 2019; leap years will automatically be recognized by Mail & Deploy).

Once you have set everything up, you can click SAVE SUBSCRIPTION to save the subscription. You will then be automatically redirected to a page where you can manage your subscriptions.

Managing Subscriptions 
Subscriptions can be managed by clicking Subscriptions in the left menu. A table will be displayed, that contains information about all the subscriptions you currently have. You can edit a subscription by clicking Edit Subscription and delete a subscription by clicking Delete Subscription.

Library 

This page lists all report documents contained in your library. The table that will be displayed is organized by report, which means that there is one row per report (see Reports) for which there is at least one report document in your library; the table has the following columns:

ReportThe report, which acts as a category for your report document.
Latest Report Document The latest report document in your library that has been created from the report. The name is a hyperlink that you can click in order to open or download (depending on the file type) the report document.

You can click on the name of the report and a new page will be displayed that contains all report documents (newest at the top) of the report you have clicked on. That table contains the following columns:

Created The time at which the report document has been created in the local time according to the time zone of the currently logged-on user.
Type An icon that identifies the file type of the report document.
Name & DescriptionThe name and description of the report document. The name is a hyperlink that you can click in order to open or download (depending on the file type) the report document.

You can delete a report document from your library by clicking the Delete hyperlink in the Name & Description column of the table.

History 

This page displays all report document requests and executions based on report document subscriptions; the table contains the newest entries first and has the following columns:

DateThe date and time at which the execution of the request has taken place; these times are local times according to the time zone of the user.
StatusAn image that describes the status of the execution:
. The execution was successful.
. The execution was cancelled.
. The execution failed.
TypThe type of execution.

On-Demand Request.
The execution was due to a one-time requested report document.

Subscription.

The execution was due to one of your subscriptions.
Details Here you can find the name and description of the report document. By clicking View Details you can see the status or result of the execution.

Report Document Request Status 
On this page, you can see the current status of a report document request. You will see the log file and if the execution was completed successfully a link to open or download the created report document.

Tasks

Available Tasks 

This page lists all tasks for which you are authorized (see Task Authorizations) to request an execution through Mail & Deploy Hub. The table contains the name and description of each task. Just below the description, there is a link Request Execution that will bring you to the page that enables you to request the execution of that task.

Request Task Execution
If you want to request the execution of a task, you can click the link Request Execution below the description of the task. You can then enter the following attributes:

ParametersIf the task has any parameters (see Task Parameters), they will be displayed and can be entered by the user. Depending on the task parameter settings, the user may be able to enter a free text or select a value from a given range of values.

Once you have configured everything to your needs, you can click SUBMIT REQUEST to actually request the execution of the task. You will then be redirected to a page that allows you to see the current status of the requested execution.

History 

This page lists all historic task execution you have requested; the table contains the newest executions at the top and contains the following columns:

Date
The date and time at which the execution of the request has taken place; these times are local times according to the time zone of the user.
StatusAn image that describes the status of the execution:
. The execution was successful.
. The execution was cancelled.
. The execution failed.
DetailsYou can find the name and description of the task here. By clicking View Details you can view the log file of the execution.

Task Execution Request Status
On this page, you can see the status and log file of the execution of a task.

T
Team is the author of this solution article.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.