Integration behavior

Settings

Published options that control V5 integration behavior, formatting, validation, and scheduling.

Showing all 23 settings

Setting

`export.markExported`

Controls whether the system automatically marks records as exported once they are passed through the end point.

For ensuring that data is transacted, this provides an ACK/NAK method of informing V5 that a record has been received.

A boolean value. 0 = Off. 1 = On.

Defaults to 1.

Value type: boolean
Result: true when exported records should be marked automatically

Setting

`format.1.date`

The system date format used for outputting

Value type: string
Result: the configured date format at the requested index, or an empty string when unavailable

Inputs

i You can specify as many formats as you like

Setting

`format.1.time`

The system time format used for outputting

Value type: string
Result: the configured time format at the requested index, or an empty string when unavailable

Inputs

i You can specify as many formats as you like

Setting

`import.client.type.lookup`

Includes the client type when looking up suppliers and customers during imports.

Value type: boolean
Result: true when supplier and customer lookup includes the client type

Setting

`import.formula.old.lookup.allowed`

Allows for the ability to lookup and schedule formula versions which are not the current by specifying the version in the job import

Value type: boolean
Result: true when imports may resolve and schedule non-current formula versions

Setting

`import.formulaStep.nullifyNegativeOrZeroTarget`

import.formulaStep.nullifyNegativeOrZeroTarget converts non-positive imported formula-step target values to null. The default is enabled.

Value type: boolean
Result: true when non-positive targets should be nullified

Setting

`import.formulaSteps.retainMessages`

import.formulaSteps.retainMessages preserves existing formula-step messages when formula steps are imported. The default is disabled.

Value type: boolean
Result: true when existing messages should be retained

Setting

`import.job.purgeBatchesReqOnReschedule`

Function used to clear down and recalculate the batches required if a job is rescheduled after it has already been started

Value type: boolean
Result: true when started-job rescheduling should purge and recalculate required batches

Setting

`import.order.lineLookup`

Makes the system look for a unique LineID as the primary key for purchase or sales order lines.

This provides the ability to have the same commodity listed on an order twice and be able to uniquely identify each order line.

Value type: boolean
Result: true when order-line imports use the unique line ID for lookup

Setting

`import.preBatch.dataField1ToPreBatchExtBatchNo`

import.preBatch.dataField1ToPreBatchExtBatchNo copies pre-batch data field 1 into the external batch-number field during import. The default is disabled.

Value type: boolean
Result: true when the copy behavior is enabled

Setting

`import.purchase.deleteNonPresentLines`

import.purchase.deleteNonPresentLines controls whether an updated purchase-order import deletes existing lines omitted from the payload. The default is disabled.

Value type: boolean
Result: true when omitted purchase-order lines should be deleted

Setting

`import.purchase.deliveryDate.offset`

A default offset number of days from a purchase order being acknowledged to it's delivery date being posted should delivery date not be specified

Value type: integer
Result: the configured delivery-date offset in days, defaulting to 0

Setting

`import.return.ID.only`

import.return.ID.only controls whether list-based imports return only persisted object identifiers instead of the full objects. The default is disabled.

Value type: boolean
Result: true when ID-only import responses are enabled

Setting

`import.sales.status`

The status a sales order should be imported with if it is not specified in the file

Value type: integer
Result: the default sales-order status, or -99 when no override is configured

Setting

`import.stock.purgeOnReceipt`

When importing a stock file, purge all stock on receipt of that file.

Only useful if sending the whole inventory import at once

Value type: boolean
Result: true when a stock import should purge existing stock before receipt

Setting

`import.validationLevel`

The level of tolerance the system allows for objects which don't exist.

0 - If the inner object does not exist, proceed to add as a null entry

1 - The inner object does not exist, cancel the import and return failure

Value type: integer
Result: the configured validation level, defaulting to 0

Setting

`scheduling.formulaLoss.mode`

scheduling.formulaLoss.mode selects the formula-loss handling mode passed to scheduling and formula-step import logic. The default mode is 0.

Value type: integer
Result: the configured formula-loss mode

Setting

`scheduling.jobNo.format`

The format that the job number will take the form of when importing without a job number.

Parameter 1 is the current date

Parameter 2 is the number of jobs scheduled on that date

Defaults to %1$tm%1$td%1$ty-|%2$04d|

Value type: string
Result: the configured generated job-number format

Setting

`scheduling.methodology`

The method by which job scheduling should be performed. The rules of scheduling must abide by the min,max and default/base size settings

Seek additional documentation from SG with regards the different scheduling options

0 - Attempt to create default sized batches with a remainder batch(s)

1 - Attempt to make all batches equal in size

2 - Attempt to create as many maximum sized batches as possible

Value type: integer
Result: the configured scheduling methodology, defaulting to 1

Setting

`scheduling.overproduction.allowed`

Allows for production to breach allowed limits set by min/max against the formula. See SG documentation for more information on production schedule limits.

Value type: boolean
Result: true when scheduling may exceed the formula production limits

Setting

`scheduling.status.mode`

Used to specify the status of a job should the status not be specified within the data

Value type: integer
Result: the configured default job status mode, defaulting to 1

Setting

`system.decimals`

The number of decimals to display for system outputs

Value type: integer
Result: the configured number of decimal places, defaulting to 3

Setting

`system.user`

Denotes the user which will be marked as performing the transactions which the API performs

This should preferably be set to a unique user ID such as "API" or "Integration"

Value type: string
Result: the configured user identifier, an empty string when unset, or null if the setting cannot be read