Companion Metrics Upload

Upload metric values in bulk

The Upload tab lets you load one or more Companion Metric records from a file instead of entering them one by one.

This is the best option when you need to load recurring monthly actuals, planned values, or other metric updates at scale.

The Upload tab also helps you review upload counts and file-level results after the load completes.


What the upload file should contain

The upload file uses four core fields:

Field name

What it is for

Mandatory

Metric Name

Name of the metric you want to load

Yes

Date

Date used to derive the month and year for the record

Yes

Metric Type

Whether the value is Actual or Planned

Yes

Value

The metric value for that period

Yes


How the date field works

The date field determines the period for the uploaded record.

Yarken uses the date to derive the month and year.

Use the expected date format for your environment and keep that format consistent throughout the file.


How to upload Companion Metrics

  1. Go to Admin > Companion Metrics.

  2. Open the Upload tab.

  3. Select Upload.

  4. Choose the file you want to load.

  5. Review the field mapping.

  6. Confirm that Metric Name, Date, Metric Type, and Value are mapped correctly.

  7. Finish the upload and review the result.


When to use Upload

Use Upload when:

  • monthly values come from another system

  • actual and planned values need regular refresh

  • multiple metric records need to be loaded at once

  • you want a faster alternative to manual record creation


After the upload

After a successful load, review the results in:

  • the Upload tab for file-level confirmation

  • the Manage tab for record-level review

If values do not appear as expected, check the field mapping, date format, and metric names used in the file.


Good to know

  • Keep metric names consistent with the metric catalog used in the environment.

  • If the file structure is stable and reused often, pair this process with a saved mapping workflow where available.

  • Deleting an uploaded file record removes the records associated with that file from the environment.


Related content