# Global settings



# Tenants

## Definition

<p class="callout success">Soffid 3 is multi tenant. This means that one can configure many differente tenants to manage disjoints groups of identities and applications. </p>

Each Soffid object, including applications, systems, roles, users, and accounts are bound to a single tenant.

Of course, there is a special tenant named master. Master tenant administrators can jump to any other tenant with administration privileges.

<p class="callout info">Soffid recommends connecting directly to the specific tenant to configure it correctly. You have more information about this topic in the [Tenant access section](#bkmrk-tenant-access).</p>

## Screen overview

<iframe allowfullscreen="allowfullscreen" height="314" src="//www.youtube.com/embed/H8tL8n_jkxM?rel=0" width="560"></iframe>

## Tenant properties

- **Name:** Set a short name for the tenant.
- **Description:** Enter a long description for the tenant
- **Enabled:** Usually set to yes. If it's set to NO, no user will be able to log in to that tenant, and no provisioning or automated task will be ran on that tenant.
- **Disabled permissions:** By default, tenant administrator permissions are restricted, so they are not able to bypass tenant borders and access to other tenant information. To achive this, the following permissions are disabled by default, but some others can be added: 
    - Open the tenants management page
    - Use the tenant micro-service
    - Manage sync servers
- **Assigned sync servers**: By default, the new tenant will not be able to use any sync server unless it is authorized to. So, one can create a sync server for a specific tenant that cannot be used by any other tenant.

## Actions

The following actions can be performed on tenants:

<table border="1" id="bkmrk-apply-changes-allow-" style="height: 150px;"><tbody><tr style="height: 58px;"><td style="width: 141px; height: 58px;">**Export a tenant**

</td><td style="width: 668px; height: 58px;">The process will generate a compressed file with all the information contained in the Tenant. It includes even the connectors configurations, mappings and global settings.

</td></tr><tr style="height: 57px;"><td style="width: 141px; height: 57px;">**Import a tenant**

</td><td style="width: 668px; height: 57px;">The user can upload the previously exported tenant. The process will restore all the information contained in the Tenant, including connectors configurations, mappings and global settings.If the Tenant already exists, the process will not replace it. A new tenant will be created with a new name. If you want to replace the existing tenant, remove it before uploading the tenant export file.

</td></tr><tr style="height: 35px;"><td style="width: 141px; height: 35px;">**Log into a tenant**

</td><td style="width: 668px; height: 35px;">If you have permission to log into a different tenant, you can use this option to access to it. This option is not intended for normal usage, but for administrative purposes

</td></tr></tbody></table>

## Tenant access

##### Option 1

When users are connecting to Soffid console, the master tenant is displayed by default. In order to directly connect to any tenant, a DNS entry with the tenant name must be added to your DNS server.

For instance, if you have deployed a Soffid console with the DNS name soffid.mycompany.com, the DNS name **test1.soffid.mycompany.com** will be used to access to the **test1** tenant.

<p class="callout warning">Note that you must configure the **hostName** Soffid parameter in the master with your DNS name</p>

[![image-1651502621836.png](https://bookstack.soffid.com/uploads/images/gallery/2022-05/scaled-1680-/image-1651502621836.png)](https://bookstack.soffid.com/uploads/images/gallery/2022-05/image-1651502621836.png)

##### Option 2

You can also configure the login page using the **soffid.auth.showTenant** Soffid parameter. If the parameter value is true, Soffid will display a new box in the login page to write the tenant name to login.

[![image-1650618939472.png](https://bookstack.soffid.com/uploads/images/gallery/2022-04/scaled-1680-/image-1650618939472.png)](https://bookstack.soffid.com/uploads/images/gallery/2022-04/image-1650618939472.png)

[![image-1650618974134.png](https://bookstack.soffid.com/uploads/images/gallery/2022-04/scaled-1680-/image-1650618974134.png)](https://bookstack.soffid.com/uploads/images/gallery/2022-04/image-1650618974134.png)

###   

# Plugins

## Definition

<p class="callout success">Soffid provides you additional functionality that allows installing addons and server plugins. There are two main types of addons: **system connectors** and **console addons**.</p>

<p class="callout info">You can download existing addons and plugins developed by Soffid by visiting [http://download.soffid.com/download](http://download.soffid.com/download) or [http://download.soffid.com/download/enterprise](http://download.soffid.com/download/enterprise) if you have a Soffid user with authorization.</p>

<p class="callout info">Addons and plugins can be developed using [Addon Development Guide.](https://bookstack.soffid.com/books/addon-development-getting-started "Addon development Getting started") </p>

> An addon or plugin, must be upload into a **Master** tenant, the other tenant will inherit these installed addons and plugins.

#### System connectors

Also referred as plugins, there are little pieces of software able to manage identities on some type of systems. They can be generic plugins (SQL or LDAP plugins) or custom specific plugins.

The system connector is configured when the administrator creates an agent. An agent can be viewed as a configured instance of a plugin.

In order to upgrade existing (running) plugins, the synchronization server that hosts this plugin must be restarted from the system monitoring screen.

#### Console addons

Add important features to Soffid console. A console addon can contain common classes, data models, transactional services, web services, and web interfaces.

In order to apply addon changes, the console must be restarted. It can be restarted from this page by clicking on the restart console button.

<p class="callout success">From the addon management screen, you will be able to upload and upgrade server plugins, as well and enable or disable them.</p>

## Screen overview

<iframe allowfullscreen="allowfullscreen" height="314" src="//www.youtube.com/embed/vbgFRu7w22o?rel=0" width="560"></iframe>

## Related objects

1. **[Tenants](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/tenants "Tenants")**
2. [**Agents**](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/agents "Agents"): is used to configure a system connector.

## Standard attributes

- **Plugin**: identified name of the plugin or addon deployed.
- **Version**: version of the plugin or addon.
- **Deployed by**: user that deployed the addon or plugin.
- **Date**: date and time of the deployment.
- **Enabled**: if enabled is Yes, the plugin or addon will be available to use it.
- **Components**: component list that make up the plugin or addon.

## Actions

#### Plugins query actions

<table border="1" id="bkmrk-apply-changes-allow-" style="width: 807px; height: 117px;"><tbody><tr style="height: 29px;"><td style="width: 144px; height: 29px;">**Add new**

</td><td style="width: 663px; height: 29px;">Allows you to upload and install a new plugin or addon. You can choose that option on the hamburger menu or click the add button (+).

You must pick a file, that file has to be a valid add-on or plugin. Once the file is selected, it will be uploaded automatically. Then, you must restart the Sync server or Console depending on the uploaded plugin

</td></tr><tr style="height: 29px;"><td style="width: 144px; height: 29px;">**Delete**

</td><td style="width: 663px; height: 29px;">Allows you to delete one or more plugins or addons, you must select one or more records from the list and click the button with the subtraction symbol (-).

To perform that action, Soffid will ask you for confirmation, you could confirm or cancel the operation.

</td></tr><tr style="height: 30px;"><td style="width: 144px; height: 30px;">**Restart Console**

</td><td style="width: 663px; height: 30px;">Allows you to restart the console to apply addon changes. That operation will be mandatory when you load an addon.

</td></tr><tr style="height: 29px;"><td style="width: 144px; height: 29px;">**Download CSV file**

</td><td style="width: 663px; height: 29px;">Allows you to download a CSV file with all the information about plugins and addons.

</td></tr></tbody></table>

#### Plugins detail actions

<table border="1" id="bkmrk-apply-changes-allows" style="height: 87px;"><tbody><tr style="height: 29px;"><td style="width: 143px; height: 29px;">**Apply changes**</td><td style="width: 664px; height: 29px;">Allows you to update the plugin. Only Enabled attribute can be modified. Once you apply changes, the plugin details page will be closed.</td></tr><tr><td style="width: 143px;">**Save**</td><td style="width: 664px;">Allows you to update the plugin. Only Enabled attribute can be modified.</td></tr><tr style="height: 29px;"><td style="width: 143px; height: 29px;">**Delete**</td><td style="width: 664px; height: 29px;">Allows you to delete and desinstall a specific plugin. To delete a plugin, you can click on the hamburger icon and then click the delete button (trash icon).

Soffid will ask you for confirmation to perform that action, you could confirm or cancel the operation.

</td></tr><tr style="height: 29px;"><td style="width: 143px; height: 29px;">**Undo**</td><td style="width: 664px; height: 29px;">Allows you to undo any changes.</td></tr></tbody></table>

# Look & feel

## Definition

<p class="callout success">Soffid's Look &amp; feel page allows you to adjust the Console styles to your organization.</p>

In this configuration page, the customization of three sections is allowed:

- You can change the colors of the Soffid components and text.
- You can change the image of the logo that appears on the login page.
- You can change the image of the logo that appears in the header.
- Changes made on this page affect the entire Console.

<p class="callout warning">Some changes may require updating the browser several times because some items are in the browser's cache.</p>

## Overview

[![image-1669823122561.png](https://bookstack.soffid.com/uploads/images/gallery/2022-11/scaled-1680-/image-1669823122561.png)](https://bookstack.soffid.com/uploads/images/gallery/2022-11/image-1669823122561.png)

## Actions

<table border="1" id="bkmrk-apply-changes-allow-"><tbody><tr><td style="width: 157px;">**Reset values**

</td><td style="width: 652px;">Allows you to return to the default Soffid values.

</td></tr><tr><td style="width: 157px;">**Confirm changes**

</td><td style="width: 652px;">Allows you to apply the changes made.

</td></tr><tr><td style="width: 157px;">**Pick a file**

</td><td style="width: 652px;">Allows you to pick a file to load. The file must have a specific configuration

</td></tr></tbody></table>

# Soffid parameters

## Definition

<p class="callout success">Soffid allows you to customize the configuration of some attributes of the Console, Syncserver, connectors and add-ons.</p>

There are several types of parameters.

- Informative parameters, such as the versions of internal components of Soffid.
- Parameters used as attributes in Soffid screens, such as the values of the look &amp; feel fields.
- There are also parameters that can be modified, such as some configuration data for the synchronization server.
- There are new attributes that can be included to expand the functionality of Soffid, such as mail server data.

<p class="callout info">If you want to know the Soffid console version check the **component.iam-core.version** parameter.</p>

## Screen overview

[![image-1711093394363.png](https://bookstack.soffid.com/uploads/images/gallery/2024-03/scaled-1680-/image-1711093394363.png)](https://bookstack.soffid.com/uploads/images/gallery/2024-03/image-1711093394363.png)

## Standard attributes

- **Name**: code used to identify the parameter.
- **Value**: parameter value.
- **Network** (optional): network to which this parameter would be assigned.
- **Description** (optional): a brief description of the parameter.

## Actions

#### Soffid parameters query actions

<table border="1" id="bkmrk-query-allows-to-sear-0" style="height: 132px;"><tbody><tr style="height: 45px;"><td style="width: 208px; height: 45px;">**Add new**

</td><td style="width: 601px; height: 45px;">Allows you to add a new Soffid parameter. You can choose that option on the hamburger menu or clicking the add button (+).

To add a new parameter it will be mandatory to fill in the required fields.

</td></tr><tr style="height: 29px;"><td style="width: 208px; height: 29px;">**Delete**

</td><td style="width: 601px; height: 29px;">Allows you to delete one or more Soffid parameters by selecting one or more records and next clicking the button with the subtraction symbol (-).

To perform that action, Soffid will ask you for confirmation, you could confirm or cancel the operation.

</td></tr><tr style="height: 29px;"><td style="width: 208px; height: 29px;">**Import**

</td><td style="width: 601px; height: 29px;">Allows you to upload a CSV file with the parameter list to add, update or delete parameters to Soffid.

First, you need to pick up a CSV file, that CSV has to contain a specific configuration. Then you need to check the content to be loaded, it is allowed to choose if you want or not to load a specific attribute. And finally, you need to select the mappings for each column of the CSV file to import the data correctly and to click the Import button.

To delete a parameter, the values of the parameter have to be empty

```
"Parameter","Network","Value","Description"
"addon.backup.test","","",""
```

</td></tr><tr style="height: 29px;"><td style="width: 208px; height: 29px;">**Download CSV file**

</td><td style="width: 601px; height: 29px;">Allows you to download a csv file with the basic information of all Soffid parameters.

</td></tr></tbody></table>

#### Soffid parameters detail actions

<table border="1" id="bkmrk-apply-changes-allow-" style="border-collapse: collapse; border-width: 1px;"><tbody><tr><td style="width: 210px;">**Apply changes**

</td><td style="width: 598px;">Allows you to save the data of a new parameter or to update the data of a specific parameter. To save the data it will be mandatory to fill in the required fields.

</td></tr><tr><td style="width: 210px;">**Delete**

</td><td style="width: 598px;">Allows you to delete a specific Soffid parameter. To delete a host you can click on the hamburger icon and then click the delete button (trash icon).

Soffid will ask you for confirmation to perform that action, you could confirm or cancel the operation.

</td></tr><tr><td style="width: 210px;">**Undo**

</td><td style="width: 598px;">Allows you to quit without applying any changes.

</td></tr></tbody></table>

## List of parameters sorted by functionality

### Console

<table border="1" class="wrapped confluenceTable tablesorter tablesorter-default" id="bkmrk-parameter-descriptio" role="grid" style="height: 1813.49px; border-collapse: collapse;"><colgroup><col style="width: 27.284%;"></col><col style="width: 72.5926%;"></col></colgroup><thead><tr class="tablesorter-headerRow" role="row" style="height: 29.6806px;"><th aria-disabled="false" aria-label="Parameter: Ascending sort applied, activate to apply a descending sort" aria-sort="ascending" class="confluenceTh tablesorter-header sortableHeader tablesorter-headerAsc" data-column="0" role="columnheader" scope="col" style="height: 29.6806px; width: 221px;" tabindex="0"><div>**Parameter**</div></th><th aria-disabled="false" aria-label="Description: No sort applied, activate to apply an ascending sort" aria-sort="none" class="confluenceTh tablesorter-header sortableHeader tablesorter-headerUnSorted" data-column="1" role="columnheader" scope="col" style="height: 29.6806px; width: 588px;" tabindex="0"><div>**Description**</div></th></tr></thead><tbody aria-live="polite" aria-relevant="all"><tr role="row" style="height: 57.6667px;"><td class="confluenceTd" style="height: 57.6667px; width: 221px;">soffid.auth.system

</td><td class="confluenceTd" style="height: 57.6667px; width: 588px;">Select the managed system where the account name will be searched on the user login. Defaults to soffid.

</td></tr><tr role="row" style="height: 57.6667px;"><td class="confluenceTd" style="height: 57.6667px; width: 221px;">soffid.auth.trustedLogin

</td><td class="confluenceTd" style="height: 57.6667px; width: 588px;">Set to true to enable the Soffid console to validate passwords on trusted systems. Setting it to false, the password will be validated against internal tables only.

</td></tr><tr role="row" style="height: 35.2778px;"><td class="confluenceTd" style="height: 35.2778px; width: 221px;">soffid.delegation.disable

</td><td class="confluenceTd" style="height: 35.2778px; width: 588px;">Set to true to prevent users to delegate permissions from self service page.

</td></tr><tr role="row" style="height: 148.833px;"><td class="confluenceTd" style="height: 148.833px; width: 221px;">soffid.entitlement.group.holder

</td><td class="confluenceTd" style="height: 148.833px; width: 588px;">Set to **optional** enables the operator to set a group as the group holder for any entitlement assignment.

Set to **always** enforce that any entitlement assignment must be bound to a holder group.

Set to **none** to disable this feature.

<p class="callout info">This parameter affects to [role holder](https://bookstack.soffid.com/link/62#bkmrk-%C2%A0-1)</p>

</td></tr><tr role="row" style="height: 35.2778px;"><td class="confluenceTd" style="height: 35.2778px; width: 221px;">soffid.language

</td><td class="confluenceTd" style="height: 35.2778px; width: 588px;">Enforce user interface language.

</td></tr><tr role="row" style="height: 35.2778px;"><td class="confluenceTd" style="height: 35.2778px; width: 221px;">soffid.language.default

</td><td class="confluenceTd" style="height: 35.2778px; width: 588px;">Default user interface language (en).

</td></tr><tr role="row" style="height: 57.6667px;"><td class="confluenceTd" style="height: 57.6667px; width: 221px;">soffid.network.internet

</td><td class="confluenceTd" style="height: 57.6667px; width: 588px;">Sets the name for a generic subnet that will hold any host not included on any listed network.

</td></tr><tr style="height: 374.347px;"><td style="width: 221px; height: 374.347px;">soffid.proxy.trustedIps

</td><td style="width: 588px; height: 374.347px;">Set the IP address of any reverse proxy in front of Soffid servers.  
When an incoming request is made from any of these trusted IP addresses, the X-Forwarded-for header is taken as the real source IP of the request. In any other case, the X-Forwarded-for header is ignored.

This parameter can take a list of IP addresses, separated by commas, like the following ones:

- 127.0.0.1
- 192.168.120.1, 192.168.120.2

To allow a range of network IPS, one can use the wildcard(\*) symbol, as in the following example:

- 127.0.0.1, 192.168.120.\*

Starting with Soffid console 3.3.0, the network-address/bits notation is allowed, as in the following example:

- 127.0.0.1, 192.168.120.128/25

</td></tr><tr role="row" style="height: 57.6667px;"><td class="confluenceTd" style="height: 57.6667px; width: 221px;">soffid.propagate.timeout

</td><td class="confluenceTd" style="height: 57.6667px; width: 588px;">Timeout in seconds to retry the password validation needed to propagate a managed system notified password change (requires syncserver 1.5.4).

</td></tr><tr role="row" style="height: 35.2778px;"><td class="confluenceTd" style="height: 35.2778px; width: 221px;">soffid.server.sharedThreads

</td><td class="confluenceTd" style="height: 35.2778px; width: 588px;">Number of shared dispatcher threads per synchronization servers (by default 1)

</td></tr><tr role="row" style="height: 57.6667px;"><td class="confluenceTd" style="height: 57.6667px; width: 221px;">soffid.syslog.server

</td><td class="confluenceTd" style="height: 57.6667px; width: 588px;">Hostname or IP address of server hosts SIEM. The SIEM will receive audit information using the syslog protocol.

</td></tr><tr role="row" style="height: 80.0556px;"><td class="confluenceTd" style="height: 80.0556px; width: 221px;">soffid.task.limit

</td><td class="confluenceTd" style="height: 80.0556px; width: 588px;">The maximum number of tasks allowed per transaction. If a simple or complex transaction generates more tasks than specified, these tasks will be kept on hold. Administrators can release them through the monitoring page. (version 2.0+)

</td></tr><tr role="row" style="height: 35.2778px;"><td class="confluenceTd" style="height: 35.2778px; width: 221px;">soffid.ui.docPath

</td><td class="confluenceTd" style="height: 35.2778px; width: 588px;">The path where to store report and workflow documents.

</td></tr><tr role="row" style="height: 36.1944px;"><td class="confluenceTd" style="height: 36.1944px; width: 221px;">soffid.ui.docServer

</td><td class="confluenceTd" style="height: 36.1944px; width: 588px;">URL where is the server to store the files.

</td></tr><tr role="row" style="height: 35.2778px;"><td class="confluenceTd" style="height: 35.2778px; width: 221px;">soffid.ui.docStrategy

</td><td class="confluenceTd" style="height: 35.2778px; width: 588px;">Class responsible for managing report and workflow documents.

</td></tr><tr role="row" style="height: 35.2778px;"><td class="confluenceTd" style="height: 35.2778px; width: 221px;">soffid.ui.docTempPath

</td><td class="confluenceTd" style="height: 35.2778px; width: 588px;">The path where to store temporary files

</td></tr><tr role="row" style="height: 35.2778px;"><td class="confluenceTd" style="height: 35.2778px; width: 221px;">soffid.ui.docUsername

</td><td class="confluenceTd" style="height: 35.2778px; width: 588px;">Username of the doc server.

</td></tr><tr role="row" style="height: 35.2778px;"><td class="confluenceTd" style="height: 35.2778px; width: 221px;">soffid.ui.docUserPassword

</td><td class="confluenceTd" style="height: 35.2778px; width: 588px;">The password of the doc server.

</td></tr><tr role="row" style="height: 57.6667px;"><td class="confluenceTd" style="height: 57.6667px; width: 221px;">soffid.ui.maxrows

</td><td class="confluenceTd" style="height: 57.6667px; width: 588px;">The maximum number of rows to display in searches. The default value is 200 but you can change it.

</td></tr><tr role="row" style="height: 35.2778px;"><td class="confluenceTd" style="height: 35.2778px; width: 221px;">soffid.ui.timeout

</td><td class="confluenceTd" style="height: 35.2778px; width: 588px;">Max time (in milliseconds) a query can take to complete (version 2.0 +).

</td></tr><tr role="row" style="height: 57.6667px;"><td class="confluenceTd" style="height: 57.6667px; width: 221px;">soffid.ui.wildcarts

</td><td class="confluenceTd" style="height: 57.6667px; width: 588px;">Setting the auto value enables the user interface to add wildcards on user queries. Setting it to off disables this feature.

</td></tr><tr style="height: 35.2778px;"><td style="width: 221px; height: 35.2778px;">soffid.externalURL

</td><td style="width: 588px; height: 35.2778px;">External URL to access to Soffid console.

</td></tr><tr style="height: 57.6667px;"><td style="width: 221px; height: 57.6667px;">soffid.kerberos.agent

</td><td style="width: 588px; height: 57.6667px;">The name of the Windows server agent so that any incoming Kerberos packets will be authenticated against that domain.

</td></tr><tr style="height: 80.0556px;"><td style="width: 221px; height: 80.0556px;">soffid.pam.search.recordings.timeout

</td><td style="width: 588px; height: 80.0556px;">Timeout reached in the query, use the parameter to specify a longer timeout in milliseconds. By default, if you don't config this parameter is 60000 milliseconds.

(version 3.5.18+)

</td></tr><tr style="height: 179.653px;"><td style="width: 221px; height: 179.653px;">soffid.nameformat

</td><td style="width: 588px; height: 179.653px;">Parameter to configure how to display the users full name. Where:

- %1$s is the first name.
- %2$s is the middle name.
- %3$s is the last name

For instance:

```
%2$s %3$s, %1$s  
```

</td></tr><tr style="height: 35.2778px;"><td style="width: 221px; height: 35.2778px;">soffid.issue.next

</td><td style="width: 588px; height: 35.2778px;">Allows you to initialize the parameter to indicate what will be the ID of the next issue.

1 will be the default value.

</td></tr><tr><td style="width: 221px;">soffid.upload.maxsize

</td><td style="width: 588px;">Allows you to set a maximum value in bytes for uploading files to Soffid.  
If this parameter is not configured, the value will be 100000000 bytes (100Mb).

</td></tr></tbody></table>

### Syncserver

<div id="bkmrk-parameter-descriptio-0"><table border="1" class="wrapped confluenceTable tablesorter tablesorter-default" role="grid" style="height: 288.333px; border-collapse: collapse;"><colgroup><col style="width: 27.0667%;"></col><col style="width: 72.9195%;"></col></colgroup><thead><tr class="tablesorter-headerRow" role="row" style="height: 29.6806px;"><th aria-disabled="false" aria-label="Parameter: No sort applied, activate to apply an ascending sort" aria-sort="none" class="confluenceTh tablesorter-header sortableHeader tablesorter-headerUnSorted" data-column="0" role="columnheader" scope="col" style="width: 219px; height: 29.6806px;" tabindex="0"><div>**Parameter**</div></th><th aria-disabled="false" aria-label="Description: No sort applied, activate to apply an ascending sort" aria-sort="none" class="confluenceTh tablesorter-header sortableHeader tablesorter-headerUnSorted" data-column="1" role="columnheader" scope="col" style="width: 590px; height: 29.6806px;" tabindex="0"><div>**Description**</div></th></tr></thead><tbody aria-live="polite" aria-relevant="all"><tr role="row" style="height: 63.2639px;"><td class="confluenceTd" style="width: 219px; height: 63.2639px;">SSOServer</td><td class="confluenceTd" style="width: 590px; height: 63.2639px;">This parameter indicates which server acts on the workstations that run SSO. This parameter can have different values for any subnet. So you can define ESSO servers allowed for any subnet.</td></tr><tr role="row" style="height: 46.4722px;"><td class="confluenceTd" style="width: 219px; height: 46.4722px;">seycon.https.port</td><td class="confluenceTd" style="width: 590px; height: 46.4722px;">Port where synchronization server connects to. This parameter is used by ESSO clients to connect to synchronization servers.</td></tr><tr role="row" style="height: 85.6528px;"><td class="confluenceTd" style="width: 219px; height: 85.6528px;">seycon.server.list </td><td class="confluenceTd" style="width: 590px; height: 85.6528px;">Shows where Syncserver and SyncServer backup is installed. When installing the first server synchronization, this parameter is automatically updated. If you want to install a synchronization server backup you must update this parameter manually. Note that proxy synchronization servers are not on this list. See the [Soffid installation guide.](https://bookstack.soffid.com/books/installation/page/getting-started "Getting started")</td></tr><tr style="height: 63.2639px;"><td style="width: 219px; height: 63.2639px;">soffid.sync.engine.threads</td><td style="width: 590px; height: 63.2639px;">This parameter allows you to configure the number of threads available to run the tasks. If you do not fill this parameter, Soffid will run 1 thread for every 50 systems, but never more than twice the number of CPUs of the server. The value of the parameter must be equal or greater than 1. (Available in Sync Server version 3.5.15+)

</td></tr></tbody></table>

</div>### Mail server

<table border="1" class="wrapped confluenceTable tablesorter tablesorter-default" id="bkmrk-parameter-descriptio-1" role="grid" style="height: 313.3px; border-collapse: collapse;"><colgroup><col></col><col></col></colgroup><thead><tr class="tablesorter-headerRow" role="row" style="height: 35.4625px;"><th aria-disabled="false" aria-label="Parameter: No sort applied, activate to apply an ascending sort" aria-sort="none" class="confluenceTh tablesorter-header sortableHeader tablesorter-headerUnSorted" data-column="0" role="columnheader" scope="col" style="width: 218px; height: 35.4625px;" tabindex="0">**Parameter**

</th><th aria-disabled="false" aria-label="Description: No sort applied, activate to apply an ascending sort" aria-sort="none" class="confluenceTh tablesorter-header sortableHeader tablesorter-headerUnSorted" data-column="1" role="columnheader" scope="col" style="width: 596px; height: 35.4625px;" tabindex="0">**Description**

</th></tr></thead><tbody aria-live="polite" aria-relevant="all"><tr role="row" style="height: 35.4625px;"><td class="confluenceTd" style="width: 218px; height: 35.4625px;">mail.host

</td><td class="confluenceTd" style="width: 596px; height: 35.4625px;">Host to send electronic mail messages.

</td></tr><tr role="row" style="height: 35.4625px;"><td class="confluenceTd" style="width: 218px; height: 35.4625px;">mail.from

</td><td class="confluenceTd" style="width: 596px; height: 35.4625px;">Recipient address that will be set as the email sender.

</td></tr><tr role="row" style="height: 35.4625px;"><td class="confluenceTd" style="width: 218px; height: 35.4625px;">mail.transport.protocol

</td><td class="confluenceTd" style="width: 596px; height: 35.4625px;">Set to SMTPS to get secure mail. Default value "SMTP" to use plain SMTP protocol.

</td></tr><tr role="row" style="height: 35.4625px;"><td class="confluenceTd" style="width: 218px; height: 35.4625px;">mail.auth

</td><td class="confluenceTd" style="width: 596px; height: 35.4625px;">Set to true if your mail server requires user authentication.

</td></tr><tr role="row" style="height: 35.4625px;"><td class="confluenceTd" style="width: 218px; height: 35.4625px;">mail.user

</td><td class="confluenceTd" style="width: 596px; height: 35.4625px;">Set your email user name if your mail server requires user authentication.

</td></tr><tr role="row" style="height: 35.4625px;"><td class="confluenceTd" style="width: 218px; height: 35.4625px;">mail.password

</td><td class="confluenceTd" style="width: 596px; height: 35.4625px;">Set your email password if your mail server requires user authentication.

</td></tr><tr style="height: 35.4625px;"><td style="width: 218px; height: 35.4625px;">mail.port

</td><td style="width: 596px; height: 35.4625px;">25 by default, with this parameter a new port can be set.

</td></tr><tr style="height: 29.6px;"><td style="width: 218px; height: 29.6px;">mail.smtp.sasl.enable

</td><td style="width: 596px; height: 29.6px;">Set to true to enable SASL.

</td></tr></tbody></table>

### Job notifications

<div id="bkmrk-parameter-descriptio-2"><table border="1" class="wrapped confluenceTable tablesorter tablesorter-default" role="grid" style="border-collapse: collapse;"><colgroup><col></col><col></col></colgroup><thead><tr class="tablesorter-headerRow" role="row"><th aria-disabled="false" aria-label="Parameter: No sort applied, activate to apply an ascending sort" aria-sort="none" class="confluenceTh tablesorter-header sortableHeader tablesorter-headerUnSorted" data-column="0" role="columnheader" scope="col" style="width: 215px;" tabindex="0">**Parameter**

</th><th aria-disabled="false" aria-label="Description: No sort applied, activate to apply an ascending sort" aria-sort="none" class="confluenceTh tablesorter-header sortableHeader tablesorter-headerUnSorted" data-column="1" role="columnheader" scope="col" style="width: 597px;" tabindex="0">**Description**

</th></tr></thead><tbody aria-live="polite" aria-relevant="all"><tr role="row"><td class="confluenceTd" colspan="1" style="width: 215px;">soffid.scheduler.error.notify

</td><td class="confluenceTd" colspan="1" style="width: 597px;">Users to notify when a scheduled task fails.

</td></tr><tr role="row"><td class="confluenceTd" colspan="1" style="width: 215px;">soffid.bpm.error.notify

</td><td class="confluenceTd" colspan="1" style="width: 597px;">Users to notify when a BPM task fails.

</td></tr><tr role="row"><td class="confluenceTd" colspan="1" style="width: 215px;">soffid.bpm.error.retry

</td><td class="confluenceTd" colspan="1" style="width: 597px;">Set to true to always retry any failed BPM task.

</td></tr></tbody></table>

</div>### Syncserver provisioning

<div id="bkmrk-parameter-descriptio-3"><table class="wrapped confluenceTable tablesorter tablesorter-default" role="grid" style="height: 101px;"><colgroup><col></col><col></col></colgroup><thead><tr class="tablesorter-headerRow" role="row" style="height: 29px;"><th aria-disabled="false" aria-label="Parameter: No sort applied, activate to apply an ascending sort" aria-sort="none" class="confluenceTh tablesorter-header sortableHeader tablesorter-headerUnSorted" data-column="0" role="columnheader" scope="col" style="width: 212px; height: 29px;" tabindex="0"><div>**Parameter**</div></th><th aria-disabled="false" aria-label="Description: No sort applied, activate to apply an ascending sort" aria-sort="none" class="confluenceTh tablesorter-header sortableHeader tablesorter-headerUnSorted" data-column="1" role="columnheader" scope="col" style="width: 597px; height: 29px;" tabindex="0"><div>**Description**</div></th></tr></thead><tbody aria-live="polite" aria-relevant="all"><tr role="row" style="height: 101px;"><td class="confluenceTd" colspan="1" style="width: 212px; height: 72px;">soffid.server.register</td><td class="confluenceTd" colspan="1" style="width: 597px; height: 72px;">Set to ***direct*** value to bypass standard workflow needed for a syncserver to join the syncservers security network. Otherwise, the standard approval workflow will be required(Since syncserver 2.6.0). You also can set it to ***no-direct***

</td></tr></tbody></table>

</div>### Addons

##### Federation

<table class="wrapped confluenceTable tablesorter tablesorter-default" id="bkmrk-parameter-descriptio-4" role="grid" style="height: 101px;"><colgroup><col></col><col></col></colgroup><thead><tr class="tablesorter-headerRow" role="row" style="height: 29px;"><th aria-disabled="false" aria-label="Parameter: No sort applied, activate to apply an ascending sort" aria-sort="none" class="confluenceTh tablesorter-header sortableHeader tablesorter-headerUnSorted" data-column="0" role="columnheader" scope="col" style="width: 212px; height: 29px;" tabindex="0"><div>**Parameter**</div></th><th aria-disabled="false" aria-label="Description: No sort applied, activate to apply an ascending sort" aria-sort="none" class="confluenceTh tablesorter-header sortableHeader tablesorter-headerUnSorted" data-column="1" role="columnheader" scope="col" style="width: 597px; height: 29px;" tabindex="0"><div>**Description**</div></th></tr></thead><tbody aria-live="polite" aria-relevant="all"><tr role="row" style="height: 101px;"><td class="confluenceTd" colspan="1" style="width: 212px; height: 72px;">addon.federation.essoidp</td><td class="confluenceTd" colspan="1" style="width: 597px; height: 72px;">Set the Identity Provider identifier to indicate that this will be the authentication provider.

For more information, you can visit [the How to add to ESSO a second factor of authentication page](https://bookstack.soffid.com/books/esso/page/how-to-add-to-esso-a-second-factor-of-authentication).

</td></tr></tbody></table>

## Exclude menu options

To exclude default menu options for all users of the Sofid console, the following steps can be followed

<span style="color: #a6d100; font-weight: bold; font-size: 18px;">1. </span>To exclude some menu options from your Soffid console, you must edit the **system.properties** file of this console. You can find this file in the following path: /opt/soffid/iam-console-3/conf/

<span style="color: #a6d100; font-weight: bold; font-size: 18px;">2. </span>Add the **soffid.menu.hidden** parameter to the system.properties file. The value of this parameter can be the menu options name that you can find in the [console.yaml](https://bookstack.soffid.com/attachments/63) file.

[![image-1685525691139.png](https://bookstack.soffid.com/uploads/images/gallery/2023-05/scaled-1680-/image-1685525691139.png)](https://bookstack.soffid.com/uploads/images/gallery/2023-05/image-1685525691139.png)

<span style="color: #a6d100; font-weight: bold; font-size: 18px;">3. </span>Restart the Soffid console.

# User Type

## Description

<p class="callout success">User type is the way to categorize users and allows configuring different password policies. Those policies can be more or less restrictive depending on the user's risk. For instance, internal users (automatically created) are different from external ones.</p>

Therefore, this field is very useful for the following cases:

- Sort or list the users on the user's page or in the reports
- Apply different password policies
- Apply restrictions on the synchronization of Soffid to the target systems
- Ease configuration in automatic rules or custom scripts

<p class="callout warning">Be in mind that a user always must belong to a User Type.</p>

## Overview

[![image-1669823315792.png](https://bookstack.soffid.com/uploads/images/gallery/2022-11/scaled-1680-/image-1669823315792.png)](https://bookstack.soffid.com/uploads/images/gallery/2022-11/image-1669823315792.png)

## Related objects

1. **[User](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/users)**: each user must be assigned a user type.
2. [**Account**](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/accounts "Accounts"): the shared or privileged accounts also require having selected a user type to associate it with a password policy

## Standard attributes

- **Short name**: internal code used to identify the user type.
- **Description**: brief description of the user type.
- **Unmanaged**: (yes|no) if unmanaged is Yes, users belonging to this category will not be propagated to final systems. You must use it when you are developing a PoC.

## Actions

#### User type query

<table border="1" id="bkmrk-query-allows-to-sear-0" style="width: 809px;"><tbody><tr><td style="width: 164px;">**Add new**

</td><td style="width: 645px;">Allows you to create a new User type. You can choose that option on the hamburger menu or clicking the add button (+).

To add a new User type it will be mandatory to fill in the required fields

</td></tr><tr><td style="width: 164px;">**Delete**

</td><td style="width: 645px;">Allows you to remove one or more User type by selecting one or more records and next clicking the button with the subtraction symbol (-).

To perform that action, Soffid will ask you for confirmation, you could confirm or cancel the operation.

</td></tr><tr><td style="width: 164px;">**Import**

</td><td style="width: 645px;">Allows you to upload a CSV file with the User type list to add or update User types to Soffid.

First, you need to pick up a CSV file, that CSV has to contain a specific configuration. Then you need to check the content to be loaded, it is allowed to choose if you want or not to load a specific attribute. And finally, you need to select the mappings for each column of the CSV file to import the data correctly and to click the Import button.

</td></tr><tr><td style="width: 164px;">**Download CSV file**

</td><td style="width: 645px;">Allows you to download a csv file with the basic information of all user types.

</td></tr></tbody></table>

#### User type detail

<table border="1" id="bkmrk-apply-changes-allow-" style="width: 809px;"><tbody><tr><td style="width: 168px;">**Apply changes**

</td><td style="width: 641px;">Allows you to save the data of a new User type or to update the data of a specific User type. To save the data it will be mandatory to fill in the required fields.

</td></tr><tr><td style="width: 168px;">**Delete**

</td><td style="width: 641px;">Allows you to delete the User type. To delete a host you can click on the hamburger icon and then click the delete button (trash icon).

Soffid will ask you for confirmation to perform that action, you could confirm or cancel the operation.

</td></tr><tr><td style="width: 168px;">**Undo**

</td><td style="width: 641px;">Allows you to undo any changes made.

</td></tr></tbody></table>

<div id="bkmrk--0"><svg class="svg-icon" data-icon="link" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg>  
</div>

# Group Type

## Description

Companies are organized in different business units, departments or workgroups. In Soffid, they all are named as groups. These group can be categorized by a **group type**.

> Group types can be used in the definition of Holder Groups. Some roles can be assigned to a user only through a group enabled for it. When a user no longer belongs to a group, it is not allow assign that role to the user.

A user always belongs to a user type, but groups do not necessarily have to belong a group type.

## Related objects

1. [**Group**](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/groups "Groups")
2. [**User**](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/users "Users")

## Standard attributes

- **Name**: name (or code) of the organizational unit.
- **Description**: description of the organizational unit.
- **Role holder**: (yes|no), when this attribute is active (yes), all the groups of this type of organizational unit could be assigned to a user as a domain of a role.

#### Role holder (and holder group)

In some organizations is necessary to assign roles that affect only a part of the structure, for instance, a department, a division or a country. A **Holder Group** can be defined as a collection of entities (referred to as "holders") that share similar characteristics, roles, permissions, or access requirements. The concept of a Holder Group simplifies the management of identities by enabling administrators to apply policies, assign roles, and manage permissions at the group level rather than individually.

The role holder is the role that requires to be assigned to a group, and the holder group is the group that can be assigned role permission.

To configure correctly this functionality you have to apply the next steps:

1. Create at least one organizational unit (Group Type) with the role holder attribute active (yes).
2. Assign groups to the organizational unit (with the attribute type of the group).
3. Also, you can include new custom attributes to this membership relation, go to Metadata page and select the GroupUser to add these attributes.
4. In the soffid parameters page, create a new parameter named **soffid.entitlement.group.holder**. It can have one of these three values: 
    1. Set to **optional** enables the operator to set a group as the group holder for any entitlement assignment.
    2. Set to **always** to enforce that any entitlement assignment must be bound to a holder group.
    3. Set to **none** to disable this feature

Now you can start to apply this configuration to the users:

- In the Users page, select a user.
- In the Groups tab, add a new group.
- In the Roles tab, add a new role and select the holder group in the optional scope.
- If the holder group column is hidden, you can add with the option Add or remove columns.

## Actions

#### Group type query

<table id="bkmrk-query-allows-to-sear-0"><tbody><tr><td style="width: 170px;">**Add new**

</td><td style="width: 639px;">Allows you to create a new Group type. You can choose that option on the hamburger menu or clicking the add button (+).

To add a new Group type it will be mandatory to fill in the required fields

</td></tr><tr><td style="width: 170px;">**Delete**

</td><td style="width: 639px;">Allows you to remove one or more Group types by selecting one or more records and next clicking the button with the subtraction symbol (-).

To perform that action, Soffid will ask you for confirmation, you could confirm or cancel the operation.

</td></tr><tr><td style="width: 170px;">**Import**

</td><td style="width: 639px;">Allows you to upload a CSV file with the Group type list to add or update Group types to Soffid.

First, you need to pick up a CSV file, that CSV has to contain a specific configuration. Then you need to check the content to be loaded, it is allowed to choose if you want or not to load a specific attribute. And finally, you need to select the mappings for each column of the CSV file to import the data correctly and to click the Import button.

</td></tr><tr style="height: 29px;"><td style="width: 170px; height: 29px;">**Download CSV file**

</td><td style="width: 639px; height: 29px;">Allows you to download a csv file with the basic information of all groups types.

</td></tr></tbody></table>

#### Group type detail

<table id="bkmrk-apply-changes-allow-"><tbody><tr><td style="width: 175px;">**Apply changes**

</td><td style="width: 634px;">Allows you to save the data of a new Group type or to update the data of a specific Group type. To save the data it will be mandatory to fill in the required fields.

</td></tr><tr><td style="width: 175px;">**Delete**

</td><td style="width: 634px;">Allows you to delete the Group type. To delete a host you can click on the hamburger icon and then click the delete button (trash icon).

Soffid will ask you for confirmation to perform that action, you could confirm or cancel the operation.

</td></tr><tr style="height: 35px;"><td style="width: 175px; height: 35px;">**Undo**

</td><td style="width: 634px; height: 35px;">Allows you to undo any changes made.

</td></tr></tbody></table>

# Metadata

## Description

The Metadata functionality allows expanding the Soffid objects, their attributes, and their data types. Also, it allows expanding custom objects.

By default, there is a list of **built-in objects**, but it is possible to create new **custom objects** and add new **custom attributes** to each of them.

It is usual to add custom attributes in the User built-in object to hold additional information.

Each attribute has a **data type**, it may be a basic type as a String (simple text), integer value, date, or something more complex as a reference to a custom object, or a popup to select a manager. In this way, one can build relationships between objects.

## Screen overview

<iframe allowfullscreen="allowfullscreen" height="314" src="//www.youtube.com/embed/idXJ35DLuo4?rel=0&autoplay=0" width="560"></iframe>

## Related objects

Basically, there are two types of metadata objects. The **built-in objects** are part of the Soffid core and the **custom objects** as new objects.

### built-in objects

The **built-in objects** are the objects that are part of the <u>Soffid core</u>. It can not be removed, but more custom attributes can be added.

The following objects are Soffid well-known objects that can be customized by means of this screen. All of them are tagged as **Built-in objects**.

1. **[Accounts](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/accounts "Accounts")**
2. [**Application**](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/application-access-tree "Application access tree")
3. **[Group](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/groups "Groups")**
4. **[Host](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/hosts "Hosts")**
5. **[Mail List](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/mail-list "Mail List")**
6. **[Role](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/roles "Roles")**
7. [**User**](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/users "Users")

### Custom objects

The **custom objects** are the objects created by the administrator to extend the Soffid underlying data model. All of them are marked as **Built-in type** **No**.

Each custom object type created by the administrator is displayed at the custom objects menu options. Unfortunately, all custom object types share the same icon.

#### Custom object attributes

- **Name:** name of the custom object. This field is mandatory.
- **Description**: a brief description of the custom object. This field is mandatory.
- **Public object**: if you select the **Yes** option, the object will be visible to all the users with the proper permissions. If you select the **No** option, you must indicate what roles can Read and what roles can Write this object.
- **Write access**: allows you to select the proper roles with permissions to write. This field is only displayed when the Public object value is No
- **Read access**: allows you to select the proper roles with permissions to read. This field is only displayed when the Public object value is No

<p class="callout info">For more information, you can visit the [Custom Objects page](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/custom-objects "Custom objects").</p>

## Standard attributes

### Object attributes

- **Object type**
- **Description**: a brief description of the object.
- **Use textual index**: allows you to check the Yes option if you want to use the Textual index for searching data in this object.

<p class="callout info">For more information, you can visit [the Textual index page.](https://bookstack.soffid.com/books/soffid-3-reference-guide/chapter/textual-index)</p>

### Attribute metadata

- **Code**: short name used by scripts and connectors to access the underlying information. It is suggested to use short names without blanks or special characters to make it easier to use.
- **Label**: text displayed just beside the attribute value. It is advised to use short descriptions in order to keep the screen cleaner.
- **Data type**: The attributes can have different data types 
    - Basics 
        - - String
            - Numeric
            - Password: a text that will be stored encrypted in the database. This field will never be displayed to the end user.
            - Binary: raw information, probably images or documents.
            - Boolean
            - Photo: an image that is displayed as a small image.
            - Date: a date with a calendar popup.
            - Date and time: a date and time with a calendar popup.
            - E-mail: a text with email format.
            - HTML: rich text.
            - Separator: a separator is a label to group attributes according to some criteria
            - SSO HTML input: used primarily for the web SSO engine includes an input field and a value.
    - Extensible built-in objects 
        - - User
            - Account
            - Role
            - Group
            - Information System
            - Host
    - Other built-in objects 
        - - Group Type
            - User Type
            - Network
            - Mail domain
            - Mail list
            - Operating system
    - Custom objects: any other custom object created by the administrator.
- **Description**: text field to write a brief description of the attribute.
- **Required**: enabling this box will enforce the user to enter a value for this attribute at any object. Set no to allow objects without value.
- **Include in quick search**: the system will find any object that contains all the words included in the text search at any of the most relevant attributes. For instance, a quick search of "John Joe" will find users named "Joe Johnson" or "Johnathan Joel" as the first and last marked to be included in the quick search. If you enable the quick search for any new attribute, the same query will find a user named "Joe Williams" whose new attribute value is "John".
- **Prevent duplicated values**: mark this field as a unique key for the object type. There is no chance of two objects with the same attribute value. Soffid smart engine will avoid the creation of duplicated objects.
- **Multiple values**: some attributes can contain multiple values for the same object. For instance, an attribute containing the languages a user can speak can be multi-valued, as a user can speak multiple languages.
- **Maximum number of rows to display**: when an attribute is multivalued, the screen size can grow a lot. To prevent such a big form, the system will only display a maximum number of values, and a scroll bar will appear to browse through the attribute values.
- **Size**: primarily for string attributes, specify the maximum length in characters of the attribute value.
- **Values**: primarily, for attributes of data type String, you can specify the allowed values for the attribute. Then, the text box to the data type String is replaced by a drop-down list. Also, you can define a "code:label" for the value, the "code" is used internally and the "label" is displayed in the drop-down list, e.g. "ESP:Spain".
- **Administrator visibility**: sets the maximum visibility level for administrators. If the visibility level is set to read-only, the administrator will not be allowed to modify it. If the visibility is set to hidden, the administrator will not be able to query it. A user is considered as administrator when has the role SOFFID\_ADMIN. This field is only used in the user object.
- **Operator visibility**: sets the maximum visibility level for operators. If the visibility level is set to read-only, the operator will not be allowed to modify it. If the visibility is set to hidden, the operator will not be able to query it. A user is considered as an operator when has permission to open the users management page but lacks the role SOFFID\_ADMIN. This field is only used in the user object.
- **User visibility**: sets the maximum visibility level for end-users. If the visibility level is set to read-only, the user will not be allowed to modify it. If the visibility is set to hidden, the user will not be able to query it. Mind that even an administrator is considered to be a user rather than an administrator or operator when accessing their own identity. This field is only used in the user object.
- **Visibility expression**: write an optional BeanShell expression to check if the field should be displayed or not. The expression should return true or false. The following variables are exposed to the expression: 
    - ownerObject: current object owning the attribute.
    - value: current attribute value.
    - requestContext: tip about the screen using the attribute.
    - inputField: the ZK input object (ZK Framework).
    - inputFields: a map to get access to any other ZK input object (ZK Framework).
    - serviceLocator: locator to use any Soffid engine microservice.

```Shell
// Sample to enable company name attribute only when the user is of type E (external)
return "E".equals(object{"userType"});
```

- **Validation expression**: write an optional BeanShell expression to check if the field value is acceptable or not. The expression should return true if the value is acceptable. If the expression returns false or any other object, a warning message will be displayed. When the expression returns a string value, the return value will be considered the warning message to present to the end-user. The following variables are exposed to the expression:
    
    
    - ownerObject: current object owning the attribute
    - value: current value to evaluate.
    - requestContext: tip about the screen using the attribute
    - inputField: the ZK input object (ZK Framework).
    - inputFields: a map to get access to any other ZK input object (ZK Framework).
    - serviceLocator: locator to use any Soffid engine microservice.

```shell
// Sample for checking birthDate is greater than 18 years old
c = java.util.Calendar.getInstance();
c.add(-18, c.YEAR);
if (birthDate == null || birthDate.before(c.getTime()) return true;
else return "Birth date should be before "+ new java.text.SimpleDateFormat().format(c.getTime());

```

- **onLoad trigger**: write an optional BeanShell expression that will be executed just after preparing the user interface. The script can modify in any way the inputField object before it is displayed, but cannot modify other input fields. The following variables are exposed to the expression:
    
    
    - ownerObject: current object owning the attribute
    - value: current value to evaluate.
    - requestContext: tip about the screen using the attribute
    - inputField: the ZK input object (ZK Framework).
    - inputFields: a map to get access to any other ZK input object (ZK Framework).
    - serviceLocator: locator to use any Soffid engine microservice.

```shell
// Sample to set contract number attribute to read only if the attribute company is empty
// Place as an on-load trigger in the contract number field
if (ownerObject.attributes.get("company") == null || ownerObject.attributes.get("company").trim().isEmpty())
  inputField.setReadonly(true);
else
  inputField.setReadonly(false);
```

- **onChange trigger**: write an optional BeanShell expression that will be executed just after the user has changed the object value. The script can modify in any way the inputField object or any other input fields. The following variables are exposed to the expression:
    
    
    - ownerObject: current object owning the attribute.
    - value: current value to evaluate.
    - requestContext: tip about the screen using the attribute.
    - inputField: the ZK input object (ZK Framework).
    - inputFields: a map to get access to any other ZK input object (ZK Framework).
    - serviceLocator: locator to use any Soffid engine microservice.

```shell
// Sample trigger to set contract number attribute to read only when the company attribute gets empty
// Place as an on-change trigger in the contract field
contractField = inputFields.get("contractNumber");
if (value == null || value.trim().isEmpty())
  contractField.setReadonly(true);
else
  contractField.setReadonly(false);
contractField.invalidate(); // Redraw contract number field

```

```shell
......
inputFields.get("contractNumber").getValue();
```

- **You can add a SCIM expression**: exclusive for Soffid objects (users, groups, roles...). Write an optional SCIM query using the SCIM standard to filter valid results for a specific field.

<p class="callout success">You can access to [SCIM Chapter](https://bookstack.soffid.com/books/soffid-3-reference-guide/chapter/scim "SCIM") for more information</p>

## Actions

#### Metadata query

<table border="1" id="bkmrk-add-or-remove-column"><tbody><tr><td>**Add or remove columns**

</td><td>Allows you to show and hide columns in the table. You can also set the order in which the columns will be displayed. The selected columns and order will be saved for the next time Soffid displays the page.

</td></tr><tr><td style="width: 191.818px;">**Add new**

</td><td style="width: 606.364px;">Allows you to add a new metadata object in the system. You can choose that option on the hamburger menu or by clicking the add button (+).

To add a new it is necessary to fill in the required fields. By default, it will has have two mandatory attributes, name and description.

</td></tr><tr><td style="width: 191.818px;">**Delete**

</td><td style="width: 606.364px;">Allows you to remove one or more metadata objects by selecting one or more records and next clicking the button with the subtraction symbol (-).

To perform that action, Soffid will ask you for confirmation, you could confirm or cancel the operation.

</td></tr><tr><td style="width: 191.818px;">**Download CSV file**

</td><td style="width: 606.364px;">Allows you to download a CSV file with the basic information of all metadata.

</td></tr></tbody></table>

#### Metadata object detail

<table border="1" id="bkmrk-delete-allows-to-rem" style="width: 98.3951%; height: 400px;"><tbody><tr><td style="width: 23.9535%;">**Add new**

</td><td style="width: 75.9668%;">Allows you to add a new attribute metadata. You can choose that option by clicking the add button (+).

</td></tr><tr style="height: 35.2px;"><td style="width: 23.9535%; height: 35.2px;">**Add or remove columns**

</td><td style="width: 75.9668%; height: 35.2px;">Allows you to show and hide columns in the table. You can also set the order in which the columns will be displayed. The selected columns and order will be saved for the next time Soffid displays the page.

</td></tr><tr style="height: 102.4px;"><td style="width: 23.9535%; height: 102.4px;">**Delete**

</td><td style="width: 75.9668%; height: 102.4px;">Allows you to delete the metadata object. To delete a host you can click on the hamburger icon and then click the delete button (trash icon).

Soffid will ask you for confirmation to perform that action, you could confirm or cancel the operation.

</td></tr><tr style="height: 80px;"><td style="width: 23.9535%; height: 80px;">**Set to default**

</td><td style="width: 75.9668%; height: 80px;">Allows you to set the factory setting. Sometimes, usually after an upgrade, it is advisable to reset the built-in attributes of a built-in object. In that case, the properties of the attribute will be changed to the factory setting ones.

</td></tr><tr style="height: 147.2px;"><td style="width: 23.9535%; height: 147.2px;">**Import**

</td><td style="width: 75.9668%; height: 147.2px;">Allows you to upload a CSV file with the attribute metadata to add or update attribute metadata to Soffid.

First, you need to pick up a CSV file, that CSV has to contain a specific configuration. Then you need to check the content to be loaded, it is allowed to choose if you want or not to load a specific attribute. And finally, you need to select the mappings for each column of the CSV file to import the data correctly and click the Import button.

</td></tr><tr style="height: 35.2px;"><td style="width: 23.9535%; height: 35.2px;">**Download CSV file**

</td><td style="width: 75.9668%; height: 35.2px;">Allows you to download a CSV file with the basic information of the metadata object.

</td></tr></tbody></table>

#### Attribute metadata

<table border="1" id="bkmrk-delete-allows-you-to"><tbody><tr style="height: 28px;"><td style="width: 190.909px; height: 28px;">**Delete**

</td><td style="width: 605.455px; height: 28px;">Allows you to delete the metadata object. To delete a host you can click on the hamburger icon and then click the delete button (trash icon).

Soffid will ask you for confirmation to perform that action, you could confirm or cancel the operation.

</td></tr><tr style="height: 29px;"><td style="width: 190.909px; height: 29px;">**Undo**

</td><td style="width: 605.455px; height: 29px;">Allows you to quit without applying any changes made.

</td></tr><tr style="height: 28px;"><td style="width: 190.909px; height: 28px;">**Apply changes**

</td><td style="width: 605.455px; height: 28px;">Allows you to save the data of a new Metadata object or to update the data of a specific Metadata object. To save the data it will be mandatory to fill in the required fields.

</td></tr></tbody></table>

# User backup configure & restore

{{@621}}

# Configuration wizard

<p class="callout info">For more information, you can visit the [Configuration wizard book](https://bookstack.soffid.com/books/configuration-wizard) </p>

{{@721}}

<p class="callout info">For more information, you can visit the [Configuration wizard book](https://bookstack.soffid.com/books/configuration-wizard)</p>

# Export settings and objects

## Description

Soffid has the functionality that allows you to export configuration, Soffid objects, and objects from target systems in a ZIP file. Every object or configuration will be downloaded into the ZIP in a binary file. This ZIP file could be imported into another Soffid tenant to be used.

<p class="callout info">For more information, you can visit [the Import settings and objects pag](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/import-settings-and-objects)e.</p>

Once you open the **Export settings and objects**, you must select the configuration, objects, and target system objects you want to export. Then you only need to click the **Generate export file** button to download the ZIP that will contain all the previous information selected.

<p class="callout warning">It is not allowed to export the basic configuration and configuration parameters of an agent for security reasons. You must create them manually and make sure you put the same names as in the source system if you are going to import accounts.</p>

## Overview

[![image-1678953057534.png](https://bookstack.soffid.com/uploads/images/gallery/2023-03/scaled-1680-/image-1678953057534.png)](https://bookstack.soffid.com/uploads/images/gallery/2023-03/image-1678953057534.png)

## Related objects

#### Configuration

- **[Metadata](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/metadata)**
- [**Plugins**](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/plugins)
- [**Business process definition**](https://bookstack.soffid.com/books/bpm-editor)
- [**Custom Scripts**](https://bookstack.soffid.com/books/administration-scripting)
- [**User types**](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/user-type)
- [**Group types**](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/group-type)
- [**Account naming rules**](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/account-naming-rules)
- [**Password policies**](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/password-policies)
- [**Mail Domains**](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/mail-domains)
- [**Authorizations**](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/authorizations)

#### Objects

- [**Users**](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/users)
- [**Information Systems**](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/information-systems)
- [**Groups**](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/groups)
- [**Hosts**](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/hosts)
- [**Networks**](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/networks)
- [**Mail lists**](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/mail-list)
- [**Role assignment rules**](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/role-assignment-rules)
- [**Segregation of Duties**](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/segregation-of-duties-sod)
- [**Application access tree**](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/application-access-tree)
- [**Custom objects**](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/custom-objects)

#### Target system objects

- [**Accounts**](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/accounts)
- [**Roles**](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/roles)
- **Granted permissions**
- [**Attribute mappings**](https://bookstack.soffid.com/link/72#bkmrk-attribute-mapping)
- **Systems:** if you select and target system object, you must also select the system.


## Actions

<table border="1" id="bkmrk-query-allows-to-sear-0" style="width: 809px;"><tbody><tr><td style="width: 164px;">**Generate export file**

</td><td style="width: 645px;">By clicking this button, Soffid will generate a ZIP file with the objects and configuration that you have selected and will download it to your computer.

</td></tr></tbody></table>

<div id="bkmrk--1"></div>

# Import settings and objects

## Description

Soffid has the functionality that allows you to import configuration, Soffid objects, and objects from target systems from a ZIP file. This ZIP file must be generated by the export action from another Soffid tenant.

<p class="callout info">For more information, you can visit [the Export settings and objects page](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/export-settings-and-objects).</p>

Once you pick the file to import, Soffid will display all the objects and configurations that you can load. You must select the proper objects and settings to import or enable the Load everything option. And finally, you must click the Proceed buttons to launch the import process. Once the process is finished, Soffid will display the result and allows you to download the log file.

<p class="callout warning">It is not allowed to import the basic configuration and configuration parameters of an agent for security reasons. You must create them manually and make sure you put the same names as in the source system if you are going to import accounts.</p>

## Overview

[![image-1679056302858.png](https://bookstack.soffid.com/uploads/images/gallery/2023-03/scaled-1680-/image-1679056302858.png)](https://bookstack.soffid.com/uploads/images/gallery/2023-03/image-1679056302858.png)

## Related objects

#### Configuration

- **[Metadata](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/metadata)**
- [**Plugins**](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/plugins)
- [**Business process definition**](https://bookstack.soffid.com/books/bpm-editor)
- [**Custom Scripts**](https://bookstack.soffid.com/books/administration-scripting)
- [**User types**](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/user-type)
- [**Group types**](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/group-type)
- [**Account naming rules**](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/account-naming-rules)
- [**Password policies**](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/password-policies)
- [**Mail Domains**](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/mail-domains)
- [**Authorizations**](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/authorizations)

#### Objects

- [**Users**](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/users)
- [**Information Systems**](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/information-systems)
- [**Groups**](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/groups)
- [**Hosts**](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/hosts)
- [**Networks**](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/networks)
- [**Mail lists**](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/mail-list)
- [**Role assignment rules**](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/role-assignment-rules)
- [**Segregation of Duties**](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/segregation-of-duties-sod)
- [**Application access tree**](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/application-access-tree)
- [**Custom objects**](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/custom-objects)

#### Target system objects

- [**Accounts**](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/accounts)
- [**Roles**](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/roles)
- **Granted permissions**
- [**Attribute mappings**](https://bookstack.soffid.com/link/72#bkmrk-attribute-mapping)
- **Systems:** if you select and target system object, you must also select the system.


## Actions

<table border="1" id="bkmrk-query-allows-to-sear-0" style="width: 809px;"><tbody><tr><td style="width: 164px;">**Proceed**

</td><td style="width: 645px;">Allows you to start the import process.</td></tr></tbody></table>