Serialized Form

Package de.aeb.xnsg.lis.bf

Class de.aeb.xnsg.lis.bf.LISAmountOfMoneyDTO

class LISAmountOfMoneyDTO extends Object implements Serializable

serialVersionUID:

-7803197628717807229L

Serialized Fields

currencyISOCode

String currencyISOCode

The three letter ISO code of the currency.

length=3

exchangeRateDate

String exchangeRateDate

The decisive date for doing currency exchange calculations. The format of the date has to be "yyyy-MM-dd"

length=10

statCurrencyISOCode

String statCurrencyISOCode

The three letter ISO code of the statistical currency

length=3

statValue

BigDecimal statValue

The value of the statistical amount of money in the units of the statistical currency.

length=15, scale=2

value

BigDecimal value

The value of the amount of money in units of the currency.

length=15, scale=2

Class de.aeb.xnsg.lis.bf.LISMaterialDTO

class LISMaterialDTO extends Object implements Serializable

serialVersionUID:

-2521677669007837588L

Serialized Fields

catalogueNumber

String catalogueNumber

The catalogue number of the material.

length=40

colour

String colour

The colour of the material.

length=50

commodityCode

String commodityCode

The commodity code of the material.

length=40

countryISOCode

String countryISOCode

The country of origin ISO-Code of the material.

length=2

description

String description

Name/Description of the material FTX-Segment

length=250

discount

LISAmountOfMoneyDTO discount

The discount of the material.

identCode

String identCode

Identcode of the material. PIA-Segment, Element 3055

length=40

identCodeBuyer

String identCodeBuyer

Identcode of the buyer of the material. PIA-.Segment, Element 3055

length=40

identCodeGTIN

String identCodeGTIN

EAN Code of the material. LIN-Segment, Element 7140

length=40

identCodeSupplier

String identCodeSupplier

Identcode of the supplier of the material. PIA-Segment, Element 3055

length=40

productGroup1Buyer

String productGroup1Buyer

length=40

productGroup1Supplier

String productGroup1Supplier

length=40

productGroup2Buyer

String productGroup2Buyer

length=40

productGroup2Supplier

String productGroup2Supplier

length=40

productGroup3Buyer

String productGroup3Buyer

length=40

productGroup3Supplier

String productGroup3Supplier

length=40

season

String season

The season of the material.

length=50

shortDescription

String shortDescription

Short description of the material FTX-Segment

length=50

size

String size

The size of the material.

length=50

Class de.aeb.xnsg.lis.bf.LISQuantityDTO

class LISQuantityDTO extends Object implements Serializable

serialVersionUID:

6429683617622240351L

Serialized Fields

quantityUnit

String quantityUnit

The quantity unit of the value.

length=10

statQuantityUnit

String statQuantityUnit

The statistical quantity unit of the statValue.

length=10

statValue

BigDecimal statValue

The amount, denoted in units of the field statQuantityUnit. This is for statistics and therefore for the same materials the statQuantityUnit should always be the same

length=20, scale=6

value

BigDecimal value

The amount, denoted in units of the field quantityUnit.

length=20, scale=6

Class de.aeb.xnsg.lis.bf.LISWarehouseDTO

class LISWarehouseDTO extends LISLocationDTO implements Serializable

serialVersionUID:

8060457910696517858L

Serialized Fields

identCode

String identCode

Reference number of the party from the viewpoint of the stock Owner.

length=40

name

String name

Address name line 1 NAD-Segment, Element 3124

length=40

Package de.aeb.xnsg.vcp.bf.lis

Class de.aeb.xnsg.vcp.bf.lis.LISArchiveDocumentDTO

class LISArchiveDocumentDTO extends Object implements Serializable

serialVersionUID:

6515016832113961854L

Serialized Fields

additionalFields

LISAdditionalFieldDTO[] additionalFields

Additional fields of the document

byteSize

Integer byteSize

the byte size of the archived document

documentCategories

LISMODocumentCategoryDTO[] documentCategories

documentName

String documentName

the name of the document e.g. a file name with extension

length=500

documentStorageID

String documentStorageID

the unique storage id of the document in the archive system

length=50

languageIsoCodes

String[] languageIsoCodes

the languages for the binary to be displayed in the application

mimetype

String mimetype

the mimetype of the archived document e.g. application/pdf or image/jpeg

roles

LISBinaryRoleDTO[] roles

the roles for the binary to be displayed in the application

Class de.aeb.xnsg.vcp.bf.lis.LISBinaryDTO

class LISBinaryDTO extends Object implements Serializable

Serialized Fields

additionalFields

LISAdditionalFieldDTO[] additionalFields

Additional fields of the document

content

byte[] content

binary content e.g. a pdf document or an image.

documentCategories

LISMODocumentCategoryDTO[] documentCategories

the documentCategories for the binary to be displayed in the application

languageIsoCodes

String[] languageIsoCodes

the languages for the binary to be displayed in the application

mimetype

String mimetype

the mimetype of the binary e.g. application/pdf or image/jpeg

Note: This field fills the "description" of the document object

length=250

name

String name

the name of the binary e.g. a file name with extension

length=500

roles

LISBinaryRoleDTO[] roles

the roles for the binary to be displayed in the application

Class de.aeb.xnsg.vcp.bf.lis.LISBinaryRoleDTO

class LISBinaryRoleDTO extends Object implements Serializable

serialVersionUID:

791876839381621499L

Serialized Fields

identCode

String identCode

The ident code of the role for the binary. Please see product documentation or an admin for possible roles

length=100

Class de.aeb.xnsg.vcp.bf.lis.LISCESDocumentDTO

class LISCESDocumentDTO extends Object implements Serializable

Serialized Fields

additionalFields

LISAdditionalFieldDTO[] additionalFields

Additional fields of the document

byteSize

Integer byteSize

the byte size of the stored document

length=10

contentInfo

String contentInfo

CESProvidedTrackingData.contentInfo, e.g. "PushApi", or the converter identifier

contentSource

String contentSource

Information about the technical source of the data content.

contentType

String contentType

The content type of the stored document e.g. EDIFACT or CSV.

Note: The content of this field will be stored in the description of the document

length=30

documentCategories

LISMODocumentCategoryDTO[] documentCategories

documentKey

String documentKey

The key of the document. This is calculated from the configurationIdentCode and the digest in CES.

length=500

languageIsoCodes

String[] languageIsoCodes

the languages for the binary to be displayed in the application

name

String name

The name of the document. This might be a file name with extension, but can be some abstract number, too. In the CES it corresponds to the messagePoolId.

length=200

receivedAt

de.aeb.xnsg.foundation.bf.DateAndZoneDTO receivedAt

When the data appeared in the CES.

roles

LISBinaryRoleDTO[] roles

the roles for the binary to be displayed in the application

Class de.aeb.xnsg.vcp.bf.lis.LISDateAndZoneDTO

class LISDateAndZoneDTO extends Object implements Serializable

serialVersionUID:

1508697841507075216L

Serialized Fields

dateInTimezone

String dateInTimezone

The string representation of the Date/Timestamp for the timezone in the format yyyy-MM-dd HH:mm:ss DTM-Segment, Element 2380

length=19

timezone

String timezone

The timezone to interpret the field dateInTimezone. Valid timezone's are e.g. "GMT+1:00" or "GMT-2:00". DTM-Segment, Element 2380

If empty, UTC will be assumed

length=50

Class de.aeb.xnsg.vcp.bf.lis.LISDimensionsDTO

class LISDimensionsDTO extends Object implements Serializable

serialVersionUID:

1965463588321278172L

Serialized Fields

height

BigDecimal height

Height.

length=20, scale=6

length

BigDecimal length

Length.

length=20, scale=6

quantityUnit

String quantityUnit

Quantity unit.

length=10

width

BigDecimal width

Width.

length=20, scale=6

Class de.aeb.xnsg.vcp.bf.lis.LISExpMODocumentCategoryIdentifierDTO

class LISExpMODocumentCategoryIdentifierDTO extends Object implements Serializable

Serialized Fields

identCode

String identCode

The ident code of the document category.

length=15

Class de.aeb.xnsg.vcp.bf.lis.LISFileSystemDocumentDTO

class LISFileSystemDocumentDTO extends Object implements Serializable

Serialized Fields

additionalFields

LISAdditionalFieldDTO[] additionalFields

Additional fields of the document

byteSize

Integer byteSize

the byte size of the stored document

length=10

documentCategories

LISMODocumentCategoryDTO[] documentCategories

documentKey

String documentKey

The key of the document. This corresponds to the sub-folder where the document is stored.

length=500

languageIsoCodes

String[] languageIsoCodes

the languages for the binary to be displayed in the application

mimetype

String mimetype

the mimetype of the stored document e.g. application/pdf or image/jpeg

Note: The content of this field will be stored in the description of the document

length=250

name

String name

the name of the document e.g. a file name with extension

length=500

roles

LISBinaryRoleDTO[] roles

the roles for the binary to be displayed in the application

settingsReference

LISFileSystemSettingsReferenceDTO settingsReference

The reference to the file system settings in the VCP

Class de.aeb.xnsg.vcp.bf.lis.LISFileSystemSettingsReferenceDTO

class LISFileSystemSettingsReferenceDTO extends Object implements Serializable

Serialized Fields

referenceKey

String referenceKey

A reference key which will be utilized by the different types

type

String type

A constant how the file system settings should be found. Its possible values are found in the FILE_SYSTEM_REFERENCE_TYPE constants. Possible values:

• ACTIVE
• ID
• PATH

Class de.aeb.xnsg.vcp.bf.lis.LISLocationDTO

class LISLocationDTO extends Object implements Serializable

serialVersionUID:

-481214617849421608L

Serialized Fields

city

String city

City of the address. SG11/NAD segment (25)

length=40

countryISOCode

String countryISOCode

Country of address SG11/NAD segment (25)

length=2

globLocationNo

String globLocationNo

Global location number of the address. SG11/NAD segment (25)

length=20

postcodeStreet

String postcodeStreet

Postcode of the street address. SG11/NAD segment (25)

length=10

stateRegion

String stateRegion

State or region of the address. SG11/NAD segment (25)

length=40

timezone

String timezone

Valid Java Timezone string. ??? Edifact source ???

length=50

Class de.aeb.xnsg.vcp.bf.lis.LISMessageMetaDataDTO

class LISMessageMetaDataDTO extends Object implements Serializable

serialVersionUID:

-1229323872961133307L

Serialized Fields

idRefScheme

String idRefScheme

The scheme of the ID and reference number calculation. This may be one of the constants "BUYER", "SUPPLIER" or "IDREFFIELDS" (described in the constants ID_REF_SCHEME_XXX). This will affect how the id and reference fields (e.g. consignmentID, orderItemID) will be calculated from the DTOs. Depending on the selected calculation scheme different fields in the DTOs will be used to calculate the unique reference numbers of the objects. These fields will become mandatory when needed in the scheme. This field can be left empty (null) to ensure legacy mode. The calculation scheme "SUPPLIER" will be used in that occation.

length=20

messageReferenceNumber

String messageReferenceNumber

Unique number of the message given by the sender. From UNH-Segment, Element 0062

length=50

messageType

String messageType

The name of the message type received by the communication engine which was converted into this Intellichains message. E.G. "ORDERS", "IFTSTA", ...

length=100

receiverClient

String receiverClient

The identCode of the client which will get the message. From UNB-Segment, Elements 0022/0025

length=10

receiverRole

String receiverRole

The role of the receiver of the message in the supply chain. This may be one of the constants "BUYER", "SUPPLIER" or "FORWARDER" (may be more in the future). This will affect how the reference numbers (e.g. orderNumber, materialNumber) will be treated when inserting into the database. Normally for a particular type of an EANCOM message the role of the sender and the receiver of the message is fixed. But because EANCOM messages are just used as interface defintions into Intellichains the sender and the receiver of the message may play any role and not only those ones implicated by EANCOM. ? Maybe this field is not extractable from EANCOM messages but must be ? looked up in some customization settings ?

length=20

sendDate

LISDateAndZoneDTO sendDate

The Timestamp the message was send. From UNB-Segment, Elements 0017/0019

senderID

String senderID

The identification of the message sender. This should be a string that uniquely identifies the system from which the message was sent and is the same for all messages sent from the system. From UNB-Segment, Elements 0022/0025.

length=20

senderRole

String senderRole

The role of the sender of the message in the supply chain. This may be one of the constants "BUYER", "SUPPLIER" or "FORWARDER" (may be more in the future). This will affect how fields of existing objects in the Intellichains database will be updated by allowing overwrite or not. Normally for a particular type of an EANCOM message the role of the sender and the receiver of the message is fixed. But because EANCOM messages are just used as interface defintions into Intellichains the sender and the receiver of the message may play any role and not only those ones implicated by EANCOM. ? Maybe this field is not extractable from EANCOM messages but must be ? looked up in some customization settings ?

length=20

updateMode

String updateMode

There are several possibilities how the content of the message should be insertet into the LIS. Update the old contents, delete some contents and so forth.T

length=20

Class de.aeb.xnsg.vcp.bf.lis.LISMODocumentCategoryDTO

class LISMODocumentCategoryDTO extends Object implements Serializable

Serialized Fields

identCode

String identCode

The ident code of the document category for the binary. Please see product documentation or an admin for possible document categories

length=15

Class de.aeb.xnsg.vcp.bf.lis.LISPartyDTO

class LISPartyDTO extends LISPartyShortDTO implements Serializable

serialVersionUID:

6325093578602837186L

Serialized Fields

city

String city

City of the address. NAD-Segment, Element 3164

length=40

countryISOCode

String countryISOCode

Country of address NAD-Segment, Element 3207

length=2

emailAddress

String emailAddress

Email address of the address. ??? Edifact source ???

length=1000

name2

String name2

Address name line 2 NAD-Segment, Element 3124

length=40

name3

String name3

Address name line 1 NAD-Segment, Element 3124

length=40

poBox

String poBox

PO-Box. NAD-Segment, Element 3042

length=10

postcodePoBox

String postcodePoBox

Postcode of the poBox address. NAD-Segment, Element 3251 ???

length=10

postcodeStreet

String postcodeStreet

Postcode of the street address. NAD-Segment, Element 3251

length=10

stateRegion

String stateRegion

State or region of the address. NAD-Segment, Element 3229/3228

length=40

street

String street

Street of the address. NAD-Segment, Element 3042

length=40

street2

String street2

Street of the address. Line 2. NAD-Segment, Element 3042

length=40

timezone

String timezone

Valid Java Timezone string. ??? Edifact source ???

length=50

Class de.aeb.xnsg.vcp.bf.lis.LISPartyLongDTO

class LISPartyLongDTO extends LISPartyDTO implements Serializable

Serialized Fields

contact

ContactDTO contact

Class de.aeb.xnsg.vcp.bf.lis.LISPartyShortDTO

class LISPartyShortDTO extends Object implements Serializable

serialVersionUID:

-6285841857995989883L

Serialized Fields

globalLocationNumber

String globalLocationNumber

Global Reference number of the party. This is a global number of Intellichains, preferably the ILN/GLN number, if available. NAD-Segment, Element 3039

length=20

name

String name

Address name line 1 NAD-Segment, Element 3124

length=40

partyNumberBuyer

String partyNumberBuyer

Reference number of the party from the viewpoint of the buyers IT. NAD-Segment, Element 3036

length=40

partyNumberForwarder

String partyNumberForwarder

Reference number of the party from the viewpoint of the forwarders IT. NAD-Segment, Element 3036

length=40

partyNumberSupplier

String partyNumberSupplier

Reference number of the party from the viewpoint of the suppliers IT. NAD-Segment, Element 3036

length=40

Class de.aeb.xnsg.vcp.bf.lis.LISTrackingEvent20DTO

class LISTrackingEvent20DTO extends Object implements Serializable

Serialized Fields

archivedDocuments

LISArchiveDocumentDTO[] archivedDocuments

The storage data of the archived documents of the event

cesDocuments

LISCESDocumentDTO[] cesDocuments

File system data of the documents of the events

documents

LISBinaryDTO[] documents

Documents of the event.

fileSystemDocuments

LISFileSystemDocumentDTO[] fileSystemDocuments

File system data of the documents of the events

head

LISTrackingEventHead20DTO head

The main information about the TrackingEvent.

metaData

LISMessageMetaDataDTO metaData

Meta data of the message (e.g. sender, receiver, message number).

references

LISTrackingEventReference20DTO[] references

Data about Tracking event type and used reference number. The different references will be handled in a loop. Which means that they will be concatenated with " OR "

Class de.aeb.xnsg.vcp.bf.lis.LISTrackingEventHead20DTO

class LISTrackingEventHead20DTO extends Object implements Serializable

serialVersionUID:

-2226677137809191212L

Serialized Fields

actualDate

LISDateAndZoneDTO actualDate

To specify date and time when event happened. SG5/DTM segment

actualLocation

LISLocationDTO actualLocation

The location where the event happened. SG1 or SG 6 / NAD segment not from LOC segment because it holds no address data

actualSender

LISPartyDTO actualSender

Status sender of the event. The globalLocationNumber of the actualSender should be equal to the senderID of the LISMessageMetaDataDTO.

cancelTargetEvent

Boolean cancelTargetEvent

Flag that indicates if the event in the 'identCodeForNewDates' should be canceled.

identCode

String identCode

Status identCode of the event. SG5/STS segment will be converted to AS4 statusCode

length=20

identCodeForNewDates

String identCodeForNewDates

IdentCode of the event which should be updated. Where planned and expected dates will be updated. Which should be canceled.

length=20

info

String info

Additional information about the event. SG5 FTX segment

length=1000

newExpectedDate

LISDateAndZoneDTO newExpectedDate

New expected date for the event with identCode identCodeForNewDates.

newPlannedDate

LISDateAndZoneDTO newPlannedDate

New planned date for the event with identCode identCodeForNewDates.

reason

String reason

The code of the reason for the event SG5/STS segment

length=20

Class de.aeb.xnsg.vcp.bf.lis.LISTrackingEventList20DTO

class LISTrackingEventList20DTO extends Object implements Serializable

Serialized Fields

archivedDocuments

LISArchiveDocumentDTO[] archivedDocuments

The storage data of the archived documents of the events

documents

LISBinaryDTO[] documents

Documents of the transport.

events

LISTrackingEvent20DTO[] events

The events

fileSystemDocuments

LISFileSystemDocumentDTO[] fileSystemDocuments

File system data of the documents of the events

metaData

LISMessageMetaDataDTO metaData

Meta data of the message (e.g. sender, receiver, message number).

Class de.aeb.xnsg.vcp.bf.lis.LISTrackingEventReference20DTO

class LISTrackingEventReference20DTO extends Object implements Serializable

serialVersionUID:

1441877591649485077L

Serialized Fields

referenceFields

LISTrackingEventReferenceField20DTO[] referenceFields

Reference fields to find the tracking object.

trackingObjectType

String trackingObjectType

The type of the tracking event of the message in the supply chain. This may be one of the value found in the 'TRACKINGOBJECT_TYPE_' constants. Possible values are "ORDER", "ORDERITEM", "CONS", "TRANSLEG", "HUTRANSLEG", "HANDUNIT", "PHYSTRANS" (may be more in the future). This information decides which kind of tracking objects in the VCP database will be effected by this event. ? Maybe this field is not extractable from EANCOM messages but must be ? looked up in some customization settings ? This information will be used to get the matching EventLoader

updateFields

LISTrackingEventUpdateField20DTO[] updateFields

Fields to update in the tracking object.

Class de.aeb.xnsg.vcp.bf.lis.LISTrackingEventReferenceField20DTO

class LISTrackingEventReferenceField20DTO extends Object implements Serializable

serialVersionUID:

7625295000057740975L

Serialized Fields

referenceField

String referenceField

ReferenceField can hold one of the constants REF_FIELD-XYZ constants. It depends on the trackingEventType which field makes sense.

referenceNumber

String referenceNumber

ReferenceNumber

length=depending on the field defined in referenceField

Class de.aeb.xnsg.vcp.bf.lis.LISTrackingEventUpdateField20DTO

class LISTrackingEventUpdateField20DTO extends Object implements Serializable

serialVersionUID:

-8980650744910543531L

Serialized Fields

fieldName

String fieldName

The name of the field to update. This field can hold one of the constants beginning with FIELDNAME_ . It depends on the tracking object type which fieldname makes sense.

fieldValue

String fieldValue

The value of the field to update.

length=depending on the field defined in fieldName