Help & Documentation

Learn how to use StructureGram

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.

Before preparing a client's source data, see Data Required to Import from XPM for the Entity, Trust, Relationship, and holding details StructureGram needs.

Opening the XPM Sync Hub

  1. In the left-hand navigation, go to Groups.
  2. 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.

  1. Select the workflow Import existing XPM group as new SG group.
  2. Select the XPM Group you want to import.
  3. 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.

  1. Select the workflow Link an existing SG group to an existing XPM group.
  2. Select the unlinked StructureGram Group you want to link.
  3. Select the unlinked XPM Group you want to link it to.
  4. 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. StructureGram now does a lot of this for you and only surfaces what genuinely needs a decision.

What StructureGram handles for you:

  • Auto-matched types. Custom XPM business structures are matched by keyword where possible — for example "ABC Pty Ltd" imports as a Company and "Smith Family Trust" as a Discretionary Trust. These import automatically and appear in the review list with an amber Auto-matched badge so you can double-check or skip them.
  • Ordinary share/unit class by default. A new shareholding or unitholding defaults its class to Ordinary Shares (or Ordinary Units), so you don't have to pick a class for a plain holding. It's fully overridable, and StructureGram still asks you to choose when there's an existing holding you might want to link to instead.

What still needs you:

  • A trust whose type can't be inferred — choose the trust type before it imports.
  • A custom structure with no recognisable keyword, or conflicting keywords — choose the SG entity type.
  • A holding where StructureGram already has a matching holding between the two entities — link it or create a new class.

Use Apply recommended actions to accept all the safe recommendations in one click (it never applies deletions or overwrites your choices), then work through anything still flagged. When ready, 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.

For a full walkthrough of the review controls, see Reviewing and Applying XPM Changes.

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.

Related Topics