Speaking of New SmartSync...

SmartSync is an application responsible for synchronizing data between Identity and Active Directory. The synchronized data includes creating new users and changing data such as first name, last name, e-mail, and linked groups.

Install SmartSync

Follow these steps to install SmartSync:

01. Check out the following requirements.

Check all requirements listed in the Portability Matrix.
Have the full ASP.NET package installed. At the time of installation, you can be directed to the installation link if you wish (see image). The option to download is the Hosting Bundle.
The server on which SmartSync is installed must necessarily be able to access the Identity domains (*.fluigidentity.com and *.customerfi.com) in order for users from Active Directory to be synchronized and authenticated. You must ensure that the proper exceptions are added to your network's proxy and firewall.
It is not mandatory to install SmartSync on the same server as the Active Directory, as long as the ping between the two is fully enabled.

02. Download the installer as instructed in the item Download the SmartSync installer in the Active Directory documentation.

03. Right-click the SmartSync installer and select the option Run as administrator or Install (depending on the operating system version).

04. Click Next to finish the installation.

Once SmartSync is installed on the server, you must configure it with the Active Directory directories so that synchronization of users and/or groups can be initiated.

There are two processes running for SmartSync:

SmartsyncApplication: responsible for monitoring all incoming and outgoing data to Identity, where user and group synchronization is managed.
SmartsyncWebApi: responsible for the visual aspect of SmartSync, where you can view statuses, configure settings, and download logs.

After installing and configuring SmartSync, you must keep the SmartsyncApplication process running.

PLEASE NOTE!
SmartSync creates Windows services automatically at the time of installation. However, if you need to create it manually, the steps are in the Windows Service Manual Creation section of this documentation.

Windows Service Manual Creation

^{SmartSync creates Windows services automatically at the time of installation.}

01. Access the Windows prompt (cmd) and enter the following command to install the Windows service.

sc create "SmartSync.Application" binpath="C:\Program Files\TOTVS\SmartSync\Application\SmartSync.Application.exe"

02. Still at the Windows prompt, type the command below to start the service.

sc start "SmartSync.Application"

SmartSync initial setup

^{To perform this action, SmartSync must be installed and running on the server.}^.

ATTENTION!
If an old Active Directory is migrated, during the migration it will not be possible to validate the login and password in AD. Users who need to refresh the cache (valid for 14 days from the time of creation) will not be able to authenticate.
Therefore, we recommend that this procedure be done during periods of lower system usage, such as in the early morning or on weekends.

01. Open the application and click the Configure button.

02. Include the protocol and environment information, which can be production or customerfi. Click Test to ensure that communication is occurring.

03. Click Next to continue configuring SmartSync. Proxy settings are not yet available in the current version of SmartSync.

04. Click Next and enter the Active Directory information registered in TOTVS Identity.

IP/Server name
Only the IP or AD server name, without the 'LDAP://' protocol and the service port.

User and Password
Active Directory admin login and password (admin credentials required).

Domain
Root domain. Base DN or first level. This information must be provided by the Active Directory administrator.

Token
Token copied from the directory in Identity. For more details about the token, check the item Copy token from directory in the Active Directory documentation.

05. Click Finish.

If the data is correct, after the configuration is complete, the main SmartSync screen will be displayed with the configured AD information.

If the data is incorrect, an error message will be displayed, and a new token must be generated to attempt configuration again.

Switch SmartSync port

^{To perform this action, SmartSync must be stopped and closed. The port can be changed at any time.}

01. Open the appsettings.json file with the help of a text editor. It can be opened in Windows Notepad

02. Locate the URL field and change the port. The default port is 5325. See image

Acess SmartSync

In order for access to be possible, the SmartsyncApplication and SmartsyncWebApi services must have been previously initialized. When you open the applications, the browser will launch, opening the SmartSync home page which is located at http://localhost:5000/home.

SmartSync is organized under the tabs Home and Active Directory.

If this is the first access, you will need to configure SmartSync, which consists of the Proxy and Active Directory steps (explained in the items Proxy settings and Add Active Directory of this documentation).

Home

The Home tab presents the main information about SmartSync.

Connecting to Identity

In this section, you will enter the environment to be connected to AD. The default setting is the production environment: https://app.fluigidentity.com/.

Edit environment: Make protocol and environment changes in the fields below to test the connection to Identity.

Test connection: Check whether the connection was established for each environment where the registered AD points.

Proxy settings

^{Proxy settings are not yet available in the current version of SmartSync.}

In the default system configuration, SmartSync uses the proxy settings defined in the operating system to connect to AD Sync.

Event logs

Displays the logs recorded by SmartsyncWebApi and SmartsyncApplication. You can export this log in .txt format to see the details of the detected events.

Logs are stored according to the log level chosen:

Info: shows expected messages for regular use of SmartSync, as well as debug, warning and error messages.
Debug: shows debug messages that are only useful during development, as well as warning and error messages.
Warning: shows possible problems that are not yet errors, as well as error messages.
Error: shows problems that caused errors in SmartSync.

Events that are logged include application date and start, connected environment, connection tests, filters used to find users and groups, and Active Directory inclusion errors.

Export event logs

01. In the Event Logs section, choose the desired log: SmartsyncWebApi or SmartsyncApplication.

02. Check the period you wish to track.

03. Click Export.

04. Locate the log to be exported.

05. Click Export.

With this, the event log is downloaded and can be viewed in Notepad or your preferred text file reader.

Edit log level

01. In the Event logs section, click the Edit logs button.

02. Choose the log level you want: info, debug, warning or error.

03. Click Save.

After saving the change, the chosen level will only be valid for the next logs generated.

Active Directory

On this tab, you can add the Active Directory directories that will be managed by SmartSync.

The Identity Status column identifies when the directory is active, enabling the import of users and permission groups

Disconnected: When an Active Directory is inactive, it does not synchronize.
Connected: When an Active Directory is active and synchronizing.

You can also see when a user/group import is in progress and when it is finished in each Active Directory.

→ Synchronizing: Importing of users and groups is still in progress.
→ Synchronized: Importing of users and groups has finished.

Add Active Directory

01. In SmartSync, make sure you are in the Active Directory tab.

02. Click the Add button.

03. In the open screen, fill in the information related to the Active Directory to be synchronized with Identity.

IP
The IP on which the Active Directory is running.

Domain
The network domain.

Token
The token copied from the directory in Identity. For more details about the token, check the item Copy token from directory in the Active Directory documentation.

04. Click Add.

If all the information is correct, the Active Directory will be added to the list and will start synchronizing information with Identity.

If there are any inconsistencies in the data entered, the Active Directory will not be added to the list. To identify the problem, check the log for the Event Logs item in this documentation.

Edit Active Directory

01. In SmartSync, make sure you are in the Active Directory tab.

02. Locate the Active Directory to change.

03. Click Edit located to the right of the Identity Status column.

04. Update the necessary information on the open screen.

IP
The IP on which the Active Directory is running.

Domain
The network domain.

05. Click Edit to save the changes.

Delete Active Directory

01. In SmartSync, make sure you are in the Active Directory tab.

02. Locate the Active Directory to be deleted.

03. Click Delete located to the right of the Identity Status column.

04. In the confirmation message, check the confirmation box.

05. Click Delete.

When deleting the Active Directory configuration, the process of synchronizing users and groups will permanently cease.

Attention!

This document is valid from 5.0.0 update. Previous updates may contain different information than what you see on your SmartSync.

Árvore de páginas

Identity | New SmartSync