smoIntegration
Definition
smoIntegration is a tool used for running integration models not defined as scheduled tasks instead of using the Service Manager smoScheduler scheduler.
EndDefinition
- It integrates external data from CSV files.
- You can use a command line to test the integration model and run it immediately.
- You can also run it using a script, e.g. batch, PowerShell, etc. that is executed using an external scheduler or third-party application for a scheduled execution.
Notes
- The smoIntegration tool is shipped as an executable in the <easyvista>\smoIntegration folder (Note: <easyvista> identifies the EasyVista folder on your application server).
On-premises customers can also download it.
See the procedure.
Caution
- The smoIntegration tool uses the English name of integration models. Remember to translate labels in order to identify each integration model easily and avoid duplicates.
- If the data to be integrated comes from a database, you must first run a preimport processing before the integration model. To do this, use the smoBackOfficeClient tool that can be run by your external scheduler.
- You must disable the execution of the integration model by the Service Manager smoScheduler scheduler if you are using the smoIntegration tool. Select Administration > Integration > Integration Models in the menu to edit the integration model. Unselect the Enabled box in the window for scheduling the task.
Best Practice
When to use the smoIntegration tool
- When you want to test an integration model by running it immediately. This is because if you use the Service Manager smoScheduler scheduler, the integration model will be placed in the scheduler queue and will run after the tasks currently being processed.
- When you want to use an external scheduler or third-party application to centralize all scheduled tasks within a single tool or to leverage more advanced scheduling options.
See How to automate an integration using an external scheduler.
Command line
Syntax
List of parameters
Mandatory parameters
| Parameter | Description / Example |
|---|---|
| -account | Service Manager account where the data should be integrated. example 40000: Test database; 50004: Production database; 50005: Sandbox database |
Optional parameters
| Parameter | Description / Example |
|---|---|
| -modelname | English name of the integration model. |
| -ip | IP address of the smoServer service.
Note: The value will override the one found in the smoServer.ini file (variable IP_ADDRESS_USED). |
| -port | Port of the smoServer service.
Note: The value will override the one found in the smoServer.ini file (variable IP_ADDRESS_USED). |
| -test | Used to test the command line to check the parameters without running the integration. |
| -list | Used to display the English names of existing integration models. |
| -listall | Used to display all of the names of existing integration models. |
| –help or /? | Used to display help resources for the smoIntegration tool. |
List of return codes (Error management)
| Code | Description | |
|---|---|---|
| 0 | Processing completed without any error.
Note: A log file is created. |
|
| 1 | The server cannot be reached. | |
| 2 | The smoServer service is not found. | |
| 3 | The integration model is not found. | |
| 4 | A mandatory parameter is missing. | |
| 9 | The integration failed.
Note: This error code is never returned with the -test parameter. |
Examples
Command line
- You want to run integration model MD on test database 40000, using the smoServer service with the following IP address, 192.168.0.100
- You want to display all integration models existing in test database 40000, using the smoServer service with the following IP address, 192.168.0.100
Script (batch file)
You can adapt the batch file called run_smoIntegration.bat to your environment. This file is shipped with the tool. Replace the following variables: -port = smoServer port, -ip = IP address of the server , -account = Service Manager database account (50004, 50005), -modelname = English name of the integration model
cd\
cd "C:\smoIntegration"
@echo Integration is running... Please wait...
smoIntegration.exe -port=25238 -ip=127.0.01 -account=40000 -modelname="Test smoIntegration"
pause
Procedure: How use the smoIntegration tool
Step 1: Install the smoIntegration tool.
1. Download the file below to your workstation.
2. Extract the RAR file to the folder, c:\smoIntegration.
Step 2: Run the integration model using the smoIntegration tool.
Immediate execution
1. Open a command prompt window.
2. Enter the command line to run the smoIntegration tool and define the relevant parameters. See the example.
You can adapt the batch file called get_all_integration_models.bat to your environment. This file retrieves integration model names in English and is shipped with the tool.
Execution using a script
1. Create a batch file.
2. Insert a command line to run the integration model. See the example.
You can adapt the batch file called run_smoIntegration.bat to your environment. This file is shipped with the tool.