Overview of the integration

EV Reach (formerly known as Goverlan) is an EasyVista software that provides remote support and the automation of IT processes, inventory reports, etc.

This integration enables you to run Talend jobs and integration models to import technical inventory data relating to equipment, software and attributes from the EV Reach database into the Service Manager database.
The Equipment Catalog and Software Catalog will be updated in Service Manager once normalization processing has been run. The Attributes reference table will be updated in Service Manager once the data has been restructured.

• You should download the relevant package to perform the integration.
• Talend jobs can be run as standalone jobs.
• Talend jobs and EV Reach integration models can be scheduled to run on a regular basis using a Windows or Linux scheduler.
• Once you have scheduled the integration, you should check the data extracted by EV Reach regularly before integrating it in the Service Manager databases.
   

Note: 

• The integration is based on the fundamentals of preimport processing. This includes storage, processing of external data in Service Manager tables and data normalization in order to standardize the data for the existing repository.
• Talend is the third-party tool used to build this preimport processing via its jobs.
   

Integration Data Feed (direction)		Authentication Type		Integration Connector Options
EV Reach Service Manager		N/A		Integration models

Available versions
	SaaS	On Premise
Service Manager
Third-Party Product

Talend - definitions

Talend is an ETL (Extract Transform Load) tool used to extract information from a data source, modify it and reload it in a destination. The source and destination of the data can be a database, a Web service, a CSV file, etc.
    See the Talend documentation

• A job contains a set of interconnected components that are used by Talend to run data flow management processes.

• The Talend Build Job function is used to create archives containing all of the files required to run jobs, such as BAT, PS1 and SH files as well as all context parameter files. 

• The compiled jobs can be run as standalone jobs on any server, without using the Talend Open Studio console. You can schedule the jobs to be run from a batch file, PowerShell or Linux shell using Windows Task Scheduler or a Linux cron.

Notes

• The EV Reach agent must be installed on the workstations where inventory reports are required.

• Java Runtime Environment (JRE) must be installed on the workstation where the EV Reach integration is performed.

• The configuration of Service Manager production databases required for the integration is now available in the standard version from version 2022 onwards.
  • For On-Premises customers whose Service Manager version is earlier than 2022, you must perform the configuration described in the procedure.
  • For SaaS-based customers whose Service Manager version is earlier than 2022, you must submit a request to the EasyVista CMC team.

• The Talend jobs provided with the integration can be run as standalone jobs.
  • You do not need to acquire a Talend license.
  • You do not need to use the Talend Open Studio console.

• In the procedure, you can see an example of how to schedule the dedicated EV Reach integration models using the smoIntegration tool.
  • This tool is only available for On-Premises customers.
  • For SaaS-based customers, you can schedule the integration models using scheduled tasks, i.e. using the Service Manager) smoScheduler tool, an external scheduler such as Windows Task Scheduler, or a third-party application.
        See How to automate an integration.

• Customers must specify the variables specific to their environment in a properties file listing the paths of the Excel files required for the integration and the parameters for accessing the EV Reach and Service Manager SQL servers.

• Rules for mapping EV Reach data and Service Manager data:
  • Equipment: Mapped using the Type/Manufacturer/Model unique key.
  • Software: Mapped using the Software/Publisher unique key.
  • Attributes: Mapped using the Attribute unique key.

• Data integration in Service Manager databases:
  • For security reasons, a specific GOVERLAN_READER user must be created in the Service Manager production databases. This user will only be granted the access rights required for performing the EV Reach integration. The access rights will be restricted to certain Service Manager tables in order to perform specific operations.
  • Customers can use a customer-specific exclusion list to monitor the relevant software references based on their organization's policy.
  • To ensure optimal performance of the platform and minimize normalization processing, only data that is new or modified since the previous processing will be extracted. References that do not exist in Service Manager will automatically be created.

Caution

• You must not modify any of the files in the package. If you do so, the integration will not run correctly. The EasyVista team will not resolve any issues related to the modification of files and its impact on your platform.
• In the DefaultProperties.txt properties files, do not insert any spaces or tabs in the values. Do not enter quote marks.

• You should always perform a backup of the Service Manager database prior to running an integration. The EasyVista team will not resolve any issues related to the update or deletion of data and its impact on your platform.
• For SaaS-based customers, a VPN tunnel is required in order to ensure the connection between the EV Reach and Service Manager databases.

Best Practice

• Schedule an inventory report to run on a regular basis on workstations using the EV Reach agent in order to load technical data relating to equipment, software and attributes regularly in the EV Reach database.
• Schedule and define the run frequency of Talend jobs and integration models based on the frequency at which you plan to check the data extracted by EV Reach.
• You should always perform a backup of the Excel normalization files prior to making any modifications. This enables you to revert back to the original version if required.

Operating principle

Display

Steps

In EV Reach (1) Connection to the EV Reach database via Talend. Extraction of equipment, software and attribute data via three specific EV Reach SQL views. In Service Manager via Talend Equipment and software data (2) Storage of data in Service Manager E_GOVERLAN_..._VIEW tables. (3) Normalization processing to standardize data for Service Manager catalogs via E_GOVERLAN_..._TRANSCO tables. (4) Storage of normalized data in E_GOVERLAN_..._TO_EZV tables. Attribute data (4) Conversion of the data structure to normalize it for the Service Manager reference table and storage of the restructured data in an E_GOVERLAN_..._TO_EZV table. In Service Manager via integration models (5) Execution of six dedicated integration models to integrate processed data from the E_GOVERLAN_..._TO_EZV tables into the Service Manager production databases (AM_ASSET, AM_SOFTWARE, AM_CHARACTERISTICS tables).

Integration process

The integration between EV Reach and Service Manager comprises seven main steps.

Prerequisites:

Step-by-Step Integration Process

Create the dedicated Service Manager tables for the EV Reach integration

Step 1: Create the Service Manager tables for equipment data

1. Access the Service Manager SQL server.

2. Run the three SQL scripts found in the folder called 1.create tables in evo_backoffice (sql). This folder is one of those in the EV Reach package you extracted. This will create the dedicated Service Manager tables for equipment in the EVO_BACKOFFICE database.

SQL script		Table created in Service Manager		Data stored	Table structure
goverlan_asset_view.sql		E_GOVERLAN_ASSET_VIEW		Storage of data extracted from the EV Reach database via the specific EV Reach view, vSystemView
goverlan_asset_transco.sql		E_GOVERLAN_ASSET_TRANSCO		Storage of normalized data for updating the Equipment Catalog (Type, Manufacturer, Model)
goverlan_asset_to_ezv.sql		E_GOVERLAN_ASSET_TO_EZV		Storage of processed data ready to be integrated in the Service Manager production database

Step 2: Create the Service Manager tables for software data

1. Access the Service Manager SQL server.

2. Run the three SQL scripts found in the folder called 1.create tables in evo_backoffice (sql). This folder is one of those in the EV Reach package you extracted. This will create the dedicated Service Manager tables for software in the EVO_BACKOFFICE database.

SQL script		Table created in Service Manager		Data stored	Table structure
goverlan_software_view.sql		E_GOVERLAN_SOFTWARE_VIEW		Storage of data extracted from the EV Reach database via the specific EV Reach view, vSoftwareInventory
goverlan_software_transco.sql		E_GOVERLAN_SOFTWARE_TRANSCO		Storage of normalized data for updating the Software Catalog (Software Name, Publisher)
goverlan_software_to_ezv.sql		E_GOVERLAN_SOFTWARE_TO_EZV		Storage of processed data ready to be integrated in the Service Manager production database

Step 3: Create the Service Manager tables for attribute data

1. Access the Service Manager SQL server.

2. Run the SQL script found in the folder called 1.create tables in evo_backoffice (sql). This folder is one of those in the EV Reach package you extracted. This will create the dedicated Service Manager table for attributes in the EVO_BACKOFFICE database.

SQL script		Table created in Service Manager		Data stored	Table structure
goverlan_attributes_to_ezv.sql		E_GOVERLAN_ATTRIBUTES_TO_EZV		Storage of data extracted from the EV Reach database via the specific EV Reach view, vSystemAttributes Storage of processed data ready to be integrated in the Service Manager database

Add the GOVERLAN_READER user to the Service Manager production databases

1. Access the Service Manager SQL server.

2. Open the folder by selecting Security > Users.

3. Run the create user 'goverlan_reader' (50004).sql query found in the folder called 2.create user goverlan_reader (sql). This folder is one of those in the EV Reach package you extracted.

The user will be added to Service Manager account 50004 in the EVO_DATA database.

4. Run the create user 'goverlan_reader' (50005).sql query found in the folder called 2.create user goverlan_reader (sql). This folder is one of those in the EV Reach package you extracted.

The user will be added to Service Manager account 50005 in the EVO_DATA database.

Configure Talend jobs based on the customer's environment

Prerequisites: Install Java Runtime Environment (JRE)

1. Download the latest version of the Java Runtime Environment setup (64-bit version) from the Java website to your workstation.

            Java Runtime Environment (JRE) - Select the Windows Offline (64-bit) version

2. Run the executable file to install Java Runtime Environment (JRE) on your workstation.
 

Step 1: Configure the Talend job, GOVERLAN_GET_DATA_CATALOG

1. Go to the folder called 3.standalone jobs (engine)\goverlan_get_data_catalog_1.0\GOVERLAN_GET_DATA_CATALOG\local_project\goverlan_get_data_catalog_1_0\contexts. This folder is one of those in the EV Reach package you extracted.

2. Open the Default.properties file.
        

3. Specify the parameters based on your environment.

• filePath: Path to the Excel files and software exclusion file.
• EZV_sql...: IP address, port, login and password of the SQL server in your Service Manager environment.
• GOVERLAN_sql...: IP address, port, login and password of the SQL server in your EV Reach environment.

4. Save the file.
 

Step 2: Configure the Talend job, GOVERLAN_LOAD_DATA_TO_EZV

1. Go to the folder called 3.standalone jobs (engine)\goverlan_get_data_catalog_1.0\GOVERLAN_LOAD_DATA_CATALOG\local_project\goverlan_load_data_catalog_1_0\contexts. This folder is one of those in the EV Reach package you extracted.

2. Open the Default.properties file.

3. Specify the parameters based on your environment.

4. Save the file.

Run the initial integration between EV Reach and Service Manager

Step 1 (optional): Define the list of software that should not be extracted from the EV Reach database

Aim: In this step, you can specify the software whose licenses you do not monitor, such as plugins, runtimes, sdk, etc. This software data will not be loaded in the Excel normalization files. You can adapt the default list based on the software monitoring policy adopted by your organization.

1. Go to the folder called 3.standalone jobs (engine). This folder is one of those in the EV Reach package you extracted. 

2. Open the Excel file, software_exclusion_list.xls. This contains the software exclusion list.

3. Add one row for each software to be excluded.

• You can use the wildcard % to replace any string of characters.

  example  

  • Exclude all software beginning with Aeon : Aeon%
  • Exclude all software ending with Aeon : %Aeon
  • Exclude all software containing  : %Aeon%

• Caution: You should be careful when using the wildcard character %.

  example  %A%: It will exclude all software containing the A character, such as Adobe, Amazon, etc.

4. Save the file.

Step 2: Extract data from the EV Reach database

1. Run the GOVERLAN_GET_DATA_CATALOG_run.xx script found in the folder called 3.standalone jobs (engine)/goverlan_get_data_to_ezv_1.0\GOVERLAN_GET_DATA_TO_EZV. This folder is one of those in the EV Reach package you extracted. Depending on your OS, the script may be a batch file (BAT), PowerShell (PS1) or Linux shell (SH).

Step 3: Normalize equipment and software data

Normalize equipment data

Normalize software data

Step 4: Integrate the normalized equipment and software data in the E_GOVERLAN_..._TO_EZV tables in Service Manager

1. Run the GOVERLAN_LOAD_DATA_CATALOG_run.xx script found in the folder called 3.standalone jobs (engine)/goverlan_load_data_to_ezv_1.0\GOVERLAN_LOAD_DATA_TO_EZV. This folder is one of those in the EV Reach package you extracted. Depending on your OS, the script may be a batch file (BAT), PowerShell (PS1) or Linux shell (SH).

Step 5: Check the integrated data in the E_GOVERLAN_..._TO_EZV tables in Service Manager

Aim: This step enables you to check the integrity of the data integrated in the E_GOVERLAN_..._TO_EZV tables and to correct it if required.

1. Go to the folder containing the Excel files. This is the folder specified in the DefaultProperties.txt file in the filePath variable.

Check equipment data

Check software data

Check attribute data

Configure EV Reach integration models

Step 1: Import the dedicated integration models for integrating EV Reach data in Service Manager

1. Select Administration > Import / Export > Import in the menu.

2. Import the six EXP files found in the folder called 4.integration models for service manager (exp). This folder is one of those in the EV Reach package you extracted.
 

Step 2: Find the integration models for integrating EV Reach data

1. Select Administration > Integration > Integration Models in the menu.

• The names of the integration models contain the prefix EV Reach.
• They are used to integrate processed data from the E_GOVERLAN_..._TO_EZV tables into the Service Manager production databases (AM_ASSET, AM_SOFTWARE, AM_CHARACTERISTICS tables).

Step 3: Integrate equipment data

Step 3.a: Update the Equipment Catalog

Step 3.b: Update the Equipment Inventory

Step 4: Integrate software data

Step 4.a: Update the Software Catalog

Step 4.b: Update the License Inventory

Step 5: Integrate attribute data

Step 5.a: Update the Attributes reference table

Step 5.b: Update attributes in the Equipment Inventory

Schedule the running of Talend jobs and EV Reach integration models

Schedule the running of Talend jobs

Use a scheduler such as Windows Task Scheduler to automate the running of jobs.

Step 1: Schedule the GOVERLAN_GET_DATA_TO_EZV job

1. Go to the folder called 3.standalone jobs (engine)\goverlan_get_data_catalog_1.0\GOVERLAN_GET_DATA_CATALOG. This folder is one of those in the EV Reach package you extracted.

2. Schedule the GOVERLAN_GET_DATA_CATALOG_run.xx script to run. Depending on your OS, the script may be a batch file (BAT), PowerShell (PS1) or Linux shell (SH).

The GOVERLAN_GET_DATA_TO_EZV job will run based on the frequency defined.

Step 2: Schedule the GOVERLAN_LOAD_DATA_TO_EZV job

1. Go to the folder called 3.standalone jobs (engine)\goverlan_get_data_catalog_1.0\GOVERLAN_LOAD_DATA_CATALOG. This folder is one of those in the EV Reach package you extracted.

2. Schedule the GOVERLAN_LOAD_DATA_CATALOG_run.xx script to run. Depending on your OS, the script may be a batch file (BAT), PowerShell (PS1) or Linux shell (SH).

The GOVERLAN_LOAD_DATA_TO_EZV job will run based on the frequency defined.

Schedule the running of EV Reach

 integration models

You can define a scheduled task using the Service Manager smoScheduler scheduler. You can also use an external scheduler such as Windows Task Scheduler, or a third-party application.
    See How to automate an integration.

Schedule the integration using the smoIntegration tool

• Note: The smoIntegration tool is only available for On-Premises customers.

• It is used to run integration models not defined as scheduled tasks instead of using the Service Manager) smoScheduler scheduler.
• You can download the smoIntegration.exe file found in the folder called 5.run smo_integration on-prem (bat). This folder is one of those in the EV Reach package you extracted.
   

Step 1: Disable the running of EV Reach integration models by the Service Manager smoScheduler scheduler

1. Select Administration > Integration > Integration Models in the menu.

2. Click  to edit each  EV Reach integration model.

3. Unselect the Enabled box in the window for scheduling the task.

Step 2: Create the script for running the six EV Reach integration models automatically in the production databases

1. Open the run_smoIntegration (50004) file found in the folder called 5.run smo_integration on-prem (bat). This folder is one of those in the EV Reach package you extracted.

2. Replace the values highlighted in yellow with the values of your environment.

• smoIntegration: Path to the smoIntegration executable on your hard disk.
• portSmoServer variable: Port of the smoServer service.
• ipSmoServer variable: IP address of the smoServer service.
• accountEZV variable: Service Manager database account, e.g. 50004, 50005.

Caution: You must not modify the modelname variables found between double quotes because they are the English names of the models.

3. Save the file.

4. Repeat the procedure to configure the run_smoIntegration (50005) file found in the folder called 5.run smo_integration on-prem (bat). This folder is one of those in the EV Reach package you extracted.

Check the equipment and software data extracted by EV Reach

Aim:

• When Talend jobs are run regularly, all equipment and software data that is new or modified will be extracted from the EV Reach database and added to the Excel normalization files on a regular basis.
• You must then normalize these new or modified references before they can be integrated in the Service Manager databases.
   

Step 1: Check equipment data

1. Go to the folder containing the Excel files. This is the folder specified in the DefaultProperties.txt file in the filePath variable.

2. Open the Excel normalization file called catalog_asset.xls.

3. Complete the three columns, CATEGORY_TRANSCODED, MAKE_TRANSCODED and MODEL_TRANSCODED. Enter the new and modified references.

Modifications made to equipment data will be integrated in the Service Manager repository when the EV Reach integration models are next run.
 

Step 2: Check software data

1. Open the Excel normalization file called catalog_software.xls.

2. Complete the columns, SOFTWARE_NAME_TRANSCODED, SOFTWARE_PUBLISHER_TRANSCODED and FOLLOW_SOFTWARE. Enter the new and modified references.

Modifications made to software data will be integrated in the Service Manager repository when the EV Reach integration models are next run.

Description of Talend jobs

GOVERLAN_GET_DATA_CATALOG

This job is used to:

• Extract equipment, software and attribute data from the EV Reach database using specific EV Reach SQL views.
• Clean and normalize the equipment and software data extracted to ensure standardized equipment and software repositories in Service Manager.
• Modify the structure of the attribute data extracted to adapt it to the structure of the Service Manager Attributes reference table.
• Ensure that the job was correctly run.

GOVERLAN_LOAD_DATA_TO_EZV

This job is used to:

• Store only the most recent version of a given software.
• In the Service Manager software repository, delete all software no longer detected by EV Reach (cleanup step).
• Generate Excel control files containing the data that is ready to be integrated in Service Manager.
• Ensure that the job was correctly run.

List of files to download

Note: To find out how to use them, see the integration process.

            Package EV Reach