Custom fields

Custom fields are metadata that help you integrate Orbitera billing and marketplace data with third-party systems.

There are two types of custom fields:

  • Customer fields – Unique metadata fields that are applied to Orbitera-defined customers.
  • Cloud account fields – In Orbitera, a customer can be associated with multiple cloud accounts. Cloud account fields allow you to differentiate accounts from each other for a given customer.

Custom fields are not visible to or editable by end users. This is important for SAP integrations, for example, because you cannot allow your customers to edit resource labels if those labels are necessary inputs to your billing system.

Any project codes and internal codes are meaningless to Orbitera, but they might, for example, tell your internal systems which business unit owns the customer relationship, what their compensation schema is relative to that usage for that business unit, and how the invoice is routed through your internal systems.

How custom fields work

First, you attach custom fields as metadata to a customer or cloud account.

Then, your existing third-party systems – such as ERP or billing systems – can translate this metadata into relevant fields.

SAP account Example

A commonly used customer field for a SAP account might be named and labeled something like SAP_ID_Internal, where Internal can be any code.

This field would not be visible to a customer, but would be attached to a customer entity for integration with an SAP system.

Customer label

Configure a custom field

Go to Customer Fields

OR

Go to Cloud Account Fields

  1. Click Add.
  2. Enter a descriptive name.

    The name is a unique key that you can use in querying the API.

  3. Enter a descriptive label.

    The label is the human-readable name that appears in reports and dashboards.

  4. (Optional) By default, custom fields are included in billing reports as an added column that you can use to group, sort, and filter data.

    Including custom fields in billing reports is relevant for IaaS resellers, for example. You can disable this feature by clicking the slider.

  5. Click Save.

Populate custom fields

After you create a custom field, it is available to be populated with metadata values within each customer or partner. Custom Cloud Account Fields function in the same way, except the metadata is attached to an account within a customer entity.

Once populated, you can use these fields to filter and query reports and dashboards.

In addition, you can add custom fields to invoice headers. In Settings > Billing > Invoice Options, select Include custom fields in invoice header.

For customers

Go to Customers

  1. Edit a customer and select Custom fields or Cloud accounts.
  2. Enter customer-specific or account-specific data into the custom fields.

For partners

Go to Partners

  1. Edit a partner and select Custom fields.
  2. Enter partner-specific data into the custom fields.

Example

Let’s say you have many customers that are covered by a limited number of sales people. For commission reports, you need to allocate each customer to a salesperson.

To accomplish this, create a custom customer field named "Salesperson" and define this value within each Orbitera customer.

After the field is defined and populated, you can customize your Orbitera dashboards and reports to group content by these values.

Create the custom field

Define customer fields

Populate the custom field

Assign customer fields

Use the custom field in a deployment

Use customer fields

Learn more about passing custom fields in API calls.