File Import from IDM Utilities Tool
Business Problem
Your company is in the process of migrating to an Infor CloudSuite, which necessitates the transfer of all your current digital document data from an existing repository to Infor Document Management (IDM).
Components
Requirements
- A basic understanding of how to use the command line is recommended for this guide.
- IDM-Administrator role
- User privileges to ION Desk (IONDeskAdmin) and ION API Gateway (IONAPI-Administrator)
- This will involve running a local program that connects to the Infor Cloud. Large imports and exports can consume a lot of memory on the local machine so 16GB RAM is recommended.
- Java 8+ is required.
If Java 11+ is used then JavaFX needs to be installed as well (https://openjfx.io/). The Utilities tool can be started from command line where the “module-path” points to the JavaFX directory:
java -Xms1024m -Xmx1024m –module-path “C:\Program Files\Java\javafx-sdk-11.0.1\lib” –add-modules=javafx.controls,javafx.fxml,javafx.web -jar Utilities-.jar
Tutorial
Difficulty: Easy
Estimated completion time: 15 minutes
This solution, as opposed to Bulk Import, is specifically for unstructured files with no metadata. The metadata/attributes will be added to the files as they’re uploaded to IDM.
1. Finding the IDM Utilities Tool
To access the File Import function in IDM, start by navigating to the Control Center.
Once there, select the “Tools” tab and click on “Utilities” then “Download”.
Keep in mind that there is extensive documentation available for these packages, but this guide will focus specifically on the IDM Utilities’ Bulk Import function.
2. Starting up the tool
There will be 2 jar files in the unzipped utilities package. The one you’ll want to run is does not have “sources” at the end.
The IDM Utilities tool can be ran completely in the command line, but there’s also a GUI that we can use. Navigate to the folder, type “cmd” in the folder address bar and hit Enter. This will open the command line right in that folder. Then input this command along with the name of the correct jar file to open up the GUI.
java –jar <ExecutableJarFileName>.jar
Ex: java -jar Utilities-2022.08.00-47.20220728T090651Z.jar
3. Setting up the IONAPI file
Now, in order to connect the IDM Utilities tool to your respective environment you’ll need to generate an IONAPI file. Navigate to Infor ION API, click on “Authorized Apps” and in the search bar type in “IDM”. You are looking for an API that says “Backend Service”.
Click on it, navigate down to “Download Credentials” and click on that. You’ll want to enable “Create Service Account” and input your name and then hit Download.
4. Running the Tool
Using the jar command from earlier, start up the tool, and put in the IONAPI file you created. Your screen should look something like this.
Select the File Import tab. Then select the Document Type you’d like to upload these files to and select the Path for the folder they’re contained in.
Some things to note here.
- You can put the processed files into a secondary location. This is optional. If specified, then a folder called “movedFiles” will be generated in the folder containing the processed files. If there are files in this folder then those files will be moved to a new sub-folder called “oldFiles_{timestamp}”.
- Filename Attribute is where the filename should be saved into, ex: MDS_ID
- Attributes is where you can set the attributes/metadata of the document as it’s uploaded
Command Line Arguments
If you’d like to run this on the command line, here are the arguments for running the jar file:
path | the path to a folder to import files from |
documentType | the document type to export, for example “MDS_File” |
acl | the Access Control List to set on all the documents |
finishedPath | the path to where the files can be optionally moved |
filenameAttribute | the attribute where the filename should be saved into, for example “MDS_Name” |
Additional arguments are the attributes that should be changed like this: | MDS_Name “ABC” MDS_Status 20 |
java –jar <ExecutableJarFileName>.jar
Ex: java -jar Utilities-2022.08.00-47.20220728T090651Z.jar