MatrixCare agent

Use the MatrixCare agent to pull resident and operational data directly from MatrixCare into a Data Integration staging destination.

MatrixCare is a source-only agent. It can only be used on the source side of a task. It cannot be used as a destination. To send the data somewhere, pair it with a separate destination, typically a staging database connection.

Like all agents in Data Integration, the PointClickCare agent follows the standard three-level resource hierarchy: an Agent, a Connection, and at least one Query before you can use PointClickCare as a source in a job.

Prerequisites

  • Your DI Studio tenant must be provisioned with a MatrixCare connection by Prophix. This is set up during onboarding, typically confirmed by a setup notification email. If provisioning is outstanding, the Connection page displays a "No MatrixCare connections exist for you" banner, and Save is disabled until provisioning is complete. Contact Prophix Support or your implementation team if needed.

  • You must have access to Admin Setup in Data Integration.

  • A staging destination agent and connection must already exist in Data Integration to serve as the job destination.

Add an agent

Adding an agent is done the same way for all agent types. For instructions, see Add an agent.

 Note:  Agent Type is fixed at creation. Once saved, it cannot be changed

Add a connection

To add a connection for a MatrixCare agent:

  1. In the navigation panel, select Admin Setup.

  2. Select the MatrixCare agent you just created.

  3. Select Add Connection.

  4. Enter a Connection Name. This must be unique within the agent and up to 40 characters.

  5. Check the status banner:

    • "Active MatrixCare connection: <label>" : Your tenant has a provisioned connection. Proceed to save.

    • "No MatrixCare connections exist for you" : Provisioning is outstanding. Save is disabled. Contact Prophix Support before continuing.

  6. Select Save.

     Note:  There are no hostname, username, or password fields. Connection details are provisioned centrally and cannot be entered or edited from this page.

Add a query

  1. Select the MatrixCare connection you just created.

  2. Click > Add Query.

  3. Complete the following fields:

    • Query Name: (Required) Must be unique within this connection; up to 40 characters.

    • Table: (Required) Select the MatrixCare table or view to read from. The Table drop-down lists only the tables and views that MatrixCare exposes to Prophix. You cannot type a custom table name.

      Start typing to search the list. Use the search box to filter the list. Only tables in the allow-listed catalog appear.

       Note:  Changing the Table resets the available Columns and clears the Facility IDs field to match the new table’s schema.

    • Columns: Select one or more columns to return only those columns. Leave empty to return all columns.

    • Distinct: Turn on to return distinct rows only. This removes duplicates.

    • Facility IDs: Enter one or more facility IDs, separated by commas, to filter results to specific facilities. Leave blank to include all facilities. Disabled if the selected table has no facility column.

Use the MatrixCare source in a job

After you create the connection and query as described above, use MatrixCare (a source-only connection) as the source side of a task, paired with a staging destination.

  1. In the navigation panel, select Job Definitions.

  2. Select or create a job, then add a step, then add a task.

  3. Configure the task:

    • Under Source, from Connection: select the MatrixCare connection that you defined.

    • From Query and Filters select the MatrixCare resources that you defined.

    • Under Destination, from Connection select the Destination connection (a staging database connection), and Destination DB Table (the target table name; that you defined in the setup phase). Choose Recreate to drop and recreate on each run, or Append to add rows to an existing table.

  4. Click Save.

  5. You can now run the job from the toolbar, or schedule it using Process Manager in your Prophix application.