If you use Iress' Xplan as your CRM, you can set up the integration between your practice's Lumiant site and Xplan instance.

Please also refer to the guide in the Iress Community.

What does it do?

This integration will allow users to automatically share client information from Xplan to Lumiant when creating or editing clients, and create file notes in Xplan when a Your Life Survey, Values session or Investment Preferences survey is completed in Lumiant. 

Exports of a Lumiant Best Life Plan are also file noted and stored as an attachment against the client in Xplan.

What is synchronised? 

The below client and user fields are synchronised from Xplan to Lumiant:

Data/Field Comments Time of Sync
Title Note Lumiant only has Mr/Mrs/Ms/Miss/Dr/Prof as title options. If you have more included in your Xplan instance they will not be synchronised across. Hourly
First Name   Hourly
Middle Name   Hourly
Last name   Hourly
Date of Birth   Hourly
Sex   Hourly
Client ID Xplan client ID = Lumiant External ID Hourly
Address Line 1   Hourly
Address Line 2   Hourly
Suburb   Hourly
Post Code   Hourly
State   Hourly
Country Code   Hourly
Preferred Email Address Lumiant only stores one email so it will take the preferred address against the client in Xplan Hourly
Preferred Mobile Number Lumiant only stores one mobile phone number so it will take the preferred address against the client in Xplan. Mobile phone numbers only are taken due to their usage in MFA processes. Note that country code must be included for the sync to occur. Hourly
Adviser/User First Name   Hourly
Adviser/User Last Name   Hourly
Adviser/User Email   Hourly

The below personal and general insurance fields are synchronised from Xplan to Lumiant:

Lumiant Xplan Comments Sync
Insurance Type   Hourly
sum insured of the coverage
renewal date
end year
  calculated using policy to date and current date from Xplan Hourly


Note that Xplan is the master of these fields and data must be changed there for it to be permanent. You can change them in Lumiant however they will be overridden at the next sync. 

The below is sent from Lumiant to Xplan creating a file note, this saves advisors time in documenting conversations, and allows compliance teams to see the client interaction.

File Note Type Subject Content Attachment When
General Completed Your Life Survey {related entity name}
  • Your Life Score - %
  • Goals to be addresses
  • Dimension of Wellbeing %
No Instantly when client saves
General Completed Values Session for {Client Name} and {Partner Name) Top 5 values for each client and progress score No Instantly when Lumiant user saves
General Best Life Plan Created   Yes - PDF Instantly when Lumiant user exports
General Completed Your Investment Preferences for {related entity name} All questions and client responses No Instantly when client saves
General Investment Preferences Created   Yes Instantly when Lumiant user exports


Integration set up

1. Prep your data

a. Do you have existing clients across both sites?

If you are an existing Lumiant user, that has clients that exist across both your Xplan and Lumiant sites, we will need to know the current Xplan IDs so that when activated the sync will not create duplicate clients.

We will need a spreadsheet list (excel or CSV) of the clients with:

  • First Name
  • Last Name
  • Email - This must match between Lumiant and Xplan
  • Xplan ID

Provide to us by either contacting your Customer Success manager or reach out to to provide the information so we can load into our database. We will let you know when that's done.

b. Selecting your Xplan data

The integration set up will require you to enter a set of Xplan user credentials (Xplan login details) that will authorise API to call the data. The call will match the user credentials you enter, it determines the context and in part the capabilities in which an integrator accesses as a ‘controlled user’ to retrieve client data for use in the third-party integrator (Lumiant) site.

i. Synchronise some of your clients from Xplan

We recommend that you set up a Service Account user in Xplan (contact your Xplan Admin to help provide or create) that only has access to the clients you wish to sync from Xplan to Lumiant.

You will need to set the Service Account access to only the client groups you want to sync to Lumiant. For more help with this step please contact Xplan or refer to the iress community.

For example if we have two groups in Xplan and 3 advisers as per below. In Lumiant we have entered in the credentials of Adviser 1, thus only the clients in Practice Division A are being synchronised from Xplan to Lumiant. The filter occurs on the Xplan side.

  • Practice Division A
    • Adviser 1
    • Adviser 2
  • Practice Division B
    • Adviser 3

Please refer to the Iress Community for the latest guide on how to set visibility.

ii Synchronise all your clients from Xplan

You can use either an existing Xplan Admin's credentials, Super User or Service Account user that can view all client data (see all client groups). Note that this will give other users in your firm to access your data

2. Enable the integration

Integrations are a connecting doorway between two systems and you will need to enable these from both the Iress Xplan and the Third Party integrator side before they can be used.

You must enable in Xplan first.

a. In Xplan

This integration follows the Standard Integration pattern:

  • If you manage your own site:You can enable the integration yourself using this guide. Note that this must be undertaken by your site administrator.   
  • If you are part of a network or dealer group:Please refer to your organisation’s support team who will undertake this on your behalf.
  • If you outsource your site administration to Iress:  This integration may already have been enabled. Please contact your Iress Account Manager who will be able to confirm or raise the necessary request to progress this on your behalf. Terms and conditions are included in your managed service agreement. For details, see ourwebsite underIntegrations available via Iress Open (Xplan and Private Wealth).

b. In Lumiant

To access and enable integrations on your site you must have Practice Manager capabilities in Lumiant

  1. Login to Lumiant
  2. Access the Practice Settings by clicking the cog  icon in the upper right corner
  3. This will take you the Practice Settings, in the left hand menu select Integrations
  4.  Add and configure the integration, click + Add a new integration and enter the below

Integration Type = XPLAN

Before proceeding, a few essential things need to be checked.

  • Provided the Xplan IDs for any clients already existing in Lumiant, you can confirm in the household dashboard against the client.

Lumiant - 23 November 2023.gif

Not doing the above can result in the API failing and/or mass creating duplicate records upon connection.

Please click confirm only if you have completed the above steps in order to proceed to entering your credentials.

Next capture:

  • Name = Lumiant Xplan Integration
  • Current Authentication Mode = 0Auth

  • Forward host = [your Xplan site URL i.e.] This is your xplan site URL excluding the https://www.

  • Enabled?= Yes  

    Click proceed to authorize the integration set up.

    You will be directed to XPLAN to complete the final steps of the integration process. 

To see this in practice, please see below:

Xplan via OAuth - No Practice Logo.gif

Frequently Asked Questions

Can the data be synchronised more frequently from Xplan to Lumiant i.e instantly?

Unfortunately no, as this may impact your Xplan site performance.

Will you add more Xplan fields to your integration?

Yes we are planning to integrate more fields in future versions, however we are limited to the fields and functions under the Iress Open 2.0 API

We have custom Xplan fields, can we include those in the integration?

Our integration is limited to the fields and functions available to us under the Iress Open 2.0 API

We have multiple Xplan instances, can we connect multiple instances to one Lumiant site?

Currently no, but we are looking to add that enhancement in the near future.

Will my client notes from Lumiant go to Xplan?

Currently no.

Will client data I update in Lumiant go to Xplan?

No, the sync is one way.

What Xplan regions is this integration for?

Australia and New Zealand. United Kingdom and South Africa are on the roadmap.





Please sign in to leave a comment.

Was this article helpful?

0 out of 0 found this helpful
Powered by Zendesk