Title: Installation and Configuration of the Integrated Management Utility for importing data
This document illustrates how to download, install and configure the Integrated Management Utility (IMU).
The Unanet IMU is a utility installed on a customer's server that allows system administrators to import data into Unanet or export data from Unanet on a scheduled basis via a job scheduling tool such as Windows Task Scheduler. The IMU also provides management functionality around the import and export events, such as logging of imported/exported files, generation of error message files, and emailing administrators with the results of an import or export. The IMU also allows other processes to be called just before an import or just after an export, which is especially helpful for integrations with other systems. For example, it could first call a process to extract data from an external system, then import that data into Unanet. In addition to being used for integrations, the IMU is often used for regularly-scheduled modifications of Unanet data, such as exporting hours accrued for comp time, then importing updated budget values on a comp time project.
What’s covered in this document:
Downloading and Extracting the Integrated Management Utility
The first step in setting up the IMU is to download and extract the IMU installation package:
- Go to: http://www.unanet.com/ and click on Services, then "Support Downloads"
- Log into the support site using your email and password (if you don’t have an email and password, you can click on the “Request a NEW support id” to obtain one.
- Click on the Interfaces tab. Under the “Interface Management Utility (IMU)” header, click the "Manual Zip File" link to download the compressed package. See screenshot below.
4. Once you download the file and save it, you can extract the contents of the ZIP file to the desired location.
Consideration: Although the extracted IMU folder/files can be placed anywhere, if you are planning to kick off an automated process, you may want to place it on a server or a machine that is not turned off.
NOTE: You must have JAVA (JDK not JRE) installed and the JAVA_HOME environment variable defined in order to execute the package.
5. Once the IMU files are in place, you can gain access to the files that require one time configuration by going to the location you installed the IMU and clicking on “unanet_imu” where you will find a list of files that looks similar to the below.
6. In the next steps we will be configuring the imu_pre_build.xml and the imu_config.properties file.
Configuring the imu_pre_build.xml file
The pre-build file is designed to kick off another process if need be and/or move or copy the resulting files to an import directory where they can be picked up and imported into Unanet. The steps for each are listed below. To open the imu_pre_build.xml file, right click on the file and open with notepad or any other text editor you like.
Consideration: Although you can kick off any process, below is an example of typical processes that is initiated using the pre build.
Sample of kicking off an MS Access macro:
To configure the pre_build to kickoff an access process , you would do the following.
- Remove the comments around the MS ACCESS EXAMPLE (<!-- and -->)
- Ensure the directory where your Access program is located is correct.
- Update the location where the Access package you are using is located
Sample move/copy format:
Whether you kicked off a process to generate the csv files for import into Unanet or they were placed in a directory via some other process, you can move or copy them from the existing directory into the Unanet import directory with the below example. Once moved/copied, they will be stored for any number of days you like so that you can review historical import files in the logs.
Configuring the imu.properties file
The properties file gives the user interface the information it needs to import the data. For example, a username and password with administrative privileges, the url of your Unanet instance, a list of the csv files you will be importing. Below are the items that must be configured to in order to execute the IMU.
Update the url where Unanet resides
Enter the username and password of the admin account that will be executing the interface:
Define the e-mail accounts you would like error message sent from and to:
Enter the specific imports you will be bringing into Unanet by removing the “#” and listing them in the exact names you see in the properties file.
If you need to run multiple files of the same type (Ex. Approval Group for Time and Expense), you will need to rename them in the “Import Properties” as well as add them to the “run.imports” line. In this example, we are pulling in multiple approval group csv files, so we named one approval_group_time and added it to the run.imports command line.
Configure all input file names for any files you are importing:
Enter any global arguments in the “args=” area
Executing the IMU manually
You can execute the IMU manually from the command prompt (open command prompt and go to unanet_imu directory, then run “unanet_imu.bat”) or by double clicking on the “unanet_imu.bat” file in the unanet_imu directory. This will kick off your process, import your data and send any emails.
- Change direCtory to where IMU is located
- To run: type “unanet_imu.bat” and hit ENTER
Scheduling the IMU via Windows Scheduler
Schedule the unanet.imu.bat file – In the desktop Control Panel under ‘Scheduled Tasks’, you can add a scheduled tasks to run the “unanet.imu.bat” each day or as many times a day as you like.
Reviewing your data logs
In addition to emailing you any errors or even positive reporting when the IMU runs without error, Unanet stores the data for any number of days you like. You can define the number of days you wish to store the data in the imu_config_properties file.
To review your data go to the “data” folder under the unanet_imu directory and click on the date you would like to view data for.
In this folder you will find, Input, Logs and any resulting errors that may have occurred during the IMU run.
- Input – the exact csv files that were pulled into your instance of Unanet
- Logs – the results of the import. For example, how many records were successful, if a file was empty, etc.
- Errors – This contains a description of the error as well as a copy of the exact data that was unsuccessful so you can easily identify any problems and re-import if need be.