Custom Dimensions

Workflows > Endpoints > Dimension Entities > Custom Dimensions

Purpose: Retrieve or update details on the available custom dimensions in Go.

This workflow is typically used in cases where the custom dimensions are of relevance for transactions posted to or retreived from Go. It is also needed in cases where the integrating party need to synchronize their dimension information to make sure that PowerOffice Go and their own systems have the same information about their set dimensions.

There are three custom dimensions available in Go: Dim1, dim2 and dim3. They are custom in that the client can define and set the name of the dimensions and the intended usage. For instance, a client might define that dim1 should be named "Machines", and then create the "Machine" values "Caterpillar -Y1", "Volvo 33", "Fiat AX3" etc. within that dimension.

The custom dimensions can also be defined using the api, and this must be integrated in the worfklow if not manually set defined by the client before the integration is activated and used.

Regardless of the direction of the data flow, we highly recommend that the integrating party store the Id's of the PowerOffice objects. In general, the id's of all the various PowerOffice entities are the preferred mapping key, as they are uniquely assigned by the system and cannot be changed.

Endpoint

Description of core flow

Synchronize to Go:

  1. Establish what the dimensions are used for (setup manually in Go or setup by api call), and map the usage of dim1/dim2/dim3 to the external system's usage of dimension (ie. the external system have a dimension "Component", and need to establish whether the dim1, dim2 or dim3 in Go should be used for "Components" on a given Go client).

  2. Check whether the dim1/dim2/dim3 object already exists in Go

  3. Create or update information

Synchronize from Go

  1. Check if there are any new or newly updated dim1/dim2/dim3 dimensions in Go

  2. Retrieve the desired fields and information

Prerequisites

  • Access to the CustomDimensionValue access privelige to retreive or update dimension values

  • Access to the CustomDimensionDefinition access privelige to retreive or update the definition of the custom dimensions

  • The client need at least one active subscription of a PowerOffice Go module

Related workflows

General relevance for most api workflows if custom dimensions are used


Dictionary/Terminology

The custom dimensions are part of the available dimensions that can be used on transactions i Go, for reporting purposes (ie grouping transactions on given custom dimensions when reporting). Custom dimensions (name and usage) are defined by the clients. They are typically used on clients when the fixed dimensions in Go are insufficient or do not fit the usecase, and/or the need for detailed reporting are present.