Sign-off API implementation

This page provides implementation details about the usage of the Sign-off API 1.5.0 library within the MR Accelerator, focusing on configuration and included functionality. For documentation of the library itself, see Sign-off API.

Service implementations

SignOffService

The SignOffService class implements the ISignOffService interface, providing functionality for sign-off related methods.

The initiate method

Parses a SignOffProcessInstanceExportDTO for the data necessary to populate the store used to track the sign-off status.

The discard method

Uses a task name to remove the current status of a sign-off task and update any intraday data to be eligible for the next snapshot.

The approve method

Parses a SignOffProcessInstanceExportDTO for the data necessary to update the store used to track the sign-off status.

The export method

Parses a SignOffProcessInstanceExportDTO for the data necessary to create export orders through the Data Connectors library.

The service creates store-level (using ISearchFactsQuery objects) and aggregated (using MDX generated through Apache Velocity templates) export orders. Properties defined in the signoff.export.properties file are used to determine which fields are included in the export.

The endpoint returns a set of three export task IDs for the request.

The status method

Retrieves the Data Connectors export status for a set of Sign-off tasks. The statuses of the three export tasks are grouped into a single response containing the execution statuses and details about the result of the exports.

The kpis method

Returns Goal, Value and Status details for a list of filtered KPIs. The details are retrieved by executing a query against the running ActivePivot server.

SignOffRestService

The SignOffRestService class wraps the SignOffService in a set of REST endpoints.

SupportedAdjustmentsConfig

The SupportedAdjustmentsConfig class contains the Spring Beans that are autowired into the SupportedAdjustmentService, providing specifications for adjustments.

AdjustmentsExecutionConfig

The AdjustmentExecutionConfig class exposes executors for the supported adjustment types.

AdjustmentPivotConfig

The AdjustmentPivotConfig class adds a sign-off adjustment source-tagging dimension to the Sensitivity and PL cubes.

SignOffDatastoreCustomisations

Sign-off adjustment source-tagging datastore fields are added in the SignOffDatastoreCustomisations class, using the Accelerator Common Library and the Datastore Helper.

SignOffRestServiceConfig

The SignOffRestServiceConfig class adds the SignOffRestService and AdjustmentRestService services to the ActivePivot REST services.