smoBackOfficeClient
Definition
smoBackOfficeClient is a tool used for running preimport processing instead of using the Service Manager smoBackOffice scheduler.
EndDefinition
- You can use a command line to test the preimport 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.
Example
Nexthink integration enables you to integrate 48 health metrics related to equipment in Service Manager. As a general rule, it is run every 30 minutes.
==> The smoBackOfficeClient tool is used to ensure that the frequency defined is respected. It enables you to run the integration processing immediately instead of placing it in the Service Manager smoBackOffice scheduler queue.
Notes
- The smoBackOfficeClient tool is shipped as an executable in the <easyvista>\tools\smoBackOfficeClient folder. (Note: <easyvista> identifies the EasyVista folder on your application server).
Note: On-premises customers can also download it.
See the procedure.
Caution
- You must disable the execution of the preimport by the Service Manager smoBackOffice scheduler if you are using the smoBackOfficeClient tool. To do this, you should comment out the relevant lines in the INI files specified in the PREIMPORT_SQL.sql file, found in <easyvista>\tools\smobackoffice\QUERIES\SQL\PREIMPORT.
Best Practice
When to use the smoBackOfficeClient tool
- When you want to test a preimport by running it immediately. This is because if you use the Service Manager smoBackOffice scheduler, the preimport 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
- <easyvista>: EasyVista folder on the application server.
- <PreimportFileName.ini>: Name of the INI configuration file for the preimport.
List of return codes (Error management)
| Code | Description | |
|---|---|---|
| 0 | Processing completed without any error. | |
| 1 | The parameters are incorrect. | |
| 2 | The preimport is not found. | |
| 4 | The SQL configuration is invalid. | |
| 997 | Error while running the SQL script in a [PROCESS] section. See the log file. | |
| 998 | Error while processing the preimport. See the log file. | |
| 999 | General error. See the log file. |
Examples
Command line
Run the preimport processing for the Nexthink integration (NEXTHINK_ASSET_STATUS.ini configuration file)
Script (batch file)
You can adapt the batch file called smoBackOfficeClient.bat to your environment. This file is shipped with the tool. Replace the name of the INI file with the name of the configuration file used by your preimport.
c:
cd\
cd C:\easyvista\tools\smoBackOfficeClient
smoBackOfficeClient.exe "C:\EasyVista\Tools\smoBackOffice\QUERIES\SQL\PREIMPORT\IMPORT_LDAP.ini"
Procedure: How to use the smoBackOfficeClient tool
Step 1: Install the smoBackOfficeClient tool.
1. Download the file below to your workstation.
2. Extract the RAR file to the folder, c:\easyvista\tools\smoBackOfficeClient.
Note: The smoBackOfficeClient.cfg file is a duplicate of the smoBackOffice.cfg configuration file used by the Service Manager smoBackOffice scheduler.
Step 2: Run the preimport processing using the smoBackOfficeClient tool.
Immediate execution
1. Open a command prompt window.
2. Enter the command line and indicate the name of the INI configuration file for the preimport.
Execution using a script
1. Create a batch file. See the example.
2. Insert the command line to run the preimport.