external
AdditionalProperty
Allocation
AllocationSource
AlternateProduct
BatchUpdate
Block
BOM
BOMMaterial
Calendar
CalendarRule
ChangeOverCost
ChangeOverProperty
Characteristic
Characteristics
Company
ConfigurationOperationType
ConsignmentCustomer
CoProduct
CopyForecastSnapshot
Cost
Currency
CustomerRank
CycleType
DDQRequest
DeleteDelivery
DeleteRun
DeleteTentativeOrders
Delivery
DerivedCharacteristic
EndCustomer
EndUse
EndUseDefinedProperty
EndUseProperty
ExchangeRate
ExcludeFromSA
ExternalFixedSource
Forecast
ForecastPattern
ForecastSnapshot
ForecastSnapshotValue
ForecastValue
Hierarchy
History
HoldingCost
InitialSourceRule
InitialSourceRuleSource
InputMaterial
Inventory
InvoiceForecast
Journey
JourneyRoute
Location
LocationAssignment
MarketData
MasterRoute
MultiStageAllocation
NominalCost
OperationPredecessor
OperationProperty
OperationTypeConversion
OrderClosure
OrderGroup
OrderHeader
OrderInformation
OrderInformationItem
OrderInventory
OrderLine
OrderLineProperty
OrderLineSplit
OrderLineSplitPart
OrderLineSupplyAndAllocate
OrderOperation
Price
Product
ProductCharacteristic
ProductGradeCost
ProductionConfiguration
ProductionRate
ProductionUpdate
ProductUnit
Property
PropertyCharacteristic
Reason
RemoveScenarioAllocations
RenameOrderLine
ReportFilter
ROParameter
Run
RunAction
RunAttribute
RunForecast
RunProduct
RunProductProperty
RunPropertyCharacteristic
RunReplenishment
ScenarioAllocation
Schedule
ScheduleRule
Site
SiteDefinedProperty
SiteProperty
Sku
SkuDefinedProperty
SkuProperty
SkuUpdate
SourcePriority
SourceProduct
SourcingPlan
Supercession
SupercessionHierarchy
SupercessionProperty
Supplier
SupplierInventory
TransportMethod
TransportRoute
User
UserGroup
UserGroupFilter
UserRole
ValidSource
WeeklyForecast
WorkCentre
WorkCentreAssignment
WorkCentreAttribute
WorkCentreCapacity
WorkCentreParameter
WorkCentreParameterType
WorkCentreShut
WorkCentreShutType
WorkCentreTimeEfficiency
WorkCentreType
base
BillOfMaterial
BSOGrade
BSOGradeProperty
BSOProgram
BSOProgramTemplate
CustomDataSource
DataSource
DataSourceField
DataSourceRole
DefinedProperty
ForecastMethod
ForecastParameterValue
HierarchyLevel
NavigationLevel
OperationType
ProductProperty
ProductRoute
ProductRouteStage
ProductType
Role
SystemReport
Unit
test
Test
TestOrderLine
TestSku
TestUsageHistory
core
Action
ActionRole
Bundle
BundleValue
Chart
ChartLine
CheckData
Column
CommonAction
CommonElement
Dashboard
DashboardWidget
DataSourceFilter
DbElement
DDQResultCode
Element
EventMessage
EventType
ForecastMethodType
ForecastParameter
ForecastRange
ForecastRangeValue
Grid
Language
LanguageCategory
MethodTypeParameter
NavigationTask
Page
PageElement
PageGrid
PageNavigation
PageParameter
ProcessPart
PurgeObsoleteData
ReportFilterEntry
Status
SystemParameter
SystemParameterValue
SystemTask
TaskResult
TaskRole
UnitType
UnitTypeConvert
Widget
WidgetParameter
WidgetRole
WidgetTemplate
WidgetTemplateParameter

BillOfMaterial extBillOfMaterial simple base
name type data type optional default description
docbook
locationCode attribute ShortString key
fromProductCode attribute String key
toProductCode attribute String key
percent attribute Identity yes
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

BSOGrade extBSOGrade simple base
name type data type optional default description
docbook
sequenceNo attribute Integer key Sequence No
mandatory attribute String yes yes Is mandatory Grade?
duration attribute Float yes Run length
minDuration attribute Float yes Minimum allowed run length
maxDuration attribute Float yes Maximum allowed run length
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
BSOProgramTemplate parent key
documentation
top

BSOGradeProperty extBSOGradeProperty simple base
name type data type optional default description
docbook
property attribute String key Property
code attribute String key Code
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
BSOGrade parent key
documentation
top

BSOProgram extBSOProgram simple base
name type data type optional default description
docbook
workcentreCode attribute String key Workcentre code
templateName attribute String key Program template name
sequenceNo attribute Integer key Sequence No
startDate attribute Date yes The date and time that the start of the template is assigned to
startRun attribute String yes The run of the template is assigned to
startBlock attribute String yes The block of the template is assigned to
oppRunLength attribute Float yes Duration of the default opp.run to be created for this template
fixOppRuns attribute String yes no Defines whether the opp.run of the Program Template should not be recalculated based on forecast
durationAdj attribute Float yes Duration adjusted by user
shutLength attribute Float yes The length of 'floating' shut to be added at the end of the template
earlyFixedPenalty attribute Float yes Early fixed penalty
dailyEarlyPenalty attribute Float yes Daily early penalty
lateFixedPenalty attribute Float yes Late fixed penalty
dailyLatePenalty attribute Float yes Daily late penalty
firstRun attribute String yes First Run Properties
lastRun attribute String yes Last Run Properties
firstRunMandatory attribute String yes no First Run Mandatory
lastRunMandatory attribute String yes no Last Run Mandatory
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

BSOProgramTemplate extBSOProgramTemplate simple base
name type data type optional default description
docbook
workCentreType attribute String yes Workcentre type
name attribute String key Program template name
oppRunLength attribute Float yes Duration of the default opp.run to be created for this template
fixOppRuns attribute String yes no Defines whether the opp.run of the Program Template should not be recalculated based on forecast
autoSizeRunDuration attribute String yes no Auto size run duration
templateDuration attribute Float yes Template duration
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

CustomDataSource extCustomDataSource simple base
name type data type optional default description
docbook
title attribute LongestString key
description attribute LongestString yes
dataSource attribute String no
filters attribute LongestString yes
rows attribute LongestString yes
columns attribute LongestString yes
values attribute LongestString yes
functions attribute LongestString yes
subTotalRows attribute LongestString yes
subTotalColumns attribute LongestString yes
showTotal attribute LongestString yes
showRecordCount attribute LongestString yes
columnsAsRows attribute LongestString yes
freezeColumns attribute LongestString yes
mergeRows attribute LongestString yes
mandatoryFilter attribute LongestString yes
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
top

DataSource extDataSource simple base
name type data type optional default description
docbook
name attribute String yes
description attribute LongestString yes
title attribute LongestString yes
query attribute LongestString no
type attribute String yes
usedDataSources attribute LongestString yes
useAsHelper attribute String yes
materialized attribute String yes
accessRights attribute String yes
allowProductUnits attribute Boolean yes Allow product units in report
currencyDateField attribute String no
language attribute String yes
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

DataSourceField extDataSourceField simple base
name type data type optional default description
docbook
name attribute String key
description attribute LongestString no
type attribute String no string
category attribute String yes
language attribute String yes
helper attribute String yes
helperColumn attribute String yes
expression attribute LongestString yes Expression
entityType attribute String yes
filtered attribute String no
includeNullCondition attribute String yes
isCurrency attribute String yes
unitType attribute String yes Unit Type
isMandatory attribute String yes Is Mandatory
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
DataSource parent
documentation
top

DataSourceRole extDataSourceRole simple base
name type data type optional default description
docbook
role attribute String key Role name
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
DataSource parent key DataSource
CustomDataSource parent key DataSource
documentation
top

DefinedProperty extDefinedProperty simple base
name type data type optional default description
docbook
name attribute String key Property name
description attribute String no Property description
dataType attribute ShortString no Data type
dataMask attribute String yes Mask
defaultValue attribute String yes Default value for property
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

ForecastMethod extForecastMethod simple base
name type data type optional default description
docbook
name attribute LongString key
type attribute String yes
description attribute LongString yes
internal attribute String yes no
language attribute String yes
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

ForecastParameterValue extForecastParameterValue simple base
name type data type optional default description
docbook
parameter attribute String key
value attribute String yes
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
ForecastMethod parent key
documentation
top

HierarchyLevel extHierarchyLevel simple base
name type data type optional default description
docbook
name attribute String key Hierarchy level name
level attribute Identity key Hierarchy level Identity
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

NavigationLevel extNavigationLevel simple base
name type data type optional default description
docbook
task attribute String key
name attribute String yes
order attribute Identity yes
orderByField attribute String yes
inputType attribute String yes combobox two possible values 'combobox' and 'text'
mandatory attribute String yes no Mean should value selected or can be not selected by user
hidden attribute String yes no Mean can picker be hidden in dynamic filter
displayLabel attribute String yes no Display label
defaultValue attribute String yes no Default value
defaultOperation attribute String yes no Default value
freeEntry attribute String yes no Mean can user input own value into picker
productType attribute String yes no Material type name
operationType attribute String yes no Operation type name
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

OperationType extOperationType simple base
name type data type optional default description
docbook
name attribute String key Operation type name
workCentreType attribute String no WorkCentre Type
applyCyclePlan attribute String yes yes WorkCentre Type
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
top

ProductProperty extProductProperty simple base
name type data type optional default description
docbook
productName attribute String key Product type
propertyName attribute String key Property name
level attribute Integer no Property level
stage attribute Integer no Production stage
dataMask attribute String yes Mask
defaultValue attribute String yes Default value
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
ProductType parent yes
documentation
top

ProductRoute extProductRoute simple base
name type data type optional default description
docbook
name attribute ShortString key Route code
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
top

ProductRouteStage extProductRouteStage simple base
name type data type optional default description
docbook
stageCode attribute ShortString no
orderNo attribute String no
operationType attribute String no Operation type
storeOutput attribute String yes Store Output
createCampaign attribute String yes Create Campign
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
ProductRoute parent key
top

ProductType extProductType simple base
name type data type optional default description
docbook
name attribute String key Product type name
finishedGoods attribute ShortString yes Main yes/no
singleStage attribute ShortString yes Main yes/no
unit attribute ShortString yes Unit used for rounding
namePattern attribute String yes Pattern for generation product code
codePattern attribute String yes Pattern for generation product name
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

Role extRole simple base
name type data type optional default description
docbook
name attribute String key Role name
description attribute LongString no Role description
isAdmin attribute ShortString yes no Is it Admin role (User has access to all locations)
internal attribute ShortString yes yes Is it internal role (not editable)
fromRole attribute ShortString yes yes copy from role
language attribute String yes
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

SystemReport extSystemReport simple base
name type data type optional default description
docbook
name attribute String key
description attribute LongestString key
type attribute String key
object attribute String key name of view or stored procedure
assignments attribute String key name of view or stored procedure
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
top

Unit extUnit simple base
name type data type optional default description
docbook
name attribute ShortString key Unit name
description attribute String no Unit description
toBase attribute DoubleFloat no Conversion factor to base unit
dividend attribute DoubleFloat no Dividend value for conversion factor to base unit
divisor attribute DoubleFloat no Divisor value for conversion factor to base unit
unitType attribute String no Unit type
isBase attribute ShortestString yes no Is this the base unit for this type?
productName attribute String no Product type name
dividendProductPart attribute LongString yes Formula for conversion - dividend
divisorProductPart attribute LongString yes Formula for conversion - divisor
fromBaseUnit attribute ShortestString yes no Is this convert the base unit for this type based on material units?
language attribute String yes
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

Action extAction simple core
name type data type optional default description
docbook
name attribute String key Action name
description attribute String yes Action description
title attribute String yes Common action name
hint attribute LongString yes Action hint
always attribute String yes false Is it default action (true, false)
parentAction attribute String yes no Paren action for grouping in dropdown lists
grid attribute String yes Grid name
gridcolumn attribute String yes Grid column(s) name
gridAction attribute String yes Grid action type (none/row/page)
override attribute String yes override action
multiSelect attribute String yes Action can be applied to several rows
language attribute String yes Language name
icon attribute String yes Icon
visible attribute String yes no Visible
groupName attribute String yes no GroupName
devMode attribute ShortestString yes no Is Dev Mode
etc attribute ShortestString yes no Is it an 'et cetera' action, to be shown in dropdown (yes, no)
configurable attribute ShortString yes Whether the action can be configured through Page Parameters
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Page parent key Page element
documentation
top

ActionRole extActionRole simple core
name type data type optional default description
docbook
name attribute String key Role Name
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Action parent key Action
top

Bundle extBundle simple core
name type data type optional default description
docbook
name attribute String key
includeNone attribute String yes
tableName attribute String yes
condition attribute LongString yes
fieldKey attribute String yes
fieldValue attribute String yes
fieldDescription attribute String yes
fieldOrderBy attribute String yes
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
top

BundleValue extBundleValue simple core
name type data type optional default description
docbook
key attribute String key
value attribute String yes
description attribute LongString no
orderNo attribute Integer yes Order in the list of parameter value
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Bundle parent no
top

Chart extChart simple core
name type data type optional default description
docbook
name attribute String key
description attribute String yes
type attribute ShortString yes
configuration attribute String yes
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Page parent yes
documentation
top

ChartLine extChartLine simple core
name type data type optional default description
docbook
field attribute String key
caption attribute String yes
type attribute ShortString yes
controlType attribute ShortString yes
state attribute ShortString yes
colorColumn attribute ShortString yes
backColorColumn attribute ShortString yes
dataColumns attribute ShortString yes
dataColumnsMapping attribute LongestString yes
editableColumn attribute ShortString yes
toolTipColumn attribute ShortString yes
classColumn attribute ShortString yes
transformColumn attribute ShortString yes
transformable attribute ShortString yes
transformFormat attribute ShortString yes
resizable attribute ShortString yes
showToolTip attribute ShortString yes
showTotal attribute ShortString yes
sort attribute ShortString yes
editable attribute ShortString yes
color attribute ShortString yes
pattern attribute ShortString yes
style attribute ShortString yes
filter attribute ShortString yes
configurable attribute ShortString yes
minWidth attribute ShortString yes
maxWidth attribute ShortString yes
dependOn attribute LongString yes Name of the parameter on which depends
dependBehaviour attribute LongString yes Behaviour on depended parameter (can be enabled, of disabled)
dependValues attribute LongString yes values for depend behaviour
value attribute LongString yes values for depend behaviour
description attribute String yes Page parameter description
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Chart parent yes
documentation
top

CheckData extCheckData simple core
name type data type optional default description
docbook
what attribute String key
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

Column extGridColumn simple core
name type data type optional default description
docbook
field attribute String key
caption attribute String yes
pageAction attribute String yes
type attribute ShortString yes
controlType attribute ShortString yes
state attribute ShortString yes
colorColumn attribute ShortString yes
backColorColumn attribute ShortString yes
dataColumns attribute ShortString yes
dataColumnsMapping attribute LongestString yes
editableColumn attribute ShortString yes
toolTipColumn attribute ShortString yes
classColumn attribute ShortString yes
transformColumn attribute ShortString yes
transformable attribute ShortString yes
transformFormat attribute ShortString yes
resizable attribute ShortString yes
showToolTip attribute ShortString yes
showToolTipColumn attribute ShortString yes
showTotal attribute ShortString yes
totalFunction attribute ShortString yes
sort attribute ShortString yes
financial attribute ShortString yes
editable attribute ShortString yes
color attribute ShortString yes
backgroundColor attribute ShortString yes
style attribute ShortString yes
filter attribute ShortString yes
configurable attribute ShortString yes
gridFilter attribute ShortString yes
subrow attribute ShortString yes
minWidth attribute ShortString yes
maxWidth attribute ShortString yes
dependOn attribute LongString yes Name of the parameter on which depends
parameter attribute LongString yes Name of the parameter on which depends
parameterValue attribute LongString yes Name of the parameter on which depends
dependOnColumn attribute LongString yes Name of dependand column
dependBehaviour attribute LongString yes Behaviour on depended parameter (can be enabled, of disabled)
dependValues attribute LongString yes values for depend behaviour
value attribute LongString yes values for depend behaviour
orderColumn attribute String yes For transformed coluns
dataType attribute ShortString no
bundle attribute String yes bundle with values
description attribute String yes Page parameter description
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Grid parent yes
documentation
top

CommonAction extCommonAction simple core
name type data type optional default description
docbook
name attribute String key Common action name
description attribute LongString key Common action description (translable)
hint attribute LongString yes Common action hint (translable)
gridAction attribute String yes Grid action type (none/row/page)
language attribute String yes Language name
icon attribute String yes Icon
visible attribute String yes no Visible
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

CommonElement extCommonElement simple core
name type data type optional default description
docbook
name attribute String key Element name
text attribute LongString no Element text
language attribute String no Language name
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

Dashboard extDashboard simple core
name type data type optional default description
docbook
name attribute String key Name
description attribute String yes Description
owner attribute String yes Owner Dashboard
orderNo attribute Integer yes OrderNo
language attribute String yes Language name
action attribute ShortestString yes A message Widget - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

DashboardWidget extDashboardWidget simple core
name type data type optional default description
docbook
widget attribute String key Widget name
action attribute ShortestString yes A message Widget - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Dashboard parent key
top

DataSourceFilter extDataSourceFilter simple core
name type data type optional default description
docbook
name attribute String key Report filter name
user attribute String key User Name
action attribute ShortestString yes A message Widget - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
DataSource parent
ReportFilter child
documentation
top

DbElement extDBElement simple core
name type data type optional default description
docbook
name attribute LongString key
description attribute LongestString yes
language attribute String key
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

DDQResultCode extDDQResultCode simple core
name type data type optional default description
docbook
code attribute String key
name attribute LongString no
description attribute LongestString no
subdesc attribute LongString yes
language attribute String yes
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

Element extElement simple core
name type data type optional default description
docbook
name attribute LongString key Element name
description attribute LongestString yes Element description
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

EventMessage extEventMessage simple core
name type data type optional default description
docbook
name attribute String key
description attribute LongestString key
type attribute String key
language attribute String yes
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

EventType extEventType simple core
name type data type optional default description
docbook
name attribute String key
level attribute Identity key
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

ForecastMethodType extForecastMethodType simple core
name type data type optional default description
docbook
name attribute String key
description attribute String yes
language attribute String yes
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

ForecastParameter extForecastParameter simple core
name type data type optional default description
docbook
name attribute String key
description attribute String key
defaultValue attribute String key
dataType attribute ShortString yes
dataMask attribute String yes
bundle attribute ShortString yes
language attribute String yes
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

ForecastRange extForecastRange simple core
name type data type optional default description
docbook
name attribute String key
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
top

ForecastRangeValue extForecastRangeValue simple core
name type data type optional default description
docbook
from attribute String yes
to attribute String yes
percentage attribute String yes
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
ForecastRange parent no
top

Grid extGrid simple core
name type data type optional default description
docbook
name attribute String key
description attribute String yes
columnsAsRows attribute String yes
extendCaptions attribute String yes
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Page parent yes
documentation
top

Language extLanguage simple core
name type data type optional default description
docbook
name attribute String key Language name
desc attribute String yes Language name Language description
internal attribute ShortString yes no
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

LanguageCategory extLanguageCategory simple core
name type data type optional default description
docbook
type attribute String key
category attribute String key
name attribute String key
mask attribute LongString yes
desc attribute LongString yes
table attribute String yes
key attribute String yes
field attribute String yes
condition attribute LongString yes
name2 attribute String yes
language attribute String yes
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

MethodTypeParameter extMethodTypeParameter simple core
name type data type optional default description
docbook
name attribute String key
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
ForecastMethodType parent key
documentation
top

NavigationTask extNavigationTask simple core
name type data type optional default description
docbook
name attribute ShortString key Navigation task name
sourceType attribute ShortString yes Source type for navigation task - page, picker
source attribute ShortString yes Source view
fullSource attribute ShortString yes Full Source view
filterType attribute ShortString yes Filter type for dynamic picker - SKUBased, MaterialBased, LocationBased, RunBased
area attribute ShortString yes
unrestricted attribute ShortString yes
pageName attribute ShortString yes
validate attribute LongString yes
system attribute ShortString yes yes
allowedOperations attribute LongString yes List of available operation if used as filter
specificType attribute LongString yes usual Mark that navigation task is specific
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

Page extPage simple core
name type data type optional default description
docbook
name attribute String key
description attribute LongString yes
hint attribute LongString yes
type attribute String yes
language attribute String yes
always attribute String yes
blockedTasks attribute String yes
helpref attribute String yes Help reference
cloud attribute Integer yes
cloudParentPage attribute String yes
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
devMode attribute ShortestString yes no Is Dev Mode
icon attribute String yes
documentation
top

PageElement extPageElement simple core
name type data type optional default description
docbook
name attribute String key
text attribute LongestString yes
language attribute String yes
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Page parent key
top

PageGrid extPageGrid simple core
name type data type optional default description
docbook
name attribute String key
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Page parent key
documentation
top

PageNavigation extPageNavigation simple core
name type data type optional default description
docbook
name attribute String key name of navigation
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Page parent key
documentation
top

PageParameter extPageParameter simple core
name type data type optional default description
docbook
name attribute String key
description attribute LongString no
hint attribute LongString yes
value attribute String no
minValue attribute ShortString yes
maxValue attribute ShortString yes
type attribute String no
group attribute String yes Group name
dataType attribute ShortString no
dependOn attribute LongString yes Name of the parameter on which depends
dependBehaviour attribute LongString yes Behaviour on depended parameter (can be enabled, of disabled)
dependValues attribute LongString yes values for depend behaviour
orderNo attribute String yes Order number in the list of parameters.
separator attribute enum yes Required separator?
bundle attribute String yes bundle with values
pageAction attribute enum yes Page action permission for parameters created from grid columns
language attribute String yes
action attribute ShortestString yes V message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add, V - validate
devMode attribute ShortestString yes no Is Dev Mode
Page parent key
documentation
top

ProcessPart extProcessPart simple core
name type data type optional default description
docbook
name attribute String key
desc attribute LongString yes
type attribute String yes
order attribute String yes
language attribute String yes
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
SystemTask parent key
documentation
top

PurgeObsoleteData extPurgeObsoleteData simple core
name type data type optional default description
docbook
name attribute String key
description attribute LongString no
help attribute LongestString yes Parameter help text
period attribute String no
periodType attribute String no
language attribute String yes
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

ReportFilterEntry extReportFilterEntry simple core
name type data type optional default description
docbook
name attribute String key Report filter field name
operation attribute ShortString no Report filter operator
values attribute LongestString no Report filter values
aggregation attribute ShortString yes Report filter aggregation function
action attribute ShortestString yes A message Widget - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
ReportFilter parent key
documentation
top

Status extStatus simple core
name type data type optional default description
docbook
type attribute String key
name attribute String key
description attribute String yes
code attribute String yes
abbreviation attribute String yes
level attribute Identity yes
language attribute String yes
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

SystemParameter extSystemParameter simple core
name type data type optional default description
docbook
name attribute String key
description attribute LongString no
help attribute LongestString yes Parameter help text
value attribute String no
minValue attribute ShortString yes
maxValue attribute ShortString yes
type attribute String no
dataType attribute ShortString no
readonly attribute String yes no
clearValues attribute String yes no
bundle attribute String yes Bundle name
area attribute String yes Interface parameter area
category attribute LongString yes Dummy attribute for classification in documentation. Should not be used by external system.
dependOn attribute LongString yes Name of the parameter on which depends whether the specified parameter is enabled.
cloud attribute String yes is it used for cloud version.
language attribute String yes
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

SystemParameterValue extSystemParameterValue simple core
name type data type optional default description
docbook
key attribute String yes
value attribute String yes
table attribute String yes
condition attribute String yes
fieldKey attribute String yes
fieldValue attribute String yes
description attribute LongString no
orderNo attribute Integer yes Order in the list of parameter value
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
SystemParameter parent yes
documentation
top

SystemTask extSystemTask simple core
name type data type optional default description
docbook
name attribute String key
description attribute String yes
system attribute ShortString yes yes
daysToKeepLogs attribute Integer yes 365
executable attribute String yes
language attribute String yes
isActive attribute ShortString yes no
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

TaskResult extTaskResult simple core
name type data type optional default description
docbook
name attribute String key
description attribute LongString yes
isForActive attribute String yes
order attribute String yes
dataType attribute String yes
language attribute String yes
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
SystemTask parent key
documentation
top

TaskRole extTaskRole simple core
name type data type optional default description
docbook
name attribute String key Role Name
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
SystemTask parent key Task
top

UnitType extUnitType simple core
name type data type optional default description
docbook
name attribute String key
description attribute String yes
language attribute String yes
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

UnitTypeConvert extUnitTypeConvert simple core
name type data type optional default description
docbook
from attribute String key
to attribute String yes yes
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

Widget extWidget simple core
name type data type optional default description
docbook
name attribute String key Widget name
description attribute String yes Widget description
category attribute String yes Widget category
template attribute String yes Widget template
isEditable attribute ShortestString yes no Is this the widget editable by user?
language attribute String yes Language name
action attribute ShortestString yes A message Widget - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Dashboard parent yes
top

WidgetParameter extWidgetParameter simple core
name type data type optional default description
docbook
name attribute String key Widget patameter name
value attribute LongString yes Widget patameter value
hidden attribute String yes no Mean can parameter be hidden
action attribute ShortestString yes A message Widget - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Widget parent key
documentation
top

WidgetRole extWidgetRole simple core
name type data type optional default description
docbook
name attribute String key Role Name
action attribute ShortestString yes A message Widget - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Widget parent key Widget
documentation
top

WidgetTemplate extWidgetTemplate simple core
name type data type optional default description
docbook
name attribute String key Widget template name
category attribute String no Widget template name
description attribute String no Widget template name
action attribute ShortestString yes A message Widget - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
top

WidgetTemplateParameter extWidgetTemplateParameter simple core
name type data type optional default description
docbook
name attribute String key Widget template patameter name
value attribute LongString yes Widget template patameter value
controlType attribute String yes Hidden Control to use for the parameter
mandatory attribute String yes Hidden Mean parameter is required
category attribute String yes Hidden Control grouping category
options attribute String yes Additional options for various controls
bundle attribute String yes bundle with values
description attribute String yes Widget template patameter description
help attribute LongestString yes Widget template patameter help
orderNo attribute Integer yes Order of UI control in the category
action attribute ShortestString yes A message Widget - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
WidgetTemplate parent key
documentation
top

AdditionalProperty extAdditionalProperty simple external
name type data type optional default description
docbook
type attribute String key
code attribute String no The value
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
ProductType parent yes
Product parent yes
documentation
top

Allocation extAllocation simple external
name type data type optional default description
docbook
sourceMonth attribute Date yes Source Month
sourceWeek attribute Date yes Source Week
deliveryMonth attribute Date yes Delivery Month
deliveryWeek attribute Date yes Delivery Week
workCentre attribute String yes workcentre
value attribute Float yes Allocation
unit attribute String yes Allocation
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Characteristics child yes
Sku parent yes
documentation
top

AllocationSource extAllocationSource simple external
name type data type optional default description
docbook
sourceMonth attribute Date yes Source Month
sourceWeek attribute Date yes Source Week
workCentre attribute String yes work centre code
operationType attribute String yes operation type
value attribute Float yes Allocation
unit attribute String yes Allocation
isLastStage attribute String yes Allocation
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
MultiStageAllocation parent key
documentation
top

AlternateProduct extAlternateProduct simple external
name type data type optional default description
docbook
code attribute String yes Product code
location attribute ShortString yes Company code
name attribute LongString no Product name
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Product parent yes
documentation
top

BatchUpdate extBatchUpdate simple external
name type data type optional default description
docbook
type attribute String key type of batch process
phase attribute ShortString key phase
workCentre attribute String yes Workcentre code
removeShutdowns attribute ShortString yes no remove Shutdowns
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

Block extBlock simple external
name type data type optional default description
docbook
workCentre attribute String key Work centre code
code attribute ShortString key Block code
periodStart attribute DateTime yes Block start date - ignored for incoming messages
periodEnd attribute DateTime yes Block end date - ignored for incoming messages
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Property child yes
documentation
top

BOM extBOM simple external
name type data type optional default description
docbook
code attribute String key
deleteObsoleteMaterials attribute String yes The value
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

BOMMaterial extBOMMaterial simple external
name type data type optional default description
docbook
product attribute String yes
alternateCode attribute ShortString yes Alternate product code
alternateCodeLocation attribute ShortString yes Alternate product location code
operationType attribute String key The value
inputUnit attribute String yes The value
outputUnit attribute String yes The value
conversionMultiplier attribute Float yes The value
conversionDivider attribute Float yes The value
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
BOM parent key
documentation
top

Calendar extCalendar simple external
name type data type optional default description
docbook
name attribute String key Calendar name
basedOn attribute String yes Name of calendar to base upon
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

CalendarRule extCalendarRule simple external
name type data type optional default description
docbook
day attribute Integer no 0 Day of month
month attribute Integer no 0 Month
year attribute Integer no 0 Year
dayOfWeek attribute Integer no 0 Day of week
numOfWeek attribute Integer no 0 Number of week in month
description attribute LongString no Description for rule
isWorkingDay attribute ShortestString no no Is this a working day?
isReceivingDay attribute ShortestString no no Is this a receiving day?
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Calendar parent key
documentation
top

ChangeOverCost extChangeOverCost simple external
name type data type optional default description
docbook
cost attribute Float no
time attribute Float no
timeUnit attribute String yes
dateFrom attribute Date no
removeAll attribute ShortString yes
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
WorkCentre child key
documentation
top

ChangeOverProperty extChangeOverProperty simple external
name type data type optional default description
docbook
property attribute String key
codeFrom attribute String key
codeTo attribute String key
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
ChangeOverCost parent key
documentation
top

Characteristic extCharacteristic simple external
name type data type optional default description
docbook
property attribute String yes property name
hierarchy attribute String yes hierarchy levle name
location attribute String yes location code
skuProperty attribute String yes sku property name
product attribute String yes product code
productType attribute String yes product type name
endUse attribute String yes end use code
endUseProperty attribute String yes end use property name
endCustomer attribute String yes endCustomer code
characteristic attribute String yes property name
code attribute String yes code for hierarchy, property, sku propery, end use property
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Characteristics parent key
top

Characteristics extCharacteristics simple external
name type data type optional default description
docbook
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
top

Company extCompany simple external
name type data type optional default description
docbook
name attribute String no Company name
code attribute ShortString key Company code
internal attribute ShortestString yes no Is it internal company?
rank attribute String yes Customer rank
safetyStockMethod attribute String yes null Safety stock method name
groupReplenishedLocations attribute ShortestString yes no Group replenished locations
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

ConfigurationOperationType extConfigurationType simple external
name type data type optional default description
docbook
type attribute String key
stageCode attribute ShortString yes
orderNo attribute String yes
inputUnit attribute String yes The value
outputUnit attribute String yes The value
multiplier attribute Float yes The value
divider attribute Float yes The value
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
ProductionConfiguration parent key
documentation
top

ConsignmentCustomer extConsignmentCustomer simple external
name type data type optional default description
docbook
customerCode attribute String key no Customer Location code
replenished attribute ShortString yes no Replenishment status yes/no
daysOfSupply attribute Integer yes 1 Days of supply
maxDaysOfSupply attribute Integer yes 1 Days of supply
highQuantity attribute Float yes 0 Safety stock high quantity
lowQuantity attribute Float yes 0 Safety stock low quantity
minOrderQuantity attribute Float yes 1 Minimum quantity to order
orderUnit attribute ShortString yes NULL Name of the unit to be used in the orders
replenishmentFrequency attribute Identity yes 12 Replenishment parameter
maxReplenishmentFrequency attribute Identity yes 12 Replenishment parameter
replenishmentStartDate attribute Date yes NULL Date to start replenishing
replenishmentFinishDate attribute Date yes NULL Date to finish replenishing
safetyStockMethod attribute String yes null Safety stock method name
maxSafetyStockMethod attribute String yes null Safety stock method name
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Sku parent key
documentation
top

CoProduct extCoProduct simple external
name type data type optional default description
docbook
product attribute String key
percentage attribute Float no The percentage
pricePercentage attribute Float no The price percentage
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Product parent key
documentation
top

CopyForecastSnapshot extCopyForecastSnapshot simple external
name type data type optional default description
docbook
snapshotName attribute String yes Forecast snapshot name
status attribute String yes Customer Forecast status after coping values
top

Cost extCost simple external
name type data type optional default description
docbook
dateFrom attribute Date yes {SystemDate} Effective date for cost
cost attribute Float yes Cost (financial unit per kg)
operationType attribute String yes Operation type
weightUnit attribute ShortString yes kg weight unit (default weight unit if not specified)
currency attribute ShortString yes Currency (Default currency in system)
weighting attribute Integer yes 1 Weighting
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add, in case when dateFrom not specified and action = 'D' will be removed all costs for particularworkcentre
WorkCentre child key
Characteristics child no
documentation
top

Currency extCurrency simple external
name type data type optional default description
docbook
name attribute String key Currency name
description attribute String yes Currency description
internal attribute ShortString yes yes Is it internal Currency (Default currency in system)
language attribute String yes
action attribute ShortestString yes A message action - Insert, Add or Amend, Update, Delete. Note: if the action is delete and no effective date is specified, all exchange rates are deleted
documentation
top

CustomerRank extCustomerRank simple external
name type data type optional default description
docbook
name attribute String key Customer rank name
description attribute String no Customer rank description (translable)
priority attribute Integer no Rank priority
displayInForecast attribute Integer yes Rank priority
language attribute String yes
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
top

CycleType extCycleType simple external
name type data type optional default description
docbook
frequency attribute Integer yes 1 Frequency in weeks, i.e. produced every N weeks
weekTolerance attribute Integer yes 0 Earlier tolerance, for producing earlier
priority attribute String yes Priority
producingDay attribute Integer yes 0 Preferred day for producing 1-7 Mon-Sun, 0 - any
groupName attribute Integer yes 0 Preferred day for producing 1-7 Mon-Sun, 0 - any
fixedPeriod attribute Integer yes 0 Preferred day for producing 1-7 Mon-Sun, 0 - any
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Characteristics child
top

DDQRequest extDDQRequest simple external
name type data type optional default description
docbook
RequestId attribute ShortString yes
Sender attribute ShortString yes
HeaderCode attribute ShortString yes
OldHeaderCode attribute ShortString yes
autoCreate attribute Integer yes
LineCode attribute String yes
OldLineCode attribute String yes
LocationCode attribute String yes
MultiLine attribute Integer yes
ProductCode attribute String yes
EndCustomerCode attribute String yes
EndUseCode attribute String yes
SFGProductCode attribute String yes
RequestDate attribute Date yes
LateDays attribute Integer yes
InquiryMethodCode attribute ShortString yes
Unit attribute ShortString yes
Quantity attribute Float yes
TransportMethod attribute ShortString yes
JourneyCode attribute ShortString yes
TypeOfDelivery attribute ShortestString yes
ExpiryDate attribute Date yes
CheckAllocationMethod attribute ShortString yes
TransportAreaCode attribute ShortString yes
SourceWarehouseCode attribute ShortString yes
FixSourceAssignment attribute ShortString yes
SourceTypes attribute Integer yes
OrderSplit attribute Integer yes
SingleSourcing attribute Integer yes
FinishingLock attribute Integer yes
UseOpportunisticRuns attribute Integer yes
PartialDelivery attribute Integer yes
Quality attribute Integer yes
StartNotBefore attribute Date yes
RequestType attribute Integer yes
LoggingLevel attribute Integer yes
DisregardAllocation attribute Integer yes
ConsignmentParameters attribute Integer yes
ConsignmentLocation attribute ShortString yes
ReplaceConsignment attribute Integer yes
consignmentOrder attribute Integer yes
autoConfirm attribute Integer yes
AllowLateOrders attribute Integer yes 1
UseInventory attribute Integer yes 0
UseProjectedInventory attribute Integer yes 0
UseConsignmenmtInventory attribute Integer yes 0
UseProduction attribute Integer yes 0
ReATPRequired attribute Integer yes
DDQSourcingCategories attribute LongString yes
top

DeleteDelivery extDeleteDelivery simple external
name type data type optional default description
docbook
line attribute String key Delivery line number
top

DeleteRun extDeleteRun simple external
name type data type optional default description
docbook
blockCode attribute ShortString yes Block code. If specified and cascade=yes then delete all runs inside block.
code attribute LongString yes Run code
workCentre attribute String key Workcentre code. If specified and cascade=yes then delete all runs for this workcentre.
cascade attribute ShortString yes yes If yes then remove all runs after specified run
periodStart attribute DateTime yes
periodEnd attribute DateTime yes
shutdownPeriodEnd attribute DateTime yes
deleteRuns attribute ShortString yes yes
deleteShutdowns attribute ShortString yes no
action attribute ShortestString yes A currently not used
documentation
top

DeleteTentativeOrders extDeleteTentativeOrders simple external
name type data type optional default description
docbook
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

Delivery extDelivery simple external
name type data type optional default description
docbook
orderCode attribute ShortString yes Order header code
orderLine attribute String yes Order line number
line attribute String yes Delivery line number
shipDate attribute Date no Date shipped (YYYY-MM-DD)
dueDate attribute Date no Date due (YYYY-MM-DD)
receivedDate attribute Date yes Date received (YYYY-MM-DD)
quantity attribute Float no Quantity in base weight units
unit attribute ShortString yes Unit name override
status attribute String no Status: Planned, InTransit, Delivered, Cancelled, SeparateDelivery
sourceType attribute ShortString yes Indicate whether the dispatched quantity was from a production or stock source, values are Stock or Production
sourceWarehouse attribute String yes This is the site warehouse that the order is dispatched from
targetWarehouse attribute String yes This is the site warehouse that the order is delivered to
alternativeKey attribute String yes Alternative Key
reATPOrderCode attribute String yes reAtp order code
reATPOrderLine attribute String yes reAtp order line
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

DerivedCharacteristic extDerivedCharacteristic simple external
name type data type optional default description
docbook
name attribute String key Characteristic name
level attribute Identity key Characteristic level
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

EndCustomer extLocation simple external
name type data type optional default description
docbook
name attribute String no Location name
code attribute ShortString key Location code
transportArea attribute ShortString yes Transport area location code
stockLocation attribute ShortString yes Stock area location code
warehouseGroupLocation attribute ShortString yes Warehouse group location code
site attribute ShortString yes Site code
company attribute ShortString yes Company code
rank attribute String yes Custome rank
calendar attribute String yes Calendar name
currency attribute String yes Currency
capacity attribute Float yes 0 Capacity of location
forecastMethod attribute LongString yes null Forecast method name
safetyStockMethod attribute String yes null Safety stock method name
orderAutoConfirmPeriod attribute Integer yes 0 Replenishment orders auto-confirmation period
defaultCustomerForecast attribute ShortString yes System
Hierarchy child yes Hierarchy element
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

EndUse extEndUse simple external
name type data type optional default description
docbook
code attribute ShortString key End use code
description attribute String yes End use description
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

EndUseDefinedProperty extEndUseDefinedProperty simple external
name type data type optional default description
docbook
name attribute String key Property level name
level attribute Identity key Property level Identity
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

EndUseProperty extEndUseProperty simple external
name type data type optional default description
docbook
name attribute String key End use property name
value attribute String no End use property value
action attribute ShortestString yes A message Widget - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
EndUse parent key
documentation
top

ExchangeRate extExchangeRate simple external
name type data type optional default description
docbook
currency attribute String key This is the currency to convert to from the system’s base currency
multiplier attribute DoubleFloat no The value to multiply the base currency by to convert to the specified currency. Can be used in conjunction with divider to specify the rate as a fraction
divider attribute DoubleFloat yes 1 Used with the multiplier to calculate the rate to convert from the base currency to the specified currency. Not usually required (hence defaults to 1), but useful if the exchange rate is a very low value to avoid rounding errors, eg the old Turkish lira was over 1,000,000 to the GBP
effectiveDate attribute Date yes 2000-01-01 Date that the exchange rate becomes effective
action attribute ShortestString yes A message action - Add or Amend Standard actions Insert, Add or Amend, Update, Delete. Note: if the action is delete and no effective date is specified, all exchange rates are deleted
documentation
top

ExcludeFromSA extExcludeFromSA simple external
name type data type optional default description
docbook
property attribute String key Property type
value attribute String no Property value
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
top

ExternalFixedSource extExternalFixedSource simple external
name type data type optional default description
docbook
workCentre attribute Date key Effectie Date
dateFrom attribute Date yes Date From
dateTo attribute Date yes Date To
capacity attribute Date yes Capacity
unit attribute String yes Unit name
periodType attribute Date yes PeriodType
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Characteristics child
documentation
top

Forecast extForecast simple external
name type data type optional default description
docbook
startDate attribute Date key Forecast header start date
offset attribute Integer optional Forecast header offset
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

ForecastPattern extForecastPattern simple external
name type data type optional default description
docbook
name attribute String key Forecast pattern name
startMonth attribute Date yes Forecast pattern start month
values attribute String yes Forecast pattern values: comma separated list of numbers
action attribute String yes Action name
documentation
top

ForecastSnapshot extForecastSnapshot simple external
name type data type optional default description
docbook
name attribute String key
description attribute String yes
startDate attribute Date no
finishDate attribute Date no
copyMonthlyForecast attribute ShortString yes
populateReferenceData attribute ShortString yes
purgeExistingValues attribute ShortString yes
newSkuMask attribute LongString yes Mask for new products
isEmpty attribute ShortString yes is empty snapshot
isBudget attribute ShortString yes is budget
autoSKUStatus attribute ShortString yes setup forecast and replenishment statuses for SKU
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Characteristics child no
top

ForecastSnapshotValue extForecastSnapshotValue simple external
name type data type optional default description
docbook
snapshotName attribute String key Forecast snapshot name
dateFrom attribute Date key date for forecast first day of month of first day of week
period attribute String yes month month or week
weight attribute DoubleFloat yes weight
unit attribute Identity yes
price attribute Float yes
currency attribute Identity yes
cost attribute Float yes
valueAdd attribute Float yes
costAdjustment attribute Float yes
valueAddAdjustment attribute Float yes
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Characteristics child yes
Sku parent yes
documentation
top

ForecastValue extForecastValue simple external
name type data type optional default description
docbook
startDate attribute Date yes Start date for forecast
dateFrom attribute Date key date for forecast first day of month of first day of week
period attribute String yes month month or week
type attribute String yes system customer, system or final
weight attribute DoubleFloat yes weight
unit attribute Identity yes
price attribute Float yes
currency attribute Identity yes
cost attribute Float yes
valueAdd attribute Float yes
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Characteristics child yes
Sku parent yes
documentation
top

Hierarchy extHierarchy hierarchical external
name type data type optional default description
docbook
type attribute String key Hierarchy type
value attribute String no Hierarchy value
code attribute ShortString key Hierarchy code
latitude attribute ShortString yes Latitude
longitude attribute ShortString yes Longitude
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

History extHistory simple external
name type data type optional default description
docbook
type attribute ShortString yes usage History type, usage will overwrite, delivery will add to any previous quantity
quantityWeight attribute Float yes Weight quantity
quantityAdjusted attribute Float yes Adjusted Weight quantity
quantityUnits attribute Float yes 0 Unit quantity eg the number of sheets
unit attribute ShortString yes Unit name
dateUsed attribute Date yes Date of history
workCentre attribute ShortString yes Workcentre code
site attribute ShortString yes TEMPORARY ATTRIBUTE - obsolete
price attribute Float yes 0 Price
currency attribute ShortString yes Currency
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Sku parent key
documentation
top

HoldingCost extHoldingCost simple external
name type data type optional default description
docbook
cost attribute Float yes Holding cost in fin. unit/kg/day, will be stored as fin. unit/Tn/week
dateFrom attribute Date yes {SystemDate} Effective date
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Site parent key Site element
documentation
top

InitialSourceRule extInitialSourceRule simple external
name type data type optional default description
docbook
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Characteristics child key
top

InitialSourceRuleSource extInitialSourceRuleSource simple external
name type data type optional default description
docbook
workCentre attribute String yes Source work centre code
site attribute String yes Source site code
operationType attribute String yes Operation Type
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
InitialSourceRule parent key
top

InputMaterial extInputMaterial simple external
name type data type optional default description
docbook
product attribute String key
unit attribute String yes The value
quantity attribute Float yes The value
remainingQuantity attribute Float yes The value
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
OrderOperation parent key
documentation
top

Inventory extInventory simple external
name type data type optional default description
docbook
type attribute ShortString yes opening Type of inventory message, opening overwrites, adjustments adds
snapshotDate attribute Date yes Date of inventory snapshot
quantityWeight attribute Float no Weight
availableOnHandWeight attribute Float yes available on hand weight
quantityWeightAdjustment attribute Float yes Weight adjustment
unit attribute ShortString yes Unit name
consignmentLocation attribute ShortString yes Consignment Location code
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Sku parent key SKU element
documentation
top

InvoiceForecast extIndicatives simple external
name type data type optional default description
docbook
dateFrom attribute Date key Delivery month or week
period attribute String key Source Week
workCentre attribute String yes workcentre
weight attribute Float yes Allocation
unit attribute String yes Allocation
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Characteristics child key
documentation
top

Journey extJourney simple external
name type data type optional default description
docbook
code attribute String key Journey code
isDefault attribute ShortString yes does is journey is default?
deleteAllLegs attribute ShortString yes remove all legs
firstTransportMethod attribute String yes Transport method used by the leg from the order source to the first location in the chain
lastTransportMethod attribute String yes Transport method used by the leg from the last location in the chain to the order destination
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

JourneyRoute extJourneyRoute simple external
name type data type optional default description
docbook
orderNo attribute ShortString key Journey route number
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'R' - reference, 'I' - add
Journey parent key
TransportRoute child key
documentation
top

Location extLocation simple external
name type data type optional default description
docbook
name attribute String no Location name
code attribute ShortString key Location code
transportArea attribute ShortString yes Transport area location code
stockLocation attribute ShortString yes Stock area location code
warehouseGroupLocation attribute ShortString yes Warehouse group location code
site attribute ShortString yes Site code
company attribute ShortString yes Company code
rank attribute String yes Custome rank
calendar attribute String yes Calendar name
currency attribute String yes Currency
capacity attribute Float yes 0 Capacity of location
allocatedStock attribute Float yes 0 Allocated Stock
forecastRange attribute LongString yes null Forecast range name
safetyStockMethod attribute String yes null Safety stock method name
orderAutoConfirmPeriod attribute Integer yes 0 Replenishment orders auto-confirmation period
defaultCustomerForecast attribute ShortString yes System
status attribute ShortString yes Normal
Hierarchy child yes Hierarchy element
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

LocationAssignment extLocationAssignment simple external
name type data type optional default description
docbook
location attribute ShortString key Locaton code
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
User parent key User element
documentation
top

MarketData extMarketData simple external
name type data type optional default description
docbook
date attribute Date yes Month
value attribute Float yes Tonnes
market attribute String yes Market
productManager attribute String yes Product Manager
region attribute String yes Region
country attribute String yes Country
businessArea attribute String yes Business Area
segment1 attribute String yes Segment1
segment2 attribute String yes Segment2
segment3 attribute String yes Segment3
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

MasterRoute extMasterRoute simple external
name type data type optional default description
docbook
from attribute ShortString key Site code
cost attribute Float yes 0 Cost fin. unit/kg
minCapacity attribute Float yes 0 Cost fin. unit/kg
maxCapacity attribute Float yes 0 Cost fin. unit/kg
timePeriod attribute Integer yes 1 Duration in days
routeCategory attribute String yes 1 Route category
weighting attribute Integer yes 5 Weighting
isActive attribute ShortestString yes yes Is active route
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Characteristics child key
top

MultiStageAllocation extMultiStageAllocation simple external
name type data type optional default description
docbook
deliveryMonth attribute Date yes Delivery Month
deliveryWeek attribute Date yes Delivery Week
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Characteristics child key
documentation
top

NominalCost extNominalCost simple external
name type data type optional default description
docbook
dateFrom attribute Date key Effectie Date
cost attribute Float no Cost (financial unit per kg)
currency attribute ShortString yes Currency (Default currency in system)
updateForecast attribute ShortString yes update forecast costs it they are untouched
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
Characteristics child
top

OperationPredecessor extOperationPredecessor simple external
name type data type optional default description
docbook
orderCode attribute ShortString yes Order header code
orderLine attribute String yes Order line number
operationNumber attribute ShortString key Order operation number
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
OrderOperation parent key
documentation
top

OperationProperty extOperationProperty simple external
name type data type optional default description
docbook
type attribute String key
code attribute String no The value
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
OrderOperation parent key
documentation
top

OperationTypeConversion extOperationTypeConversion simple external
name type data type optional default description
docbook
operationType attribute String key
inputUnit attribute String yes The value
outputUnit attribute String yes The value
multiplier attribute Float yes The value
divider attribute Float yes The value
isLastCoProductStage attribute ShortString yes Is last stage for coproducts
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
ProductionConfiguration parent key
documentation
top

OrderClosure extOrderClosure simple external
name type data type optional default description
docbook
code attribute ShortString key Order header code
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

OrderGroup extOrderGroup simple external
name type data type optional default description
docbook
orderCode attribute ShortString key Order line code
orderLine attribute String key Order Line code
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
OrderLine parent key
documentation
top

OrderHeader extOrderHeader simple external
name type data type optional default description
docbook
code attribute ShortString key Order header code
originalCode attribute ShortString yes Original order header code
deleteAllLines attribute ShortString yes no Flag to indicate that an order has been replanned and all previous lines should be deleted
completeAllLines attribute ShortString yes no Flag to indicate if an order is complete. Can be used instead of setting individual lines to status completed
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

OrderInformation extOrderInformation simple external
name type data type optional default description
docbook
type attribute String key Type
deleteExistingValues attribute String yes Yes or no, if set to yes, then all existing values for this Information will be deleted
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
OrderLine parent key
documentation
top

OrderInformationItem extOrderInformationItem simple external
name type data type optional default description
docbook
valueType attribute String key Each order Information type can have 1 or ore values associated with it, this is a text reference to the type of data that this Information Item relates to
value attribute String no The value
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
OrderInformation parent key
documentation
top

OrderInventory extOrderInventory simple external
name type data type optional default description
docbook
orderCode attribute ShortString key Order Header Code
orderLine attribute ShortString key Order Line Number (or code)
inventoryLocation attribute ShortString key Location code of inventory
snapshotDate attribute Date key Date inventory reported in format YYYY-MM-DD
weight attribute Float no Weight of inventory in system base unit (usually KG)
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
top

OrderLine extOrderLine simple external
name type data type optional default description
docbook
code attribute ShortString yes Order line code
alternateCode1 attribute String yes Alternate code 1
alternateCode2 attribute String yes Alternate code 2
line attribute String yes Line code
transportMethod attribute String yes Transport method name
quantityWeightComplete attribute Float yes Weight made
quantityWeight attribute Float no Weight
quantityWeightIssued attribute Float yes Weight
quantity attribute Float yes Quantity in units
allocatedStock attribute Float yes Allocated Stock
unit attribute ShortString yes Unit name
block attribute ShortString yes Block code
run attribute LongString yes Run code
workCentre attribute String yes Workcentre code
transportLocationCode attribute ShortString yes Destination Location
finishingLock attribute ShortString yes FinishingLock
makeByDate attribute Date yes Date order to be made by
deliveryDate attribute Date yes Delivery date
requestedDate attribute Date yes Requested date
confirmedDate attribute Date yes Confirmed date
despatchDate attribute Date yes Despatch date
finishingDate attribute Date yes Date the order is finished on.
despatchWorkCentre attribute ShortString yes Despatch workcentre
status attribute String no Order line status
fixedInitialSource attribute String yes no Is initial source fixed
criticalCode attribute String yes Critical Code
criticalDate attribute Date yes Critical Date
type attribute String yes Order Type
rejectionReason attribute String yes Not used
bypass attribute String yes Not used
journey attribute String yes Journey Code
updateDatesOnCompletion attribute String yes no Update dates on Completion
fromConsignmentLocation attribute ShortString yes From Consignment Location code
toConsignmentLocation attribute ShortString yes To Consignment Location code
isCSComplete attribute String yes no Whether the order is CS complete.
reduceCSQuantity attribute Float yes Quantity was used to reduce CS orders and/or inventory.
alternateProductCode attribute String yes Alternate product code
endUse attribute String yes End use code
endUseDesc attribute String yes End use description
endCustomer attribute String yes End customer code
allowSubstitution attribute String yes no Flag indicate if an order can be substituted or not
needRebuild attribute String yes yes Flag indicate if require update RIP
periodType attribute String yes day week or day order
site attribute String yes Site code (plant) from which the order is sourced
price attribute Float yes Order price
currency attribute String yes Currenct name
salesOrderCode attribute String yes Sales order
salesOrderLineNo attribute String yes Sales order line position
alternativeKey attribute String yes Alternative Key
deleteObsoleteOperations attribute String yes no Delete Obsolete Operations
paymentHold attribute String yes false Payment Hold
priority attribute Integer yes 9 Priority
reATPRequired attribute Integer yes reATPRequired
schedule attribute String yes no Schedule
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Location child no Location element
Product child no Product element
SourceProduct child yes Source product element
documentation
top

OrderLineProperty extOrderLineProperty simple external
name type data type optional default description
docbook
type attribute String key
code attribute String no The value
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
OrderLine parent key
documentation
top

OrderLineSplit extOrderLineSplit simple external
name type data type optional default description
docbook
orderCode attribute String key Order code
lineCode attribute String key Line code
action attribute ShortestString yes A message action - can be 'A'
documentation
top

OrderLineSplitPart extOrderLineSplitPart simple external
name type data type optional default description
docbook
orderCode attribute String key Order code
lineCode attribute String key Line code
requestedDate attribute Date yes requested Date
confirmedDate attribute Date yes confirmed Date
dispatchDate attribute Date yes dispatch Date
deliveryDate attribute Date yes delivery Date
quantity attribute Date key Quantity
unit attribute String yes weight unit
OrderLineSplit parent key
documentation
top

OrderLineSupplyAndAllocate extOrderLineSupplyAndAllocate simple external
name type data type optional default description
docbook
orderCode attribute ShortString key Order line code
orderLine attribute String key Line code
allocatedQuantityWeight attribute Float key Weight
workCentre attribute ShortString key Workcentre code
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

OrderOperation extOrderOperation simple external
name type data type optional default description
docbook
operationNumber attribute ShortString key Order operation number
splitNumber attribute ShortString yes Order operation split number
blockCode attribute ShortString yes Block code
runCode attribute LongString yes Run code
workCentre attribute String yes Workcentre code
quantityComplete attribute Float yes Weight made
completionDueDate attribute Date yes Date order to be made by
startTime attribute DateTime yes Date and time job starts: YYYY-MM-DD HH:MI This is the start time of the set up job, not the process job
finishTime attribute DateTime yes Date and time the job finish-es: YYYY-MM-DD HH:MI Finish time of the process job
setupDuration attribute Float yes Set up time in minutes
processDuration attribute Float yes Time in minutes
unit attribute ShortString yes kg Quantity and production rate unit
quantity attribute Float yes Job quantity
rate attribute Float yes Production rate
rateTimeUnit attribute ShortString yes Day Time unit for rate
quantityCompleteTime attribute Date yes Date the quantity complete was last updated
actualStartTime attribute Date yes Actual start time of the job
productRouteStep attribute ShortString yes Product Route Stage Code
stepNumber attribute ShortString yes Product Route Stage Number
planningStatus attribute String yes Planning Status
operationType attribute String yes Operation type
status attribute String no Order line status
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
OrderLine parent key
Product child no Product element
documentation
top

Price extPrice simple external
name type data type optional default description
docbook
dateFrom attribute Date yes Effectie Date
price attribute Float no Price (financial unit per kg)
currency attribute ShortString yes Currency (Default currency in system)
weighting attribute Integer yes 1 Weighting
updateForecast attribute ShortString yes update forecast prices it they are untouched
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
Characteristics child
top

Product extProduct simple external
name type data type optional default description
docbook
type attribute String no Product type
name attribute LongString no Product name
code attribute String yes Product code
site attribute ShortString yes Site code
forecastStartDate attribute Date yes NULL Date to start forecasting
forecastFinishDate attribute Date yes NULL Date to finish forecasting
replenishmentStartDate attribute Date yes NULL Date to start replenishing
replenishmentFinishDate attribute Date yes NULL Date to finish replenishing
active attribute ShortString yes yes Status of the configuration, send yes for active and no for inactive
alternateCode attribute ShortString yes Alternate product code
alternateCodeLocation attribute ShortString yes Alternate product location code
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
SourceProduct child yes Source product element
Property child yes
documentation
top

ProductCharacteristic extProductCharacteristic simple external
name type data type optional default description
docbook
name attribute String key Characteristic name
level attribute Identity key Characteristic level
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

ProductGradeCost extProductGradeCost simple external
name type data type optional default description
docbook
productGrade attribute String key Market
setupCost attribute Float yes Product Manager
stockValue attribute Float yes Region
holdingCost attribute Float yes Country
documentation
top

ProductionConfiguration extProductionConfiguration simple external
name type data type optional default description
docbook
productRoute attribute String yes
site attribute String yes The value
product attribute String yes The product code
preferred attribute String yes The value
bomCode attribute String yes The product code
buildRoute attribute String yes no Is build product route
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Product parent yes
documentation
top

ProductionRate extProductionRate simple external
name type data type optional default description
docbook
rate attribute Float no Gross Production Rate kg/day, will be stored as tn/hour
weightUnit attribute ShortString yes kg Rate weight unit - does not used
timeUnit attribute ShortString yes Day Rate time unit - does not used
materialEfficiency attribute Float yes 100 Material Efficiency- does not used
timeEfficiency attribute Float yes 100 Time Efficiency - does not used
specificWeight attribute Float yes 0 Specific Weight
conversionFactor attribute Float yes 1 Conversion Factor
dateFrom attribute Date yes {SystemDate} Effective date for rate
operationType attribute String yes Operation type
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
WorkCentre child key Work Centre element
Characteristics child key Characteristics element
documentation
top

ProductionUpdate extProductionUpdate simple external
name type data type optional default description
docbook
orderCode attribute ShortString key Order line code
orderLine attribute String key Line code
operationNumber attribute String no Operation number
quantityType attribute String no OrderLineTotal Quantity type
status attribute String yes Production update status. Completed for completing order lines
productionDate attribute Date no production Date
quantity attribute Date no Quantity
unit attribute String yes weight unit
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

ProductUnit extProductUnit simple external
name type data type optional default description
docbook
unit attribute ShortString key Unit
factor attribute DoubleFloat no Factor
dividend attribute DoubleFloat no Dividend value
divisor attribute DoubleFloat no Divisor value
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Product parent key
documentation
top

Property extProperty hierarchical external
name type data type optional default description
docbook
type attribute String key Property type
value attribute LongString no Property value
code attribute ShortString key Property code
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

PropertyCharacteristic extPropertyCharacteristic simple external
name type data type optional default description
docbook
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Characteristics child
top

Reason extReason simple external
name type data type optional default description
docbook
name attribute String key
type attribute String key
desc attribute LongString yes
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

RemoveScenarioAllocations extRemoveScenarioAllocations simple external
name type data type optional default description
docbook
userLogin attribute ShortString no Scenario owner user login name
scenarioName attribute String no Scenario name
action attribute ShortestString yes D message action - can be 'D' - remove
top

RenameOrderLine extRenameOrderLine simple external
name type data type optional default description
docbook
oldOrderBookCode attribute ShortString no old order code
oldOrderLineCode attribute String yes old order line code
newOrderBookCode attribute ShortString yes new order code
newOrderLineCode attribute String yes new order line code
documentation
top

ReportFilter extReportFilter simple external
name type data type optional default description
docbook
code attribute String yes Report filter name
action attribute ShortestString yes A message Widget - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

ROParameter extROParameter simple external
name type data type optional default description
docbook
workCentre attribute String key Work centre code
orderLP attribute Float yes Order penalty for lateness
orderEP attribute Float yes Order penalty for earliness
orderFLP attribute Float yes Order fixed penalty for lateness
orderFEP attribute Float yes Order fixed penalty for earliness
allocationLP attribute Float yes Allocation penalty for lateness
allocationEP attribute Float yes Allocation penalty for earliness
allocationFLP attribute Float yes Allocation fixed penalty for lateness
allocationFEP attribute Float yes Allocation fixed penalty for earliness
propOrderLP attribute String yes no Proportional order penalty for lateness
propOrderEP attribute String yes no Proportional order penalty for earliness
propOrderFLP attribute String yes no Proportional order fixed penalty for lateness
propOrderFEP attribute String yes no Proportional order fixed penalty for earliness
propAllocationLP attribute String yes no Proportional allocation penalty for lateness
propAllocationEP attribute String yes no Proportional allocation penalty for earliness
propAllocationFLP attribute String yes no Proportional allocation fixed penalty for lateness
propAllocationFEP attribute String yes no Proportional allocation fixed penalty for earliness
changeOverDuration attribute Integer no Generic changeover duration (hours)
changeOverCost attribute Float no Generic changeover cost
oppBlockDuration attribute Integer no Opp. block duration per week in hours
allowIdleTime attribute Integer no Allow idle time
allowIdleTimeFS attribute Integer no Allow idle time near floating shuts only
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

Run extRun simple external
name type data type optional default description
docbook
blockCode attribute ShortString yes Block code run belongs to
code attribute LongString key Run code
periodStart attribute DateTime no Run start date
periodEnd attribute DateTime no Run end date
targetPeriodStart attribute DateTime yes Run target start date
updateTargetDate attribute ShortString yes yes update target end date
capacity attribute Float no Run capacity
unit attribute ShortString yes Weight unit name
timeUnit attribute ShortString yes Time unit name
status attribute ShortString yes Run status
runType attribute ShortString yes production run type
switchoverDuration attribute Float yes 0 Changeover duration in minutes
wasteTime attribute Float yes 0 waste time
processRate attribute Float yes 1 Production rate
deleteRunProperties attribute String yes no Remove all run products or not
previousBlockCode attribute ShortString yes Previous block code run belongs to
fixed attribute ShortString yes no Is it fixed run
quantityComplete attribute Float no QuantityComplete
productionUpdateTimestamp attribute DateTime no Date of production update (timestamp)
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

RunAction extRunAction simple external
name type data type optional default description
docbook
actionName attribute String no Action for executing
top

RunAttribute extRunAttribute simple external
name type data type optional default description
docbook
name attribute String key Property type
value attribute ShortString key Property value
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Run parent key
documentation
top

RunForecast executable external
name type data type optional default description
docbook
generationStartMonth attribute Date yes {SYSDATE} Start month for system forecast
allowOverride attribute Boolean yes false Allow overried future forecast
stop attribute Boolean yes false Stop listener before generation
generationLastMonth attribute Date yes 1 Months quantity
Characteristics child
top

RunProduct extRunProduct simple external
name type data type optional default description
docbook
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Run parent key
documentation
top

RunProductProperty extRunProductProperty simple external
name type data type optional default description
docbook
property attribute String key Property type
code attribute ShortString key Property code
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
RunProduct parent key
documentation
top

RunPropertyCharacteristic extRunPropertyCharacteristic simple external
name type data type optional default description
docbook
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Run parent key
Characteristics child
top

RunReplenishment executable external
name type data type optional default description
docbook
stop attribute Boolean yes false Stop listener before generation
onlySendOrders attribute Boolean yes false Only send tentative orders
phase attribute Enum yes All Which phases should be passed
top

ScenarioAllocation extScenarioAllocation simple external
name type data type optional default description
docbook
userLogin attribute ShortString no Scenario owner user login name
scenarioName attribute String no Scenario name
workCentre attribute ShortString no Workcentre code
stageNo attribute Integer no Production stage number
sourcePeriod attribute ShortString no Source period date
deliveryPeriod attribute ShortString no Delivery period date
weight attribute Float no Allocation
allocationId attribute ShortString yes Allocation id
unit attribute ShortString yes Unit name
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Characteristics child
top

Schedule extSchedule simple external
name type data type optional default description
docbook
name attribute String key Schedule name
basedOn attribute String yes Name of schedule to base upon
isReceivingDays attribute ShortestString yes no 'yes' means the schedule active days are days for receipt at receiving location, 'no' mean s schedule active days default to despatch days from source
defaultAvailable attribute ShortestString yes yes If yes, rules define days not available, if no defines days available
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

ScheduleRule extScheduleRule simple external
name type data type optional default description
docbook
day attribute Integer no 0 Day of month
month attribute Integer no 0 Month
year attribute Integer no 0 Year
dayOfWeek attribute Integer no 0 Day of week
numOfWeek attribute Integer no 0 Week of month
description attribute LongString no Description for rule
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Schedule parent key
documentation
top

Site extSite simple external
name type data type optional default description
docbook
name attribute String no Site name
code attribute ShortString key Site code
taxRate attribute Float yes 0 Tax rate
ownership attribute Float yes 100 Ownership
safetyStockMethod attribute String yes null Safety stock method name
groupReplenishedLocations attribute ShortString yes no Group replenished locations
latitude attribute ShortString yes Latitude
longitude attribute ShortString yes Longitude
standardTransportCost attribute Float yes Standard transport cost
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

SiteDefinedProperty extSiteDefinedProperty simple external
name type data type optional default description
docbook
name attribute String key Property level name
level attribute Identity key Property level Identity
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

SiteProperty extSiteProperty simple external
name type data type optional default description
docbook
name attribute String key End use property name
value attribute String no End use property value
action attribute ShortestString yes A message Widget - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Site parent key
documentation
top

Sku extSKU simple external
name type data type optional default description
docbook
forecasted attribute ShortString yes no Forecast status yes/no
replenished attribute ShortString yes no Replenishment status yes/no/delisted
daysOfSupply attribute Integer yes 1 Days of supply
maxDaysOfSupply attribute Integer yes 1 Days of supply
highQuantity attribute Float yes 0 Safety stock high quantity
lowQuantity attribute Float yes 0 Safety stock low quantity
maxCapacity attribute Float yes 0 Stock level limit
minOrderQuantity attribute Float yes 1 Minimum quantity to order
orderUnit attribute ShortString yes NULL Name of the unit to be used in the orders
upperPercentile attribute DoubleFloat yes 95 Forecast parameter
lowerPercentile attribute DoubleFloat yes 5 Forecast parameter
replenishmentFrequency attribute Identity yes 12 Replenishment parameter
maxReplenishmentFrequency attribute Identity yes 12 Replenishment parameter
historyStartDate attribute Date yes NULL Override for history used in forecasting
forecastStartDate attribute Date yes NULL Date to start forecasting
forecastFinishDate attribute Date yes NULL Date to finish forecasting
replenishmentStartDate attribute Date yes NULL Date to start replenishing
replenishmentFinishDate attribute Date yes NULL Date to finish replenishing
rank attribute String yes Customer rank override
forecastMethod attribute LongString yes null Forecast method name
safetyStockMethod attribute String yes null Safety stock method name
maxSafetyStockMethod attribute String yes null Safety stock method name
inhibitProduction attribute ShortString yes no inhibit production
inhibitSFGSearch attribute ShortString yes no inhibit SFG Search
DDQContingency attribute Integer yes 0 Stock which should not be used by DDQ, in kg.
defaultCustomerForecast attribute ShortString yes System
nettingAlgorithm attribute ShortString yes Netted
consumptionType attribute ShortString yes Forecast
upperPercentileMethod attribute ShortString yes UserDefined
upperPercentileMonth attribute ShortString yes 12 Upper percentile history months
forecastPattern attribute ShortString yes Forecast pattern
forecastPatternDate attribute ShortString yes Forecast pattern month
forecastPatternPosition attribute ShortString yes 1 Forecast pattern position no
SNPExclusionPeriod attribute ShortString yes 0 SNP Forecast Exclusion Period
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Location child key
Product child key
EndUse child yes
EndCustomer child yes
documentation
top

SkuDefinedProperty extSkuDefinedProperty simple external
name type data type optional default description
docbook
name attribute String key Property level name
level attribute Identity key Property level Identity
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

SkuProperty extSkuProperty simple external
name type data type optional default description
docbook
name attribute String key End use property name
value attribute String no End use property value
action attribute ShortestString yes A message Widget - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Sku parent key
Characteristics parent yes
documentation
top

SkuUpdate extSkuUpdate simple external
name type data type optional default description
docbook
forecasted attribute ShortString yes no Forecast status yes/no
replenished attribute ShortString yes no Replenishment status yes/no/delisted
daysOfSupply attribute Integer yes 1 Days of supply
highQuantity attribute Float yes 0 Safety stock high quantity
lowQuantity attribute Float yes 0 Safety stock low quantity
maxCapacity attribute Float yes 0 Stock level limit
minOrderQuantity attribute Float yes 1 Minimum quantity to order
orderUnit attribute ShortString yes NULL Name of the unit to be used in the orders
upperPercentile attribute DoubleFloat yes 95 Forecast parameter
lowerPercentile attribute DoubleFloat yes 5 Forecast parameter
replenishmentFrequency attribute Identity yes 12 Replenishment parameter
historyStartDate attribute Date yes NULL Override for history used in forecasting
forecastStartDate attribute Date yes NULL Date to start forecasting
forecastFinishDate attribute Date yes NULL Date to finish forecasting
replenishmentStartDate attribute Date yes NULL Date to start replenishing
replenishmentFinishDate attribute Date yes NULL Date to finish replenishing
rank attribute String yes Customer rank override
forecastMethod attribute LongString yes null Forecast method name
safetyStockMethod attribute String yes null Safety stock method name
inhibitProduction attribute ShortString yes no inhibit production
inhibitSFGSearch attribute ShortString yes no inhibit SFG Search
DDQContingency attribute Integer yes 0 Stock which should not be used by DDQ, in kg.
defaultCustomerForecast attribute ShortString yes System
nettingAlgorithm attribute ShortString yes Netted
consumptionType attribute ShortString yes Forecast
replenishmentHorizon attribute ShortString yes null
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Characteristics child key
documentation
top

SourcePriority extSourcePriority simple external
name type data type optional default description
docbook
workCentre attribute String key Source work centre code
priority attribute Integer key Priority
percentage attribute Integer key Percentage
rebuild attribute String yes yes Rebuild
weighting attribute Integer yes 1 Weighting
productType attribute String yes Journey code
isConsignmentStock attribute String yes Journey code
journey attribute String yes Journey code
dateFrom attribute Date yes Effective start date
dateTo attribute Date yes Effective finish date
groupName attribute String yes Group Name
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Characteristics child key
top

SourceProduct extSourceProduct simple external
name type data type optional default description
docbook
type attribute String no Product type
name attribute LongString no Product name
code attribute String key Product code
site attribute ShortString yes Site code
forecastStartDate attribute Date yes NULL Date to start forecasting
forecastFinishDate attribute Date yes NULL Date to finish forecasting
replenishmentStartDate attribute Date yes NULL Date to start replenishing
replenishmentFinishDate attribute Date yes NULL Date to finish replenishing
productRoute attribute ShortString yes NULL Product Route
active attribute ShortString yes yes Status of the configuration, send yes for active and no for inactive
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Property child yes
documentation
top

SourcingPlan extSourcingPlan simple external
name type data type optional default description
docbook
workCentre attribute String yes Work centre code
priority attribute Integer yes 1 Priority
percentage attribute Integer yes 100 Percentage
journey attribute String yes Journey code
consignmentLocation attribute String yes Consignment Location Code
isConsignmentStock attribute ShortString yes no Indicate that sourcing will be from consignment stock (used in replenishment)
productType attribute String yes Define from which material type we will source
dateFrom attribute Date yes Effective start date
dateTo attribute Date yes Effective finish date
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Sku parent key
documentation
top

Supercession extSupercession simple external
name type data type optional default description
docbook
testCode attribute String yes no Test code for reference
type attribute String yes no Supercession Type
startDate attribute Date yes {SystemDate} Effective Date
fromLocation attribute String yes Location code superceeded
toLocation attribute String yes Location code superceeding
fromProduct attribute String yes Product code superceeded
toProduct attribute String yes Product code superceeding
fromEndUse attribute String yes EndUse code superceeded
toEndUse attribute String yes EndUse code superceeding
fromEndCustomer attribute String yes EndCustomer code superceeded
toEndCustomer attribute String yes EndCustomer code superceeding
percentage attribute ShortestString yes 100 Percentage
immediate attribute ShortestString yes no If the value of the immediate attribute is set to 'yes' then supercession logic will be applied immediate
disableSupersededItems attribute ShortestString yes no If the value of the immediate attribute is set to 'yes' then supercession logic will be applied immediate
createSKU attribute ShortString yes no If the value is set to yes, then the supercession rule will behave as it does today (ie new SKUs may be created) If the value is set to no, then the new logic regarding non creation of SKUs is used
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Location child no Location element
documentation
top

SupercessionHierarchy extSupercessionHierarchy simple external
name type data type optional default description
docbook
hierarchy attribute String key Property type
code attribute ShortString key Property code superceeded
Supercession parent key
documentation
top

SupercessionProperty extSupercessionProperty simple external
name type data type optional default description
docbook
property attribute String key Property type
from attribute ShortString key Property code superceeded
to attribute ShortString key Property code superceeding
Supercession parent key
documentation
top

Supplier extSupplier simple external
name type data type optional default description
docbook
name attribute String no Supplier name
code attribute ShortString key Supplier code
type attribute ShortString yes internal Supplier code
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

SupplierInventory extSupplierInventory simple external
name type data type optional default description
docbook
supplier attribute ShortString key Supplier code
warehouse attribute ShortString key Warehouse location code
product attribute ShortString key Product code
snapshotDate attribute Date yes Date of inventory snapshot
quantity attribute Float yes Weight
unit attribute ShortString yes Unit name
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

TransportMethod extTransportMethod simple external
name type data type optional default description
docbook
name attribute String no Method name
code attribute String key Method code
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

TransportRoute extTransportRoute simple external
name type data type optional default description
docbook
method attribute String key Method name
cost attribute Float yes 0 Cost fin. unit/kg
timePeriod attribute Integer yes 1 Duration in days
priority attribute Integer yes 1 Priority for route
from attribute ShortString key Location code if sending to Location, Site code if sending to Hierarchy
to attribute ShortString yes Location code - destination
schedule attribute String no Schedule for this route
calendar attribute String yes Calendar for this route
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
top

User extUser simple external
name type data type optional default description
docbook
name attribute String no User name
code attribute ShortString key User code
login attribute ShortString no User Login
domainName attribute ShortString yes Domain User Login
email attribute LongString yes Email
company attribute ShortString yes Company code
userGroup attribute ShortString yes User group name
encryptedPassword attribute String yes encrypted password
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

UserGroup extUserGroup simple external
name type data type optional default description
docbook
name attribute String key user group name
type attribute String yes clean filters?
clean attribute String yes clean filters?
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
top

UserGroupFilter extUserGroupFilter simple external
name type data type optional default description
docbook
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
ReportFilter child yes
UserGroup parent
top

UserRole extUserRole simple external
name type data type optional default description
docbook
role attribute String key Role name
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
User parent key User
documentation
top

ValidSource extValidSource simple external
name type data type optional default description
docbook
operationType attribute String yes
workCentre attribute String key The value
preferred attribute String yes The value
sourceRank attribute String yes The primary or secondary source
singlePrimary attribute String yes The primary or secondary source
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
ProductionConfiguration parent yes
ConfigurationOperationType parent yes
documentation
top

WeeklyForecast extWeeklyForecast simple external
name type data type optional default description
docbook
dateFrom attribute Date key
weight attribute DoubleFloat key
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
Location child key
Product child key
documentation
top

WorkCentre extWorkCentre simple external
name type data type optional default description
docbook
code attribute String key Workcentre code
name attribute String no Workcentre name
type attribute String no Workcentre type name
autoConfirmationPeriod attribute Integer yes Replenishment orders auto-confirmation period
DDQLocked attribute String yes no Lock or unlock workcentre for DDQ process
CampaignReleaseDate attribute DateTime yes no CampaignReleaseDate
defaultRate attribute Float yes Gross Production Rate kg/hour
numberOfWorkCentres attribute Float yes 1 Gross Production Rate kg/hour
idleCost attribute Float yes 0 Idle time cost, base currency unit/hour
Location parent no Location element
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

WorkCentreAssignment extWorkcentreAssignment simple external
name type data type optional default description
docbook
workCentre attribute String key Workcentre code
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
User parent key User Element
documentation
top

WorkCentreAttribute extWorkCentreAttribute simple external
name type data type optional default description
docbook
property attribute String key Property name
code attribute ShortString no Property code
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
WorkCentre parent key Workcentre element
documentation
top

WorkCentreCapacity extWorkCentreCapacity simple external
name type data type optional default description
docbook
effectiveDate attribute Date key Effective date
capacity attribute Float no Rough Capacity
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
WorkCentre parent key Workcentre element
documentation
top

WorkCentreParameter extWorkCentreParameter simple external
name type data type optional default description
docbook
name attribute String key Work centre Parameter name
value attribute String key Value of parameter
productType attribute String yes Product type
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
WorkCentre parent key Workcentre element
documentation
top

WorkCentreParameterType extWorkCentreParameterType simple external
name type data type optional default description
docbook
name attribute String key Work centre parameter name
description attribute String yes Work centre parameter description
help attribute String yes Work centre parameter help
dataType attribute String no 0 Data type
unitDescription attribute String yes none Unit parameter description
minValue attribute Float yes 0 Min value
maxValue attribute Float yes 0 Max value
defaultValue attribute String no Default value
bundle attribute String yes Default value
canBeUndefined attribute String yes no Indicate that parameter can be undefined
parameterGroup attribute String yes Common which will be indicate parameter group - possible values: Common, Supply Network Planning, BSO
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
WorkCentreType parent
documentation
top

WorkCentreShut extWorkCentreShut simple external
name type data type optional default description
docbook
workCentre attribute ShortString key Workcentre code
code attribute String yes Workcentre shut code
periodStart attribute DateTime yes Shut start date
periodEnd attribute DateTime yes Shut end date
description attribute LongString yes Shut description
useShutInMPOnly attribute LongString yes no Use shut in MP only
type attribute LongString yes WorkCentreShutType
autoGenerateCode attribute LongString yes no AutoGenerateCode
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

WorkCentreShutType extWorkCentreShutType simple external
name type data type optional default description
docbook
name attribute String key Workcentre shut type name
description attribute LongString yes Shut type description
isDefault attribute ShortString yes does is shut type is default?
language attribute String yes
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

WorkCentreTimeEfficiency extWorkCentreTimeEfficiency simple external
name type data type optional default description
docbook
effectiveDate attribute Date key Effective date
timeEfficiency attribute Float no Rough TimeEfficiency
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
WorkCentre parent key Workcentre element
documentation
top

WorkCentreType extWorkcentreType simple external
name type data type optional default description
docbook
name attribute String key Work centre type name
description attribute String yes Work centre type description
isValidSource attribute String yes no Is it valid initial source
language attribute String yes
hasInventory attribute String yes no Is it valid initial source
isProductionSource attribute String yes no Is it valid initial source
isExternalSource attribute String yes no Is it valid external source
stageDelayHours attribute Integer yes 0 Fixed (min) delay after this stage in SNP, in hours
maxStageDelayHours attribute Integer yes 0 Max delay after this stage in SNP, in hours
orderNo attribute String yes no Is it valid initial source
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

Test extTestMessage simple test
name type data type optional default description
docbook
code attribute Date yes Source Month
delay attribute Integer yes Source Week
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
top

TestOrderLine extTestOrderLine simple test
name type data type optional default description
docbook
code attribute ShortString key Order line code
line attribute String yes Line code
quantityWeight attribute Float key Weight
location attribute ShortString key Block code
product attribute LongString key Run code
block attribute ShortString yes Block code
run attribute LongString yes Run code
workCentre attribute String key Workcentre code
deliveryDate attribute Date yes Delivery date
despatchDate attribute Date yes Despatch date
status attribute String yes Order line status
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top

TestSku extTestSKU simple test
name type data type optional default description
docbook
forecasted attribute ShortString yes no Forecast status yes/no
replenished attribute ShortString yes no Replenishment status yes/no
location attribute ShortString yes
product attribute ShortString yes
endUse attribute ShortString yes
customer attribute ShortString yes
history attribute ShortString yes
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
top

TestUsageHistory extTestUsageHistory simple test
name type data type optional default description
docbook
weight attribute Float yes Weight quantity
location attribute String key
product attribute String key
endUse attribute String yes
endCustomer attribute String yes
isDaily attribute Integer yes Is daily history
monthsQuantity attribute Integer yes Months quantity
startMonth attribute Integer yes Start Month
IsDaily attribute ShortString yes Months quantity
site attribute String yes
workCentre attribute String yes
serie attribute String yes
action attribute ShortestString yes A message action - can be 'A' - add or update, 'U' - update, 'D' - remove, 'R' - reference, 'I' - add
documentation
top