Onit Documentation

How to Create a Phase Metrics Provider

by David Goldfarb Updated on

Phase Metrics Provider is designed to make it easy to track the phases of a record within Onit.

Let's Get Started!

1. Configure the Provider

Step 1 of the set up is to configure the Provider.

From the Provider you can:

  • Select which app this provider is tied to for the interface.
  • Select and map to existing apps and/or fields.
  • Auto-create apps and relationships as needed.

Go to the Global Configuration section in Advanced Designer and click on Phase Metrics Provider.

Here is an overview of the Phase Metrics Provider fields:

  • Name: A unique name of the provider.
  • Source App: A dropdown of apps in the subdomain.
  • Phase Metrics App: A dropdown of a field
  • Corresponding field in he Phase Metrics App:
    • App Name
    • Transaction Name
    • Transaction ID
    • Transaction Display Name
    • Phase Name
    • Phase Start
    • Phase End
    • Total Business Days in Phase
    • Total Seconds in Phase
    • Phase Duration
    • Phase User
  • Description: A brief overview of the provider.
Full view of Phase Metrics provider

Provide a name and select a source app from the drop-down.

For a new Phase Metrics Provider, you can click the "Create phase metrics app" button which will open a pop-up.

Provide the Phase Metrics App with a name.

Click the "Create" button to auto-create and auto-fill all the fields.

Check the "Enable?" checkbox.

Click the "Save" button.

If you have an existing app, then map all the fields. The drop-downs are filtered down by type to make the mapping process easier.

2. Configure the Phase Metrics Panel

Step 2 of the set up is to configure the Phase Metrics Panel.

As an App Panel, the Phase Metrics Panel is the UI part of the set up.

Phase Metrics Panel required fields:

  • Name: A unique name of the provider.
  • Height: Sets the height of the grid.
  • App: Select which app you would like for this app panel to reference.
  • Phase Metrics Provider: Select which provider you would like for this app panel to reference.

Go to the App Panels section in Advanced Designer and click on Phase Metrics Panel.

From the app drop-down select the app that has the data you want to use and from the Phase metrics provider drop-down select the phase metrics provider you just created.

3. Visualize Phase Metrics

If you want to show Phase Metrics as a view in your Source App then in your Phase Metrics Provider App you will need to create 1. an inherited role to this Phase Metrics Provider App and 2. a Relate to Transaction Action.

To learn more, check out:

Phase Metric visualizations include: Total Time in Phase and Number of Iterations Per Phase.

The y-axis will depend on the data for the record and adjust based on the longest time. You can see the unit of measurement on hover.

More phases will be added to the x-axis as the record progresses through the phases.

If a record goes backwards in the workflow then it will create an iteration.

Previous Article Generic Liquid Function
Next Article Creating a Sibling Relationship

© 2024 Onit, Inc.

docs.onit.com contains proprietary and confidential information owned by Onit, Inc. that is subject to copyright. Onit presents it exclusively to you for your sole use in conjunction with using Onit products. No portion of the materials contained herein may be used for any other purpose. No portion of the materials contained herein may be shared with third parties or reproduced in any form.