IMDEXHUB-IQ Integration

User Guide
Document information
Authorised use © acQuire Software Pty Ltd
Document name IMDEXHUB-IQ Integration - User Guide
Date April 2020
Table of contents
1 Overview 1
1.1 How does it work? 1
1.2 Prerequisites 2
1.3 Use a proxy server 2
2 Configure an acQuire database for IMDEXHUB-IQ integration 3
2.1 IMDEXHUB-IQ integration key 3
2.1.1 Generate a new integration key 3
2.2 Configure the integration key in acQuire 4 3
3 Build an acQuire 4 import object for IMDEXHUB-IQ integration 5
3.1 Set up an import sheet 5
3.2 Map to acQuire virtual fields 7
3.3 Technical recommendations for column mapping 7
3.3.1 Map IMDEXHUB-IQ projects to acQuire 4 projects 7
3.3.2 EZ-GAMMA data 9
4 Additional technical details 10
4.1 Import process for IMDEXHUB-IQ data 10
4.2 Technical tables involved in the process 10

IMDEXHUB-IQ Integration - User Guide iii

1 Overview
The integration between the acQuire GIM Suite and IMDEXHUB-IQ allows sensor data from a variety of
instruments to be downloaded from IMDEXHUB-IQ directly to your acQuire GIM Suite database, eliminating the
need for manual file handling.
It is designed to work in conjunction with the acQuire GIM Suite automation module to provide continuous
integration between the two systems – as new data is uploaded and approved in IMDEXHUB-IQ, it can be
automatically synchronised with the acQuire GIM Suite, so users always have access to the latest data.
The instruments currently supported include:
EZ-GAMMA: downhole natural gamma measurements
EZ-GYRO: north seeking gyroscope downhole survey
EZ-TRAC: magnetic downhole survey
SPRINT-IQ: fast north-seeking gyroscope downhole survey
TN14: drill rig alignment or collar orientation
XRF: portable XRF
IQ-LOGGER: structural measurements.

1.1 How does it work?

A traditional workflow to transfer data collected in the field into a Geoscientific Information Management
System involves many steps and manual handling of this data, leading to time delays and possible corruption of
the data.
With the integration between IMDEXHUB-IQ and the acQuire GIM Suite, the data is instead synchronised
directly from the field to IMDEXHUB-IQ, then from IMDEXHUB-IQ directly into the acQuire GIM Suite, as
displayed in the diagram below.

IMDEXHUB-IQ Integration - User Guide 1

The process can be broken down into the following steps:
1. Sensor data from a variety of instruments (for example, EZ-GYRO downhole survey data) is uploaded directly
to IMDEXHUB-IQ from the field.
2. After the data has been reviewed and approved in IMDEXHUB-IQ, it is downloaded into the acQuire GIM
Suite using an acQuire 4 import object.
3. Using the acQuire GIM Suite automation module, the imports are scheduled to run on a regular basis, so the
latest data from the field is always available in the acQuire GIM Suite.
This process eliminates manual data handling and the constant need for human intervention to transfer data
from one system to another, increasing the security and integrity of your data, and greatly reducing the delay
between when the data is collected in the field and when it becomes available in the acQuire GIM Suite.

1.2 Prerequisites
To use the IMDEXHUB-IQ integration, the following prerequisites must be met:
An IMDEXHUB-IQ account
One or multiple projects associated with an IMDEXHUB-IQ integration key
An acQuire database configured with this integration key
Access to the IMDEXHUB-IQ web API at: https://api.imdexhub.com/api/integration
Note: You may need to contact your IT Administrator to whitelist this web address.
An acQuire 4 import object configured to import from IMDEXHUB-IQ
acQuire Automation to trigger the import at predefined times (optional).
The details of how to set up these different parts are explained in this document.

1.3 Use a proxy server

If your company is using a proxy server to authenticate to connect to web addresses, you will need to configure
the proxy server settings. This is managed in the AcqManagement.Setting table and you will need to run a SQL
script to make the changes to enable using a proxy server.
1. Using SQL Server Management Studio, ensure that you have a connection to the database.
2. Add the following script and update the highlighted strings to the values used in your company.
update AcqManagement.Setting
set SingleValue = '1'
where Context = 'Reflex' and Name = 'UseProxy'
update AcqManagement.Setting
set SingleValue = 'myproxyserveraddress.com'
where Context = 'Reflex' and Name = 'ProxyAddress'
update AcqManagement.Setting
set SingleValue = 'ProxyUsername'
where Context = 'Reflex' and Name = 'ProxyUsername'
update AcqManagement.Setting
set SingleValue = 'ProxyPassword'
where Context = 'Reflex' and Name = 'ProxyPassword'
3. Execute the query, then continue to use IMDEXHUB-IQ as described.

IMDEXHUB-IQ Integration - User Guide 2

2 Configure an acQuire database for IMDEXHUB-IQ integration
2.1 IMDEXHUB-IQ integration key
IMDEXHUB-IQ integration with the acQuire GIM Suite is achieved using a web API. Access to this web API is
granted to an acQuire 4 import object by means of an integration key. IMDEXHUB-IQ integration keys must be
associated with a unique acQuire database, and each acQuire database can be only associated with a single
integration key.
Note: It is very important to ensure that an IMDEXHUB-IQ integration key is not shared among multiple acQuire
databases. Failure to comply with this requirement will cause conflicts, as data synchronised with one database
will become unavailable to the other one.

2.1.1 Generate a new integration key

Note: This section assumes that projects and users have already been created in IMDEXHUB-IQ.
Before an acQuire 4 import object can be setup to import from IMDEXHUB-IQ, an integration key must be
generated for the acQuire database. Refer to the IMDEXHUB-IQ help accessible from your IMDEXHUB-IQ
account to generate a new integration key and associate it with the relevant projects and tools.

Note: It is important to ensure that for the integration key you define, it is only configured to use data with a
status of Approved, as displayed in the example below:

2.2 Configure the integration key in acQuire 4

After an integration key has been generated in IMDEXHUB-IQ, it can be used in acQuire 4. This configuration
only needs to be done when adding the initial integration key or updating it.
To configure the integration key:
1. Create a new acQuire 4 import object.
2. Select any compound definition (for example, Collar) to proceed to the Import Definition dialog.

IMDEXHUB-IQ Integration - User Guide 3

3. In the Source File Properties tab of the Import Definition dialog, select IMDEXHUB-IQ as the Data format.

4. In the IMDEXHUB-IQ tab, click Edit the Integration Key.

5. Type the integration key and click Apply the new Integration Key.

If the integration key is invalid, an error message is displayed. If it is valid, the button becomes greyed out.
6. Click OK to exit this dialog.

IMDEXHUB-IQ Integration - User Guide 4

3 Build an acQuire 4 import object for IMDEXHUB-IQ
integration
3.1 Set up an import sheet
After the integration key and the mapping of the IMDEXHUB-IQ project names to acQuire GIM Suite projects has
been established as previously described, an acQuire 4 import object can be configured to import data from
IMDEXHUB-IQ directly into the acQuire database.
The steps are as follows:
1. Create a new acQuire 4 import object or create a new import sheet in an existing one.
2. In the Source File Properties tab of the Import Definition dialog:
a. Clear the Use same source file for all import sheets checkbox.
b. Clear the Use same data and header sections for all import sheets checkbox.
c. Select IMDEXHUB-IQ as the Data format.

IMDEXHUB-IQ Integration - User Guide 5

3. In the IMDEXHUB-IQ tab of the Import Definition dialog:

a. Set the preview options to retrieve the latest data for the first IMDEXHUB-IQ import sheet of the import
object. It will ensure that new data is automatically retrieved from IMDEXHUB-IQ when previewing.
b. A preview filter can be set to only preview data for a specific time period.
c. Choose one of the sections to import in Available Sections. The list of fields for this section is displayed.

IMDEXHUB-IQ Integration - User Guide 6

4. The Data Section tab of the Import Definition dialog displays the list of fields. Click Apply, then OK to close
the dialog.

3.2 Map to acQuire virtual fields

No strict rule has been established for the mapping of IMDEXHUB-IQ fields to acQuire virtual fields. Some
general recommendations include:
Setting up dedicated virtual fields for IMDEXHUB-IQ data.
Following this recommendation increases confidence in the reliability of this data by decreasing the risk
of accidental modification after import. It also certifies the source of this data compared to using existing
virtual fields encompassing multiple sources.
Storing IMDEXHUB-IQ GUIDs (Globally Unique Identifiers) when importing the data.
Every IMDEXHUB-IQ record contains an ID field, which uniquely identifies this record. Storing this ID in a
virtual field provides a reference back to the corresponding IMDEXHUB-IQ record for auditing purposes.

3.3 Technical recommendations for column mapping

3.3.1 Map IMDEXHUB-IQ projects to acQuire 4 projects
IMDEXHUB-IQ project names consist of up to 50 characters, while IMDEXHUB-IQ project codes are limited to 10
characters. It is therefore recommended to set up a virtual field to store the IMDEXHUB-IQ project name against
the acQuire project.

IMDEXHUB-IQ Integration - User Guide 7

To do so:
1. Select Manage > Virtual Field Wizard.
2. Select the Projects compound definition.

3. Create a new text virtual field. The name used in this technical documentation is ImdexProjectName, but it
can be changed to any other valid name.

4. Using an acQuire 4 form or data entry object, set the value of the ImdexProjectName column to the
corresponding IMDEXHUB-IQ project name:

IMDEXHUB-IQ Integration - User Guide 8

The following acQuire 4 expression can then be used in the import sheets to retrieve the PROJECTCODE from
the ProjectName retrieved from IMDEXHUB-IQ:

=runsql(strcat("select pd.PROJECTCODE
from PROJECTDETAILS as pd
where pd.[NAME] = 'ImdexProjectName'
and pd.[VALUE] = '",{src::ProjectName},"'"))

3.3.2 EZ-GAMMA data

When importing EZ-GAMMA data, the import object must use two different import sheets:
One for the EzGammaHeader section, mapped to the GEOPHYSheaders compound definition.
One for the EzGammaDetails section, mapped to the GEOPHYSdetails compound definition.
The RUN populated when importing from EzGammaHeader can be incremented for each new record coming
from IMDEXHUB-IQ by using the following acQuire 4 expression:

=runsql(strcat("select coalesce((select max(gh.RUN) + 1

from QV_GEOPHYSHEADER as gh
where gh.HOLEID = '",{src::DrillholeName},"'
and gh.PROJECTCODE = '",{col::PROJECTCODE},"'),1)"))

The PRIORITY can be generated from the RunStatus:

=if({src::RunStatus} = "Approved"
,1
,if({src::RunStatus} = "Pending"
               ,2
               ,3
)
)

When importing from EzGammaDetails, the RUN must be retrieved from the previously saved header record.
This is done by using a virtual field when populating GEOPHYSheaders to store the GUID (the ID column in the
IMDEXHUB-IQ sections for EzGammaHeader and EzGammaDetails).
In the following example, this virtual field is named EzGammaId:

=runsql(strcat("select ghc.RUN
from QV_GEOPHYSHEADERCOMMENT as ghc
where ghc.NAME = 'EzGammaId'
and ghc.HOLEID = '",{col::HOLEID},"'
and ghc.PROJECTCODE = '",{col::PROJECTCODE},"'
and ghc.DEPTHSTEP = ",{col::DEPTHSTEP},"
and ghc.PRIORITY = ",{col::PRIORITY},"
and ghc.VALUE = '",{src::Id},"'"))

IMDEXHUB-IQ Integration - User Guide 9

4 Additional technical details
4.1 Import process for IMDEXHUB-IQ data
Importing IMDEXHUB-IQ data to an acQuire 4 import object follows multiple steps:
1. Data is retrieved from IMDEXHUB-IQ in JSON format and stored in a staging table in the acQuire database.
This occurs when previewing an import sheet with the Load new data before import checkbox selected or
by clicking the Load new data now button in the Import Definition dialog.
2. A response is sent to IMDEXHUB-IQ to flag the data as loaded, so that only new data is retrieved in any future
request.
3. Valid data sections in the JSON are flagged as pending for import (not processed).
4. When executed, the import object loops through any pending integration data (with at least one section not
processed) in chronological order and attempts to import into the destination compounds.
5. If the import is successful and committed, every section successfully imported is flagged as having been
processed.
6. Integration data for which all sections have been flagged as processed will no longer display in the list of
datasets to preview in the IMDEXHUB-IQ tab of the Import Definition dialog.

4.2 Technical tables involved in the process

Two tables are used for the integration process:
AcqManagement.AdmIntegration
This table hosts integration data loaded from IMDEXHUB-IQ.
It includes both data already imported into acQuire database tables and data loaded from IMDEXHUB-IQ,
but pending import.
Integration data retrieved from IMDEXHUB-IQ is stored in the IntegrationData column in a JSON format.
The date at which this data was loaded is stored in the DateReceived column.
The following query can be used to access integration data:

-- Integration data retrieved from Imdex Hub,

-- includes both pending data and data imported into acQuire tables
select *
from AcqManagement.AdmIntegration as ai
where ai.IntegrationType = 'Reflex'
order by ai.AdmIntegrationId

AcqManagement.AdmIntegrationSection
This table contains the list of integration sections associated with a unique integration data row stored in
AcqManagement.AdmIntegration.
The AdmIntegrationId column is used to relate these sections to the parent record in the
AdmIntegration table.
The IsProcessed column is set to 1 when the integration section has been successfully imported into
acQuire tables, otherwise 0.

IMDEXHUB-IQ Integration - User Guide 10

 The following query can be used to access integration sections (would normally be further filtered on a
specific AdmIntegrationId):

-- Sections containing data in the corresponding Integration Data

-- Marked as processed after they have been successfully imported
through an acQuire 4 import sheet
-- Note: the names of the sections are not exactly as they appear in the
JSON.
select *
from AcqManagement.AdmIntegrationSection as ais
order by ais.AdmIntegrationId
         ,ais.IsProcessed desc
         ,ais.IntegrationSectionType

IMDEXHUB-IQ Integration - User Guide 11

Contact
Offices Australia, Canada, Chile, South Africa
Street address 26 Kintail Road, Applecross, Western Australia, 6153
Postal address PO Box 933, Canning Bridge, Western Australia, 6153
Telephone +61 8 9316 6600
Fax +61 8 9316 6699
Email [email protected]
Website www.acquire.com.au

Official information
acQuire Software Pty Ltd is the owner of the software and all icons and logos within the software, together with
all soft and hardcopy documentation.
This document is copyright. No part of this document may be reproduced by any process, or in any form,
without prior written consent from acQuire Technology Solutions Pty Ltd.

Disclaimer
acQuire Software Pty Ltd will not accept any liability arising from the use of the software or any other software
product mentioned in this document; nor for any technical or editorial errors or omissions made in this
document. The mention of any other computer software product in this document does not imply the
endorsement of such product by acQuire Software Pty Ltd.