If you're already set up in Integrations Hub with iMIS EMS, you can jump to Setting Up a Pushback below.
Prerequisites
In this article, we'll go over the steps for setting up an Integrations Hub Pushback with iMIS EMS.
*** Not sure if you have EMS or iMIS Web Service? Here's an easy way to check:
Within your iMIS account, navigate to:
Settings > About iMIS > iMIS version
Version 20.3 or later = EMS
Version 20.2 or earlier = Web Service
Here is a screenshot of what this settings area will look like or similar to:
Important Note: In order to set up a Pushback through Integrations Hub, you must configure an Integrations Hub SSO first.
If you do not have an Integrations Hub SSO, please configure one here first.
Basic Setup within Your OpenWater Instance
We're going to create a program for where our Pushback will be used, a form for our program (that collects the data we are pushing back to iMIS), then, a few test submissions. If you already have these items in place, feel free to skip to the next section: Basic Setup within Integrations Hub
As an OpenWater admin you can login to your organization's instance here:
https://{InstanceName}.secure-platform.com/admin
Follow the prompt to login then you'll be brought to your dashboard that will look similar to this:
We're now going to add a program.
Once you're done adding your program, you'll create your submission form. This form can be updated and changed whenever you like, so for the purpose of building this Pushback, just focus on including all of the fields you know you need in general (name, email, title, etc) and fields specific to the Pushback.
Next, create a few test submissions in your new submission form:
Get your program's direct link, it will take you to the submission form you built to fill out a test submission.
For your test forms, fill in whatever test data you'd like i.e. John Doe, Test Company, etc.
Make sure to fill out the entire form and use unique data for each form so you can tell them apart during testing later.
Once this is done, you can return to your dashboard. We have a few more items to complete in your instance in the next section.
If you haven't already, here's how to Get Started with Integrations Hub.
Setting Up a Pushback
Add a new Pushback connector from the Integrations Hub dashboard.
2. You will be brought to a page with different Pushback options. Select iMIS (Applications).
3. You should now see the page below. We'll need to fill in a few settings:
Select the program that has your sample applications from your OpenWater Instance.
For credentials, choose the saved credentials from your previous SSO integration mentioned at the beginning of this article.
OPTIONAL: Set the CRON Expression to how often you'd like the Pushback to trigger. This can be set now, or after you've completed the pushback, or not at all, if you only want to run updates manually.
4. Once the above is added, click Save in the top left corner of your screen.
5. Select the Field Mapping tab towards the top of your screen and click Create Panel with Basic Mapping.
This will automatically create a panel within your iMIS instance.
The panel name will automatically begin with 'ow_'. We recommend naming the panel in line with the program/workflow you are setting up.
Ex. "Sample Program" could push to the panel "ow_samples".
6. Click Create. This will add the panel to your iMIS instance, as well as add a list of basic fields to your "Field Mapping" tab on your pushback in Integrations Hub.
However, most pushbacks also include data from your submission form, and not all of them require the same basic fields. In order to include the data you want in your pushback, we'll to add more fields to this tab, as well as to the panel you've just generated in iMIS.
Keep this screen open in your browser. We'll be jumping over to your iMIS account to adjust some settings but we'll need to return to this page once we're done.
iMIS Side Settings
7. In a new browser tab, go to your iMIS organization account URL: https://{instanceurl}/staff
8. Go to RiSE > Panel Designer > Panel definitions and search the name of your panel. Select the panel we've just created and you'll see the screen below.
This lists all of the current basic fields set up for your panel. You can add additional fields by hitting "+ Add property" under the panel name listed below "Create source".
9. Add any additional fields you want to include in your pushback from your submission form.
Give your new field a name that corresponds to the data you are mapping. No spaces or special characters.
Use the "Text" property type.
Increase the "Length" to at least 400 characters, but this may vary depending on the field you are trying to push from OpenWater.
Hit "Add & Close" or "Add & Continue" if you're needing to add multiple fields.
The new fields will now appear under the panel name in the lefthand list of sources. Double click on the panel name to add all into the panel, or drag and drop them into the spaces on the right that say "Drop here".
10. Hit "Save" or "Save & Exit".
11. Now go to RiSE > Panel Designer > Panel sources and search the name of your panel again. Open your panel and go to the "Security" tab.
Select the "Available via the REST API" box so that it is checked On.
Hit Save.
Field Mapping
12. Back in Integrations Hub, hit "Refresh" on your connector tab. This will allow the new fields you just added in iMIS to appear as options for you to select during field mapping.
13. Open the "Field Mapping" tab and hit "Add Field" for any new fields you want to include in your pushback. Click to select the OpenWater field alias in the left column and the iMIS field in the right column.
14. Hit "Save" in the top left.
View your data in iMIS via an IQA
Let's see where the data from this Pushback is going in iMIS.
15. Looking back to your iMIS dashboard items located on the far left of your screen, click Rise > Intelligent Query Architect. Once this page loads, click "New" (located at the top), and select "Folder".
Write "OpenWater" as the folder name and then click "Save".
16. You can import an IQA or create your own from scratch.
To import: Save this gist then import it into the OpenWater folder. Do this by selecting the folder OpenWater, and click Import at the top of your screen. A new popup will appear with a file importer. Select the gist we had you save, and click "Upload".
Ensure you update the destination with the new folder and click "Import".
17. Within your new IQA, go to the "Security" tab and select the box called "Allow Access via REST API".
18. Now go to Define > Sources > All Sources.
Search for the panel we just created:
19. Click into the panel we made and then go to the display tab and choose all columns.
20. Check off all available properties, press Save, then press Run.
This is where the data from OpenWater will be captured.
Testing in Integrations Hub
You can add or remove fields to your pushback any time you need. Double check to make sure that they are included in:
the field mapping in Integrations Hub
the panel definition in iMIS
the IQA display properties
You can test by finding an application that you want to push, hitting "Test" and typing in that application's Application ID number and hitting "OK".
A successful test will show a success message:
Navigate to your IQA in iMIS and go to the "Run" tab to see the data as it has populated.
Running Your New Pushback
Once you're ready, you can either run all of the data for your pushback manually, or you can set it to run automatically on a recurring basis.
To push manually, hit "Run Once". You can observe the push being made in real time via the "Logs" tab.
To push on a set automatic timer, set the CRON expression on the "Settings" tab for how often you want your pushback to send data. Then hit Start so that the integration runs on a recurring basis.
Check your IQA in iMIS to make sure the data is appearing as expected.
Notes on Making Updates:
Changing something on a submission in OW updates it on the next push (including changing something to Null/deleting the info, it will be overwritten with no value).
Deleting a submission in OW program will not delete it from pushback object, even if more pushes occur after it was deleted.
Deleting a program or archiving a program will not affect anything that has been previously pushed, it just won't be an active pushback anymore.