.. _Advanced_Settings:

=================
Advanced Settings
=================

The **Advanced Settings** page allows user to


* manage the list of data source categories
* update system settings in related groups

Steps to config Advanced Settings
--------------------------------------

#. In browser, log in to Izenda as a user with Advanced Settings
   permission.
#. Click Settings, then Data Setup then Advanced Settings in the left
   menu.
#. Select the Setting Level: either System or a specific tenant.
#. Click on a tab to view values.

#. Hover on information icon following the value name to see the brief guide of that value

   .. figure:: /_static/images/Advanced_Settings_Performance_Hover_Brief_Guide.png
      :align: center
      :width: 1001px

      Brief guide of a configuration option.

#. Update the values.
#. Click Save button at the top to save the whole settings.

Update Performance Settings
------------------------------------

In Advanced Settings page, click on Performance tab in Middle Panel to view the items. The Performance items are list as below:

   .. figure:: /_static/images/Advanced_Settings_Performance.PNG
      :align: center
      :width: 1653px

      Setting values provied in Performance tab

  .. list-table::
      :widths: 20 65 15
      :header-rows: 1

      *  -  Section
         -  Purpose
         -  Default Value
      *  -  Query Timeout
         -  To limit the duration of all queries in any page.
         -  3600
      *  -  Use No Lock
         -  To not use NOLOCK (dirty read) statement when querying data.
         -  True
      *  -  Data Source Limit
         -  To limit the number of data sources in a single report.
         -  1000
      *  -  Field Limit
         -  To limit the number of fields in a report part.
         -  1000
      *  -  Query Limit
         -  To limit the number of values returned from the query in Report Designer, Report Viewer, Dashboard and Export.
         -  100000
      *  -  Pivot Column Limit
         -  Limit the number of columns in a pivot report part.
         -  100000
      *  -  Filter Limit
         -  Limit the number of items displayed in Filter Value dropdown
         -  1000

.. note::

   The Use No Lock setting instructs the database engine to return the current version of data immediately, instead of waiting for all pending transactions to complete. Check the possible consequences `here <https://www.izenda.com/blog/high-performance-sql-views-using-withnolock/>`__ before using this option.

Update Security Settings
--------------------------
In Advanced Settings page, click on Security tab in Middle Panel to view the items. The Security items are listed as below:

   .. figure:: /_static/images/Advanced_Settings_Sercurity.PNG
      :align: center
      :width: 1421px

      Setting values provied in Security tab

Update common settings
***********************************

   *  Tick on Show Tenant Field checkbox will show the field(s) which is(are) sepcififed in Tenant Field in report/dashboard. Otherwise, those fields will be hidden.

   * For security in multi-tenant systems, set up **Tenant Field** then all reports and dashboards will automatically restrict data retrieval to only that of the current tenant. To enable this feature:

      \- Input the name of tenant id field into the Tenant Field box |br|
      \- The Tenant Field must be enclosed in brackets: [fieldname] |br|
      \- Press **Enter** to add tenant field  |br|
      \- You can use multiple tenant fields 

   * Tick on Render HTML in Printing/Exporting checkbox will allow HTML tags to be rendered when exporting and printing.

   * Tick on Render HTML in Report Viewer checkbox will allow HTML tags to be rendered when viewing reports in browser.

Add Row-Level security rules
***********************************

   #. In browser, log in to Izenda as a System Admin and go to Settings, then Data Setup, Advanced Settings in the left
      menu, and Security in the middle panel.
   #. Click Add button in Row-Level Security section

      .. figure:: /_static/images/data_security/data_security_001.PNG
         :width: 940px

   #. Choose one or more available data sources and click Next to go to Step 2

      .. figure:: /_static/images/data_security/data_security_002.PNG
         :width: 896px

   #. Choose one or more available fields and click Next to go to Step 3

      .. figure:: /_static/images/data_security/data_security_003.PNG
         :width: 896px

   #. Type Name and Descitption (optional) for the data security rule set.
   #. Click Add Rule and configure new data security rule.
   #. Select one of the existing User Groups (Everyone, User or Role)

      .. figure:: /_static/images/data_security/data_security_004.PNG
         :width: 896px

   #. Select some specific users or roles if you selected the corresponding values in the previous step.
   #. Type any value and press Enter to Values or select one of the preset values like
      - [All] - all values
      - [Tenant ID] - the current Tenant ID
      - [Tenant Name] - the current Tenant Name
      - [Role Name] - any role name of the current user
      - [User ID] - the current User ID
   #. Select access mode: Block or Allow

      .. figure:: /_static/images/data_security/data_security_005.PNG
         :width: 896px

   #. Add more rules if necessary.
   #. Click Save and then OK  on the pop-up info message about the impact of the current changes

      .. figure:: /_static/images/data_security/data_security_006.PNG
         :width: 872px

   #. Add more data security rule sets if necessary or edit/clone/delete some of the existing rule sets.
   #. Click Save at the top-right corner to save security settings

      .. figure:: /_static/images/data_security/data_security_007.PNG
         :width: 938px

   |br|

   After that, if you create a new report with fields to which blocking rules are applied or open an existing one, and print or export it, then you will see masked data instead of the actual values

      .. figure:: /_static/images/data_security/data_security_008.PNG
         :width: 631px

Update Categories Settings
---------------------------

.. _Add_data_source_categories:

Add data source categories
***************************

   A category should be added before showing up for assignment to a data
   source.

   #. In browser, log in to Izenda as a user with Advanced Settings
      permission.
   #. Click Settings, then Data Setup then Advanced Settings in the left
      menu.
   #. Select the Setting Level: either System or a specific tenant.
   #. .. _Menu_Advanced_Settings_Category:

      .. figure:: /_static/images/Menu_Advanced_Settings_Category.jpg
         :align: right
         :width: 391px

         Category Menu

      Click Category in the Middle Panel. (:numref:`Menu_Advanced_Settings_Category`) |br|
   #. Click Add New + button and type the name into the new text box. (:numref:`Settings_Category_Add_New`)

      .. _Settings_Category_Add_New:

      .. figure:: /_static/images/Settings_Category_Add_New.jpg
         :width: 622px

         Add New button |br|
   #. Continue to click Add New + button to enter more categories.
   #. Click Save button at the top to save the whole list.

   .. note::

      User will not be able to save the list unless there is no duplication.

Delete data source categories
******************************

   #. In the category list, click the delete icon (x) on the right of each category to delete it. (:numref:`Settings_Category_Delete`)

      .. _Settings_Category_Delete:

      .. figure:: /_static/images/Settings_Category_Delete.jpg
         :width: 621px

         Delete icon |br|
   #. Click OK in the pop-up confirmation. (:numref:`Category_Deletion_Confirmation`)

      .. _Category_Deletion_Confirmation:

      .. figure:: /_static/images/Category_Deletion_Confirmation.jpg
         :width: 456px

         Delete confirmation |br|
   #. The category is deleted immediately.

         The Save and Cancel buttons at the top does not have any effect in this action.

   .. note::

      The category will be deleted even if it has been assigned to data sources. After that these data sources will have no category.

   .. note::

      To change the name of a category, the `Rename data source categories`_ feature should be used instead.

Rename data source categories
******************************

   Renaming a category will only change the name and keep the assignments
   to data sources intact.

   #. In the category list, click the text box of any category and change the name. (:numref:`Settings_Category_Rename`)

      .. _Settings_Category_Rename:

      .. figure:: /_static/images/Settings_Category_Rename.jpg
         :align: right
         :width: 617px

         Rename categories |br|
   #. Continue to change more category names
   #. Click Save button at the top to save the whole list.

.. _Advanced_Settings_Others:

Update Others Settings
-----------------------

In Advanced Settings page, click on Others tab in Middle Panel to view the items. The Others items are listed as below:

   .. figure:: /_static/images/Advanced_Settings_Others.PNG
      :align: center
      :width: 1649px

      Setting values provided in Others group

  .. list-table::
      :widths: 20 65 15
      :header-rows: 1

      *  -  Section
         -  Purpose
         -  Default Value
      *  -  Sort Colum Name 
         -  When unselected fields in field tab of report designer, join dropdown and input paramters in filters sort alphabecitally. When selected, these fields sort based on position in the databse.
         -  0
      *  -  Trim Time In Joins 
         -  Tick on this checkbox to trim the time portion form the Date Time field in each join statement in Report Designer - Relationship page. Otherwise, system will use Date Time field in each sort statement
         -  True
      *  -  Timezone for Data Offset 
         -  To set default value for the Timezone Data Offset in Settings > User Setup page. And this setting will effect to displayed data value of Datetime/Time fields in the report part. **As of v2.9.5 offset will accept partial hours as .25, .5 or .75** |br|
            For example: |br|
            In database the data value is 11:00. If user sets “5” in the textbox of this section then the data value will be shown as 16:00 in the report part.
         -  0
      *  -  Timezone for Timestamp Offset
         -  To set default value for the Timezone Data Offset in Settings > User Setup page. And this setting will effect to all Datetime/Time field in system. **As of v2.9.5 offset will accept partial hours as .25, .5 or .75** |br|
            For example: |br|
            The created date of report is 11:00. If user sets “5” in the textbox of this section then the created date will be shown as 16:00 in the system. 
         -  0
      *  -  Convert Null to Empty String
         -  Tick on this checkbox to convert all null values to blank (empty) in reports or dashboards. Otherwise, null values keep the orginal values.
         -  False
      *  -  Show Schema Name
         -  Tick on this checkbox to show schema name together with the the data source name in any place. Otherwise, the schema name will be hidden
         -  False
      *  -  Show Introduction Text
         -  To show the Introduction Text in the following section: |br|
            \- Report Designer > Data Source tab > Content Panel > under Report Name |br|
            \- Report List > Content Panel > under each report name
         -  False
      *  -  Send to Disk Path
         -  To define the path to save files for all Scheduled/Subcribed instances with **Send to Disk** delivery method, input path in the textbox of that section.

            .. note::

               * When the report is saved into this location, system will save report name together data time so that saving the new version of this report will not overwrite this report. The format when saved: <report name>_<mmddyyyy>_<hhmmss>

               * **For example:** |br|
                 If report “ABC” is saved to disk path at 10/22/2016, 23:59:00 then the report will be saved with name = ABC_10222016_235900
         -  Null
      *  -  Determine common filter for the same field based on
         -  To determine how the filters considered whether different or the same in the dashboard so they will be common filter and shown in dashboard filter section or not. There are three available options: |br|
            \- Same field of the same data object from the same database schema |br|
            \- Same field name regardless of database schema or connection string |br|
            \- Same alias name regardless of database schema or connection string |br|

            .. note:: 

               Stored Procedure stored procedures input parameters are only considered common when they are from the same stored procedure.
            
            Please see :ref:`Dashboard_Filters` for more details about common filter in dashboard.
         -  Same field of the same data object from the same database schema
      *  -  Allow Multiple Sorts on Grid Header
         -  By selecting this checkbox, user can sort on multiple columns when clicking on Grid header in Vertical/Horizontal report. Otherwise, user can only sort by one column at a time.
         -  True
      *  -  Show Preview section in Configuration Mode
         -  By selecting this checkbox, both Configuration and Preview sections display in the report part’s backside and setting popups. Otherwise, system only shows Configuration section. This is useful when working with very large datasets as the database is not called until the report part is flipped to the front side.
         -  True
      *  -  Hide report header and footer by default
         -  By selecting this checkbox, report header and footer sections are hidden in both Report Viewer and Report Designer - Design. Otherwise, these sections are displayed by default (if any).
         -  False

Cancel the changes
-------------------

.. _Settings_Cancel_Confirmation:

.. figure:: /_static/images/Cancel_Confirmation.jpg
   :align: right
   :width: 465px

   Cancel confirmation pop-up

To cancel any changes without saving:

#. Click the Cancel button at the top.
#. Click OK in the confirmation pop-up. (:numref:`Settings_Cancel_Confirmation`) |br|

See also
--------

-  :ref:`Data Model - Assign a category to a table, view or stored procedure <Assign_a_category_to_a_table_view_or_stored_procedure>`