Remote Configuration

This page is outdated. Please go to our new documentation under https://docs.fulfillmenttools.com/documentation.

The remote configuration is used to store configurations affecting our clients such as the Backoffice and our applications. However, the fulfillmenttools backend is not using these remote configurations.

The remote configuration is a simple configuration key-value store. Based on a key, different values and value types can be saved. Furthermore, every entry can contain a specific scope, meaning that configurations can be made available only to certain user groups or clients.

Create / Update

Create a new remote configuration

POST/api/remoteconfigs

Body

application/json

key*string

unique business key of this entity

Example: "PICKING_SHOW_NEW_SCAN_VIEW"

scopesarray of RemoteConfigurationScopeForCreation (object)

valueType*RemoteConfigurationValueType (enum)

BOOLEANSTRINGJSONNUMBERINT

value*one of

stringintegernumberbooleanobject

groups*array of string

Response

200401403

Created entity in the body.

Body

application/json

createdstring (date-time)

The date this entity was created at the platform. This value is generated by the service.

Example: "2020-02-03T08:45:51.525Z"

lastModifiedstring (date-time)

The date this entity was modified last. This value is generated by the service.

Example: "2020-02-03T09:45:51.525Z"

version*integer (int64)

The version of the document to be used in optimistic locking mechanisms.

Example: 42

Request

JavaScriptCurlPython

const response = await fetch('/api/remoteconfigs', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "key": "PICKING_SHOW_NEW_SCAN_VIEW",
      "value": "text",
      "valueType": "BOOLEAN",
      "groups": [
        "INVENTORY"
      ]
    }),
});
const data = await response.json();

Response

200

{
  "id": "LGMl2DuvPnfPoSHhYFOm",
  "key": "PICKING_SHOW_NEW_SCAN_VIEW",
  "scopes": [
    {
      "id": "LGMl2DuvPnfPoSHhYFOm"
    }
  ],
  "valueType": "BOOLEAN",
  "value": "text",
  "groups": [
    "INVENTORY"
  ],
  "flattenScopeIds": [
    [
      "INVENTORY",
      "67151fc3-3ce1-400e-8b23-23c29e0cde90"
    ]
  ]
}

Add Scope

Read All

Get all remote configurations

GET/api/remoteconfigs

Query parameters

Response

200401403404

Central RemoteConfiguration

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/api/remoteconfigs', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Read Single

Delete Remote Config

Delete Scope

Example JSON

{
    "id": "REMOTE-CONFIG-ID-001",
    "key": "SHOW_RETURN_SECTION",
    "value": false,
    "valueType": "BOOLEAN",
    "groups": [
        "FULFILLMENT",
        "BACKOFFICE"
    ],
    "scopes": [
        {
            "id": "SCOPE-ID-0001",
            "facilityRefs": [
                "FACILITY-ID-001"
            ],
            "userRefs": [
                "USER-ID-001",
                "USER-ID-003"
            ]
        }
    ],
    "created": "2023-01-10T09:32:00.000+00:00",
    "lastModified": "2023-01-10T10:54:00.000+00:00",
    "version": 7
}

JSON Field Descriptions

key

The unique key that identifies the Remote Config entry, this can be freely chosen at entry creation.

value & valueType

The value of the key-value pair. With the valueType, the clients can identify the technical type of the value field for parsing.

groups

At creation every entry can (but it doesn't have to) have one or multiple groups. This are only simple strings that can defined free. If a client call later the API, this group-strings can be uses as filter. This way, every client gets only the configurations that are important to them.

scopes

Defines a specific scope where the configuration is available. It is possible to add different facilities and/or users. The facility and user declarations AND-linked.

Example:

"scopes": [{
    "id": "SCOPE-1234",
    "facilityRefs": [
        "FACILITY-4711",
        "FACILITY-4712"
    ],
    "userRefs": [
        "USER-40",
        "USER-43"
    ]
}]

In the example above the configuration will be only returned for user USER-40 or USER-43 that are working in facility FACILITY-4711 or FACILITY-4712. All other user and facility combinations will not get this Remote Configuration entry.

{
  "groups": [
    "BACKOFFICE"
  ],
  "key": "INBOUND_VIEW_ENABLED",
  "value": true,
  "valueType": "BOOLEAN"
}

Available Remote Configurations

Client	Value	Effect
Backoffice	groups: "BACKOFFICE" key: "INBOUND_VIEW_ENABLED" value: true valueType: BOOLEAN	The inbound view is visible in the facility view.
Backoffice	groups: "BACKOFFICE" key: "SENTRY_ENABLED" value: true valueType: BOOLEAN	If this config exists and is set to false we stop tracking errors on preand prdtenants. By default we track all error and analytics data on all tenants.
Backoffice	groups: "BACKOFFICE" key: "RETURN_VIEW_ENABLED" value: true valueType: BOOLEAN	The return view is visible in the network view.
Backoffice, Operations Web App	groups: "BACKOFFICE", "OPERATIONS_WEB_APP" key: "RETURN_VIEW_ENABLED" value: true valueType: BOOLEAN	The service tab in the task overview is visible. The feature custom-service must also be active in order to activate the service tab.
Backoffice	groups: "BACKOFFICE" key: "CHANNEL_ALLOCATION_VIEW_ENABLED" value: true valueType: BOOLEAN	The channel inventory tab is visible in the stock overview.
Backoffice	groups: "BACKOFFICE" key: "STORAGE_LOCATION_VIEW_ENABLED" value: true valueType: BOOLEAN	The storage location view is visible in the facility view.
Operations Webapp	groups: "BACKOFFICE" key: "NEW_PRINTPREP_ENABLED" value: true valueType: BOOLEAN	The new print-preparation process to order labels is enabled. Including future customs.
Backoffice, Operations Web App	groups:"OPERATIONS_WEB_APP", "BACKOFFICE" key: "SERVICE_JOBS_ENABLED" value: true valueType: BOOLEAN	The service tab is visible. The feature custom-service must also be active in order to activate the service tab.
Operations Web App	groups:"OPERATIONS_WEB_APP" key: "NEW_PRINT_OVERVIEW_ENABLED" value: true valueType: BOOLEAN	The new print overview is used.
Operations Web App	groups:"OPERATIONS_WEB_APP" key: "NEW_PACKING_ENABLED" value: true valueType: BOOLEAN	The new packing process is used.
Operations Android App	groups:"OPERATIONS_ANDROID" key: "android_native_printing_enabled" value: true valueType: BOOLEAN	Allows the user to select the native Android printing interface when printing documents.
Operations Android App	groups:"OPERATIONS_ANDROID key: "android_zebra_printing_enabled" value: true valueType: BOOLEAN	Allows the user to directly select Zebra printers in the network when printing documents.
Operations Android App	groups:"OPERATIONS_ANDROID key: "android_use_new_load_units" value: true valueType: BOOLEAN	Enables the new load units selection during the picking process.
Operations Android App	groups:"OPERATIONS_ANDROID key: "android_calc_ean_check_digit" value: true valueType: BOOLEAN	Enables the app to automatically calculate the check digit for EAN-8 and EAN-13 barcodes, if the scanning device doesn’t send the whole code to the app. This happens for example on some Honeywell devices. For the camera scan or devices that already send the whole code, this setting has no effect.
Operations Android App	groups:"OPERATIONS_ANDROID key: "android_use_picking_focus" value: true valueType: BOOLEAN	When this setting is active (true), the user is only able to scan the item that is currently in focus during the picking process. If disabled (false), the user is able to scan any item in the list during picking. When no value exists, the default fallback value is true. This setting only works if android_use_new_picking is enabled. This setting has no effect for pick jobs that require a storage locations to be scanned, or pick jobs where barcode validation is disabled.
Operations KMP App	{ "groups": [ "OPERATIONS_KMP" ], "key": "return_trigger_review_enabled", "value": true, "valueType": "BOOLEAN" }	When this setting is active (true), the user is able to tick a checkbox for every Article in an ItemReturn to indicate that this item needs further review before finishing the ItemReturn. If disabled (false), the checkbox will not be shown. This setting is only supported with App version 1.3.0 or newer.