Creating a New Job

1. Navigate to the Administration section by clicking .
2. Click Distribution in the left pane.

3. On the right panel, click Create a New Job. This opens the Job Properties page with the following tabs:

   • General

   • Web Views

   • Excel Add-in Views

   • Consolidated Report

   • Users and Groups

   • Conditions

   • Email

   • Schedule

General

Setting	Description
Description	Describes the actual job. The details are written by the Administrator.
Action	Determines if it will be sent by email or saved on the network. If the action is set to Export and Save on Network Drive, then the system will require entering a network path, where a set of new folders will be created automatically by the job: one folder for each user selected in the Users and Groups tab. Each folder will contain a copy of the reports being run, with the respective users credentials. You are also able to use Global Variables that will be resolved based on the Admin context. Example For example, when you have a Network Path set as '\\SERVER\MonthlyReports\@@CurYear\@@CurMonth ', this will automatically generate a folder '2023' and another folder '6' within the root folder 'MonthlyReports'. Note Uppercase and lowercase letters (A-Z, a-z), digits (0-9), and the underscore (_) symbol cannot be attached at the end of a global variable name. If the action is set to Export and Email, the reports will be run with each users credentials and sent out via email to the respective users.
Status	Enables or disables the subscription. Tip In this tab, as in many other places in the Distribution (and throughout the Nectari application), the language can be changed by clicking .

Web Views

This page gives the option to select the Web Views to run automatically, search from the generic search box or use the filter to search a specific view.

1. Click the Views of your choice and move them to the right box using the arrows.
   

   

2. Once this is done, the Filter option can be activated by clicking .

3. In the View Properties dialog box:

   

   1. Click the toggle button to enable the Custom Name field, if needed.

      This option allows you to customize the distribution output files, in which you can:

      • Add a custom name, with multilingual options.

      • Add Global Variables and Special Variables.

        Example

        Invoice by Customer @@CURYEAR Period @@UDM_CURPER

        Note

        Uppercase and lowercase letters (A-Z, a-z), digits (0-9), and the underscore (_) symbol cannot be attached at the end of a global variable name.

        Important

        Windows files do now allow the following characters: " \ / : | < > * ?. If these characters are present in the custom name, the distribution job will fail.

        If a file with the specified name already exists, it will be overwritten.

        Global Variables and Special Variables will be resolved based on the default environment only: Admin for OnPremise, and ADMCA for CloudMode.

   2. Select the format: PDF, HTML, Excel, XML, CSV, or External Link. The export format can be selected for each view.

   3. Select the environment on which the view is run.

   4. Apply to Filtering Panels: When this option is enabled, the distribution of dashboards uses the Global Parameters used as filters in the filtering panels to impact only the views that have these same Global Parameters.

      Note

      For Report type views, if you select Excel or Excel Add-In in the drop-down list, the Reporting Tree feature becomes available. When enabled, one sheet is generated for each node of the Reporting Tree.

      

   5. The Filter option allows the selection of specific data to be distributed. Click to open the Restriction Editor window.

      

      After adding a filter, it appears in window on the right and the Edit Filter icon appears in the right column. Click it to access the View Properties window. Add as many filters as required by selecting the options using the drop-down list and click Confirm.

   6. Click Confirm to close the View Properties dialog box.

4. When a Custom Name or Filter is applied to a view, a check-mark will indicate it in the respective columns for each view.

   

Excel Add-in Views

The Excel Add-in Views tab allows you to set up one or more Excel Files to be distributed during the Job execution.

1. Click to choose the Excel file you want to import.

   

   Note

   If you want to add more than one Excel file, click on to add another file tab then on to import the file.

   Tabs can be removed with .

2. Click Upload to browse to the location where the file is. The window will display a list of files in the Central Point.
   

   

3. Select the file you want to import, click Open then Confirm to get back to the Job Properties window.

4. Once the File Name is determined, you may choose to add a Custom Name by clicking the toggle button to enable the field.

   This option allows you to customize the distribution file, in which you can:

   • Add a custom name, with multilingual options.

   • Add Global Variables and Special Variables.

     Example

     Invoice by Customer @@CURYEAR Period @@UDM_CURPER

     Note

     Uppercase and lowercase letters (A-Z, a-z), digits (0-9), and the underscore (_) symbol cannot be attached at the end of a global variable name.

     Important

     Windows files do now allow the following characters: " \ / : | < > * ?. If these characters are present in the custom name, the distribution job will fail.

     If a file with the specified name already exists, it will be overwritten.

     Global Variables and Special Variables will be resolved based on the default environment only: Admin for OnPremise, and ADMCA for CloudMode.

5. Next, you can define which sheets in the file to distribute in the Sheets field. You can select them all with the All sheets toggle.

6. In the Format field, select the output format:

   • Excel: Excel file with the values only, all the formulas are removed.

   • PDF: Generic static PDF file.

   • CSV: Comma-separated values (excel format).

   • Excel Add-in: Excel file including all the Add-in formulas. The calculation mode will be set to manual.

   Note

   If you select Excel or Excel Add-In in the drop-down list, the Reporting Tree feature becomes available. When enabled, it replaces the one distribution file per value slider with one sheet per Reporting Tree node slider. The one sheet per Reporting Tree node slider will remove the Cell Value input column and generate Excel sheets based on the Nodes of the Reporting Tree you set as Distributable in the Administration section.

7. In the Protection field, activate the option and enter the password that will unlock the files. Excel and PDF files can be password protected.

8. In the Execution timeout field, set the maximum number of minutes that Nectari will wait before canceling.

9. To send a parameter to the Add-in report:

   1. Click

   2. In the first drop-down list, select the sheet in which the parameter will be used.
   3. In the second field, enter the location the parameter will be sent to (this can be either a cell number or the cell name).

   4. In the last field, enter the value to assign to the cell.

   Note

   Global Variables can be used instead of typing the value in manually.

   A parameter value can overwrite existing data in the Excel file within the cell.

   Example

   In the Job Properties window:
   

   In the Worksheet, the name is Site and the cell number B1.
   

10. Click Save.

Consolidated Report

The Consolidated Report tab allows users to merge multiple views (either web-based or Excel Add-In views) into one consolidated PDF report.

Fields and Values

• Name - Text field where users can enter the name of their consolidated report; users can access the translation window to add translations for the name of their consolidated report by clicking the button.

  

• Cover Page - Toggle that allows users to add a cover page to their consolidated report; if activated, users can click the edit button (pencil icon) to the right of the toggle to access the Cover Page editing window.

  

• Table Of Contents - Toggle that allows users to add a table of contents to their consolidated report; if activated, Nectari automatically generates a table of contents based on the items that were added to the Web Views and Excel Add-in Views tabs; the table of contents appears after the cover page (if enabled) and before the first page of the consolidated report.

  Tip

  You can re-order of the elements (i.e., Views, Dashboards, Reports) in the list by dragging and dropping them in the desired location.

• Page Setup - Allows users to configure the page setup of their cover page and table of contents.

  

The following fields are displayed in the Page Setup window:

• Orientation - Allows the user to define whether the final consolidated report will be displayed in portrait or landscape orientation.

• Paper Size - Allows the user to set a standardized page size (i.e., width and height) for their consolidated report; users can also define a width and height manually by selecting the Custom Size option then entering the desired values in the Width and Height fields.

• Unit - Allows the user to define the unit of measurement (i.e., centimetres or inches) to be used across all aspects of the consolidated report

• Width - Field that represents the width of the consolidated report; its value will update automatically depending on the options selected in the previous three fields, however, users will only be able to change the value manually if the Custom Size option is selected in the Paper Size field.

• Height - Field that represents the height of the consolidated report; its behaviour is identical to the Width field.

• Font Size - Allows the user to change the font size of their consolidated report text.

• Page Number - Allows the user to add page numbers to their consolidated report; the user can also select a page number position from the drop-down list; cover pages and tables of content are included in the page numeration, and the page number will appear on those pages (if applicable).

• Margins - Allows users to configure the margins of their consolidated report. The tab also provides a simplified margin preview in the centre of the Page Setup window which updates in real time based on the values entered by the user.

  • Top, Left, Right and Bottom - Fields that allow the user to define the distance between their consolidated report content and the border of the page in all four directions.

  • Default - Button that causes all consolidated report margins to revert to their initial, default values.

Users and Groups

In the Users and Groups tab, the user can select the users and/or groups to receive automatic emails generated by the Job. At least one user needs to be selected in order for the Job to be saved.

The Distribution will execute the view for each user or group defined, according to the security defined for them. If a view is sent to a group, only the users with the proper access will receive it, and the data in the views sent will also reflect the security access of the users, meaning that individual users may receive very different results.

It also takes into consideration the local settings of each user, for instance, sending the information in English for an English defined user or French for a French defined user, etc.

To send emails to Nectari users:

1. Select a user from the table on the left.
2. Click the arrow to move the user to the table on the right.
3. (Optional) Drag the Run As slider to the right.
4. Click Save.
5. Go to the Email tab to write the body of your message and the subject.

To send emails to unregistered (external) users:

1. Drag the Run As slider to the right.
2. Add their emails into the To, Cc or Bcc fields.
3. Click Save.
4. Go to the Email tab to write the body of your message and the subject.

Conditions

This tab allows you to add a condition to the Data Model where the View is extracted.

Scenario

You receive invoices every day, but only want to receive the ones from the previous day. Based on that principle, you set up the Distribution to generate a report only if that data exists. In this example, you would select an Invoice By Customer view and apply a filter from the Web Views tab to display only the data from the day before. Then you would add the following condition:

1. Click Add Condition.
2. Click to enter your SQL condition into the Restriction Builder and click on Save.
3. Click Confirm to finish.

Email

Use this tab to add a message (Description) and a Subject to the email sent by the Distribution.

If you want to send emails to unregistered users, you can add their emails into the To, Cc or Bcc fields in the Users and Groups tab.

You can also use Global Variables and Special Variables within the Header and the Body of the email. Note that the variables will be resolved based on the running user with the default environment.

Schedule

• Set which frequency the Job should be performed and click Save to finish.