How to Pull Data from XPM
This article explains how to pull entity and relationship data from Xero Practice Manager (XPM) into StructureGram so that you can build out your client structures without entering data manually.
For the full reference on how the XPM sync engine works under the hood, see Xero Practice Manager Sync.
Before You Start
You'll need to have set up the XPM integration in StructureGram before pulling data. If you haven't done this yet, see Connecting to Xero Practice Manager.
Opening the XPM Sync Hub
- In the left-hand navigation, go to Groups.
- Click XPM Sync Hub (next to the Create Group button).
There are two workflows available depending on your situation. Choose the one that applies to you.
Workflow 1: Import an XPM Group as a New StructureGram Group
Use this workflow if you don't yet have a Group in StructureGram and want to create one based on an existing XPM Group.
- Select the workflow Import existing XPM group as new SG group.
- Select the XPM Group you want to import.
- Click Pull Data from XPM.
After a few moments, a new Group is created in StructureGram using the same name as the XPM Group, and you'll be taken to that Group's pull page.
Workflow 2: Link an Existing StructureGram Group to an XPM Group
Use this workflow if you already have a Group in StructureGram and want to link it to an existing XPM Group.
- Select the workflow Link an existing SG group to an existing XPM group.
- Select the unlinked StructureGram Group you want to link.
- Select the unlinked XPM Group you want to link it to.
- Click Prepare Link and Open Pull Workflow.
You'll be taken to the same pull page as Workflow 1.
Reviewing Entities and Relationships
After a pull, you may be asked to review some entities and relationships before they can be fully imported. This happens because XPM doesn't capture every detail StructureGram requires.
For example:
- A trust pulled from XPM won't have a trust type selected — you'll need to choose one before it can be imported.
- A shareholder relationship won't have a share class — you'll need to specify one.
Work through each item and provide the required information, then click Continue with Selected Actions.
In some cases you'll need to go through this review process more than once — after clicking Continue with Selected Actions, you may be prompted to review another set of entities or relationships before the pull is complete.
What You'll See
Once the pull is complete, click Show full pull details to see a summary of everything that was created or updated — entities and relationships included.
Tips
- Retrying a pull re-imports everything. If you retry a pull after completing a review, StructureGram re-pulls all entities and relationships — including ones that were successfully created the first time. You may see those listed as updated rather than created. This is expected behaviour.