1. Introduction

1.1. Context

CARL Source is supplied with a number of ready-to-use standard interfaces for exchanging data with other applications.

These interfaces are defined by exchange norms, which set out the exchange format for flat files with separators (e.g. CSV) or fixed-width fields.

New interfaces and the associated norms can also be created easily from CARL Source business objects.

1.2. Purpose

This document presents the standard interfaces supplied with CARL Source version 7.7.0 and explains their use, for files with separators.

It includes detailed descriptions of the import files expected for each interface.

Sample files are also available.

2. Extension

The standard interfaces and the integration objects that they contain are not changeable. These components can be used as they stand, or as templates to create customized interfaces.

If you wish to make enhancements, you can create your own integration objects by copying the standard integration objects, and then simply add them to your interface.

The recommended method for creating a new interface is as follows:

  • Create a customized integration object:

    • Open the integration object to be changed.

    • Create the new integration object by copying.

    • Complete the new integration object.

  • Create the norm:

    • Create the norm with a version for the desired file format, specifying the applicable version (even if it is the only version of the norm).

  • Create the interface:

    • Create the interface containing the integration object(s) created.

    • Associate the norm to it.

3. File formats

3.1. XML file

The file format is indicated in the file header.

<xml version="1.0" encoding="UTF-8"/>

To ensure that special characters (accented characters in particular) are handled properly, the input file must be saved using the encoding specified in the header.

More details may be specified in the master tag in the file:

<entities exchangeInterface="ITEM_IN" externalSystem="EXT_SYST_XML" timezone="Europe/Paris" language="en_GB">

For the format of the timezone attribute, see Time zone management.
For the format of the language attribute, see Language management.

3.2. CSV file

Import settings may be specified in the first line of the file (optional for manual loading, apart from the interface).

These elements are to be defined in pairs: « Name ; Value ».
The external system, interface, and time zone to be used can be defined.

Seq. Contents Comment

0

Setting code

Value = externalSystem

1

Setting value

Code

2

Setting code

Value = exchangeInterface

3

Setting value

Code

4

Setting code

Value = timezone

5

Setting value

Timezone code
Example of a first line of a file header
externalSystem ;EXT_SYST_CSV ;exchangeInterface ;ITEM_IN_CSV; timezone ;Europe/Paris; language ;en_GB

To ensure that accented characters are handled properly, the encoding of the CSV files must be identical to that specified for the connection point used.

The example files provided are suitable for the CARL Source standard interfaces, with a connection point specifying ‘UTF-8' encoding.

3.3. Carriage returns in multi-line fields

For comment fields spreading over several lines, a carriage return in the data should be specified using the corresponding XML tags (<br/>):

Such as for a CSV file.
WOCOMMENT;<p>Commentaire <br/>détaillé <br/>de l'intervention</p>;
With special characters escaped for an XML file, for example.
<p>Commentaire <br/>détaillé <br/>de l'intervention</p>

4. File content

4.1. Creating/Updating existing data

When the object to be imported has an identifying code, if the import file includes an element already included in the database, you can decide whether the import will:

  • Update the existing element with the imported line,

  • Reject the line relating to the existing element.

The appropriate action depends on the import file content.

Tip

Refer to the ‘Examples of exchange files' section of the CARL Source online help.
Important

The same constraints apply to creating an element by importing as to creating from the application. In particular, you cannot create an element in a non-initial state.
For example, you cannot import a work order directly in the archived state, or a PO directly in the validated state.

4.2. Order of attributes and columns

Save for rare exceptions indicated in the description of the interfaces in question, the attribute order is of no importance in an XML file.
In flat files with separators, however, the order of the attributes must match that defined in the exchange norm.

4.3. Exported files: filters

On an output interface, the exported elements can be filtered for each integration object.
The filter indicated on the interface integration point can be a classic or advanced filter, and must be public. For example, you can choose to export only DIs created within the last 7 days, using a filter on the minimum creation date, with the value {sysDate} - 7{day}.

When running the interface manually, however, you can specify a non-public filter for integration points.

4.4. Differential export

If you wish to perform a differential export, the interface must be associated with an external system that is in turn associated with a connection point.

4.5. Time zone management

Imported and exported times can be expressed in a particular time zone, specified in the file header, in order to take time differences into account.

A few typical TimeZone values allowed for data export/import are given below:

  • Europe/Paris

  • Europe/Monaco

  • Europe/Brussels

  • Europe/Luxembourg

  • Europe/Rome

  • Europe/Madrid

  • Europe/Lisbon

  • Europe/London

  • Europe/Berlin

  • Europe/Amsterdam

  • Europe/Moscow

  • America/Los_Angeles

  • America/New_York

  • America/Vancouver

  • US/Arizona

  • US/Alaska

  • US/Hawaii

  • Asia/Dubai

  • Asia/Jakarta

  • Asia/Hong_Kong

4.6. Language management

When several languages are installed, you can import data in one of those languages.
To do so, the entities attribute must be added to the language tag to specify the language in which the data is imported.

Rules:

  • When the language attribute is not specified, the data is imported in the main language,

  • The possible values for the language attribute are the codes of LANGUAGE list of values.
    If the code used does not exist on this list of values, an error indicates that the languages is not available.

  • If the language attribute only contains the language (for example, in), then the application searches for the first value starting with this language on the LANGUAGE list of values.

  • When the language attribute corresponds to a language other than the main language of the application (applicationLanguage) and the business object associated with the integration object is translatable, the data is imported into the main table and into the translation table.

4.7. Using the Invoke method (calendar import)

In the XML interface for importing availability calendars (CALENDAR) concerning technicians, material resources, or equipment, it is possible to invoke a method in order to proceed with a deletion over a defined period.

Example with the standard CALENDAR_IN interface: Deleting "vacation" availabilities for a technician over a defined period
<?xml version='1.0' encoding='UTF-8'?>
<entities exchangeInterface="CALENDAR_IN" timezone="Europe/Paris">
    <invoke service="com.carl.xnet.resource.service.CalendarService" method="deletePeriods">
        <periodParametersList>
            <periodParameter>
                <calendarPeriodClassName>com.carl.xnet.resource.backend.bean.TechCalendarBean</calendarPeriodClassName>
                <ownerAttributeName>technician</ownerAttributeName>
                <ownerAttributeCode>TECH</ownerAttributeCode>
                <!-- Pour une disponibilité en particulier -->
                <availabilityCode>CONGES</availabilityCode>
                <!-- Plage de période impactée (autre format de date possible : 2021-03-24 08:00:00.000 +0100) -->
                <begin>2021-03-24 08:00:00</begin>
                <end>2021-03-24 22:00:00</end>
            </periodParameter>
        </periodParametersList>
    </invoke>
</entities>

5. Table of standard interfaces

All the interfaces presented exist as input (suffix ‘_IN') and output (suffix ‘_OUT') interfaces).
Interfaces in csv format have an additional ‘_CSV' suffix.

Exchange object Interface Standard version
(if CSV interface exists)

Equipment module

Template

PATTERN

Structure point

BOX

Symptom

SYMPTOM

Cause

FAILURECAUSE

Remedy

CURE

Asset

MATERIAL

Equipment link

LINKEQUIPMENT

LINKEQUIPMENT_2.0

Event

EVENT

EVENT_1.0

Reading point

MEASUREPOINT

MEASUREPOINT_1.1

Measurement reading

MEASUREREADING

MEASUREREADING_1.0

Equipment characteristics

EQPTCHARACT

EQPTCHARACT_1.0 (version 4.0)
EQPTCHARACT_2.0 (version 4.2)

Road

ROAD

ROAD_1.0

Brand name

BRAND

BRAND_1.0

Energy point

ENERGYMETER

ENERGYMETER_2.0

Fuel (Transport)

FUEL

FUEL_1.0

Location (Facility)

FM_LOCATION

Real estate asset (Facility)

FM_REALTY

Issuance of receipts line (Facility)

FM_PAYMENT

Location surface (Facility)

FM_SURFACE

Surface type (Facility)

FM_SURFACETYPE

Work module

Work order type

ACTIONTYPE

Skill

SKILL

Team

TEAM

Operation

PROCESS

Work request

MR

MR_2.0

Work order template

PWO

Maintenance sheet

MAINTPLAN

Work order

WO

WO_2.0 (main elements, for standard version)

Labor

LABOR

LABOR_1.1

Preventive plan

PREVENTIVE

Diagnosis

WOEXTPROVIDER (1)

WOEXTPROVIDER_1.0

Evaluation

EVALUATION

Stock module

Family

FAMILY

Warehouse

WAREHOUSE

Item

ITEM

ITEM_1.2 (main elements)

Item storage

BATCH

Stock movement history
(export only)

HISTOSTOCKMVT_OUT

Stock movement

STOCKMOVEMENT

STOCKMOVEMENT_2.0

Store locations

LOCATION

LOCATION_1.0

Purchasing Module

Purchase type

PURCHASETYPE (1)

PURCHASETYPE_1.0

Supplier

VENDOR

VENDOR_4.0

Purchase request

PR

Purchase order

PO

PO_2.0

Receipt

DELIVERY

DELIVERY_2.0

Supplier return

SUPPLIERRETURN

SUPPLIERRETURN_1.0

Contract

CONTRACT

Resource module

Service

SERVICE

Technician

TECHNICIAN

Tenant

TENANT

Material resource

TOOL

Calendar

CALENDAR (2)

Management

DEPARTMENT

DEPARTMENT_1.0

Customer module

Customer

CUSTOMER

Accounts module

Budget

BUDGACC

BUDGACC_1.0

Cost center

COSTCENTER

COSTCENTER_1.0

AP/EA/Assignment (City)

BUDGETAUTHOR

BUDGETAUTHORITY_1.0

Budget entry (Allocation)

BUDGALLOCATION (3)

Cost center entry (Allocation)

CCTERALLOCATION (3)

System module

List of values

VALUELIST

Site

SITE

Site group

GROUPSITE

User

USER

Characteristics template

CHARACT (3)

CHARACT_1.0

Characteristics values

VALUECHARACT (1)

(1) Only the import interface (_IN suffix) is available.
(2) The import interface (_IN suffix) is used to call up a service for mass deletion of a user’s time ranges. Refer to the section Using the Invoke method (calendar import) for a usage example.
(3) The interface only allows the creation of an element, updating an existing element is forbidden.

6. Name of CSV exchange files

6.1. Formats of values

Identifier

String with up to 33 characters.

Code

String with up to 20 characters, in upper case and with no spaces.

Name

String with up to 60 characters.

Free text

String with up to 255 characters.

Long description

String with up to 4000 characters.

List value

Should contain the code for the value (list of values function).

Boolean

Must contain either ‘false' or ‘true'.

Numeric

The decimal separator is a decimal point ‘.'. A thousands separator is not used.

Date

Format: YYYY-MM-DD

Date / Time

Format: YYYY-MM-DD HH:MM:SS

Mandatory fields are shown by an asterisk *.

6.2. Secondary records

Secondary records are never mandatory.
In particular, the record describing the change of status of an element (STATUS). If not entered, the element is created in its default creation state, as follows:

  • "Not yet taken into account" for a WR,

  • "In preparation" for a work order,

  • "Active" for a supplier, budget, cost center, or item,

  • "Awaiting validation" for a PO.

6.3. Equipment module

6.3.1. Event

Seq. Contents Comment

0

Record identifier *

Value = EVENT

1

Date *

Date/Time format

2

Structure point (mandatory if asset not entered)

Code format

3

Asset (mandatory if asset not entered)

Code format

4

Symptom *

Code format

5

Comment

Free text

6.3.2. Reading point

Seq. Column Format/values

0

Record identifier *

Value = MEASUREPOINT

1

Reading point code (for update)

Code

2

Reading point code * (for creation)

Code

3

Name

Name

4

Associated structure point (mandatory if asset not entered)

Code

5

Associated asset (mandatory if structure point not entered)

Code

6

Reading point site

Code

7

Reading point template

Code

8

Actual meter?

Boolean

9

Reading point type * (required if template not entered)

Value: 0 (simple), 1 (meter)

10

Reading point unit

Code

11

Number of decimal places

Numeric

12

Minimum value (required if template not entered)

Numeric

13

Maximum value (required if template not entered)

Numeric

14

Regression forbidden (Meter only)

Boolean

15

Readings period

Integer

16

Average ageing value (Meter only)

Numeric

17

Average ageing period (Meter only)

Integer

18

Cost type (meter only)

Value from COSTTYPE list

19

Unit price (meter only)

Numeric

20

Cost center (meter only)

Code

21

Reading point category

Free text
Transport: MEASURECATEGORY list

22

Monitoring lower bound (Simple reading point only)

Numeric

23

Monitoring upper bound (Simple reading point only)

Numeric

24

Correction lower bound (Simple reading point only)

Numeric

25

Correction upper bound (Simple reading point only)

Numeric

26

Issue a WR (Simple reading point only)

Boolean

27

Send an email (Simple reading point only)

Boolean

28

Extrapolation type *

MEASUREEXTRAPOLATION list

29

Transport: Fuel badge

Text
6.3.2.1. Reading point: Link
Seq. Column Format/values

0

Record identifier *

Value = LINKMEASUREPT

1

Join identifier *

Value = MEASUREPOINTLINK

2

Child reading point code *

Code

3

Ageing coefficient

Numeric

4

Link start date

Date/Time

5

Link end date

Date/Time

6

Comment

Free text

6.3.3. Measurement reading

Seq. Column Format/values

0

Record identifier *

Value = MEASUREREADING

1

Reading point code *

Code

2

Measurement date *

Date/Time

3

Reading *

Numeric

4

Correction

Boolean

5

Repercussion

Boolean

6

Comment

Long description

7

Source

"1": Manual, "2": Automatic.

8

Created by

Code

6.3.4. Link between equipment items

Seq. Column Format/values

0

Record identifier *

Value = LINKEQUIPMENT

1

Join identifier *

Identifier

2

Parent structure code *

Code

3

Parent equipment code *

Code

4

Child structure code *

Code

5

Child equipment code *

Code

6

Link start date *

Date/Time (1800-01-01 00:00:00.000 for a non-dated link)

7

Link end date *

Date/Time (2200-12-31 00:00:00.000 for a non-dated link)

8

Quantity of the link (for a network or composition link)

Numeric

9

Link description

Free text

10

Order of link in the branch

Integer

6.3.5. Characteristic of an item of equipment (template, asset, structure point)

Seq. Column Format/values

0

Record identifier *

Value = ITEMCHARACT / MATERIALCHARACT / BOXCHARACT

1

Code of the item/model, asset or structure point *

Code

2

Characteristic *

Code

3

Value

Associated format (depending on characteristic)

6.3.6. Road

Seq. Column Format/values

0

Record identifier *

Value = ROAD

1

Road code (for creation) *

Code format

2

Work request code (for update)

Code format

3

Type

Code format

4

Private road?

Boolean

5

Address description/first address line

Free text

6

Second address line

Free text

7

Third address line

Free text

8

Post code

Free text

9

City

Free text

10

State/Region

Free text

11

Country

Free text

12

Active?

Boolean

13

Free text 1

Free text

14

Free text 2

Free text

15

Free text 3

Free text

16

Free text 4

Free text

17

Free text 5

Free text

18

Free text 6

Free text

19

Free text 7

Free text

20

Free text 8

Free text

21

Free text 9

Free text

22

Free text 10

Free text

23

Free numeric 1

Numeric format

24

Free numeric 2

Numeric format

25

Free numeric 3

Numeric format

26

Free date 1

Date/Time format

27

Free date 2

Date/Time format

28

Free date 3

Date/Time format

29

Free boolean 1

Boolean

30

Free boolean 2

Boolean

31

Free boolean 3

Boolean

6.3.7. Brand name

Seq. Column Format/values

0

Record identifier *

Value = BRAND

1

Brand code (* for creation)

Code

2

Brand code (* for updating)

Code

3

Brand name

Name

4

Manufacturer

Name

5

Brand in use

Boolean

6.3.8. Fuel (Transport)

Seq. Column Format/values

0

Record identifier *

Value = MEASURES

1

Vehicle code

Code

2

Fuel badge

Text

3

Value of the mileage reading

Numeric

4

Reading date/hour

Date

5

Fuel item code

Code

6

Fuel storage warehouse code

Code

7

Storage location code

Code

8

Fuel quantity withdrawn

Numeric

9

Technician code

Code

10

Consumption reading value

Numeric

6.3.9. FM Building

Seq. Column Format/values

0

Record identifier *

Value = BUILDING

1

Building code (* for creation)

Code

2

Building code (* for updates)

Code

3

Equipment type

eqptType list

4

Total gross floor area

Numeric

5

Net floor area

Numeric

6

Available Leased Floor Area

Numeric

7

Work orders authorized

Boolean

8

Occupancy capacity

Numeric

9

Assignment cost center

Code

10

Name

Name

11

Organization

Code

12

Structure

Code

13

Manager

Code

14

Use

USE list

15

Inherited areas

Boolean

16

Number of covered parking spaces

Numeric

17

Inventory number

Text

18

Template

Code

19

Number of outdoor parking spaces

Numeric

20

Status code

Code format (ACTIVE)

21

Free boolean 1

Boolean

22

Free boolean 2

Boolean

23

Free boolean 3

Boolean

24

Free date 1

Date/Time

25

Free date 2

Date/Time

26

Free date 3

Date/Time

27

Free numeric 1

Numeric

28

Free numeric 2

Numeric

29

Free numeric 3

Numeric

30

Free text 1

Text

31

Free text 2

Text

32

Free text 3

Text

33

Free text 4

Text

34

Free text 5

Text

35

Free text 6

Text

36

Free text 7

Text

37

Free text 8

Text

38

Free text 9

Text

39

Free text 10

Text
6.3.9.1. FM Building: Main address
Seq. Column Format/values

0

Record identifier *

Value = ADDRESS

1

Address line 1

Text

2

Address line 2

Text

3

Address line 3

Text

4

City

Text

5

Country

Text

6

Street number qualifier

MENTION list

7

Street number

Numeric

8

State

Text

9

Post code

Text
6.3.9.2. FM Building: Characteristic
Seq. Column Format/values

0

Record identifier *

Value = BOXCHARACT

1

Characteristic

CODE

2

Value of the characteristic

Depending on the type, YYYY-MM-DD if date
6.3.9.3. FM Building: Long description
Seq. Column Format/values

0

Record identifier *

BUILDINGDESCRIPTION

1

Name

Name

6.3.10. Energy point

SEQ. Column Format/values

0

Record identifier *

Value = ENERGYMETER

1

Energy point code (for updating)

Code

2

Engery point code * (for creation)

Code

3

Asset

Code

4

Site

Code

5

Supplier

Code

6

Name

Name

7

Owner

Code

8

Meter type

Code

9

Icon

Code

10

Template

Code

11

Location point

Code

12

Main point

Code

13

Energy distributor

Code

14

Contract

Code

15

Cost center

Code

16

Type of cost

Value list = COSTTYPE

17

Budget

Code

18

Accounting code

Code

19

Currency

Code

20

Customer

Code

21

Billing reading point

Code

22

Service sector decree: reference consumption

Free text

23

Service sector decree: yearly consumption target

Free text

24

Free text 1

Free text

25

Free text 2

Free text

26

Free text 3

Free text

27

Free text 4

Free text

28

Free text 5

Free text

29

Free text 6

Free text

30

Free text 7

Free text

31

Free text 8

Free text

32

Free text 9

Free text

33

Free text 10

Free text

34

Free numeric 1

Electronic format

35

Free numeric 2

Electronic format

36

Free numeric 3

Electronic format

37

Free date 1

Date/Time format

38

Free date 2

Date/Time format

39

Free date 3

Date/Time format

40

Free boolean 1

Boolean

41

Free boolean 2

Boolean

42

Free boolean 3

Boolean
6.3.10.1. Energy point billing
SEQ. Column Format/values

0

Record identifier *

Value = ENERGYMETERINVOICE

1

Amount excluding tax

Numeric

2

Comment

Free text

3

Billing date *

Date format

4

Invoice number *

Free text

5

Taxes Amount

Numeric

6

Date created

Date format

7

Payment due date

Date format

8

Billing reading point

Code

9

Consumption start date

Date format

10

Consumption end date

Date format

11

Consumption volume

Numeric
6.3.10.2. Comment
SEQ. Column Format/values

0

Record identifier *

Value = DESCRIPTION

1

Description

Free text
6.3.10.3. Status
SEQ. Column Format/values

0

Record identifier *

Value = STATUS

1

Status code *

Code format

2

User who changed the status *

Code format

3

Status change date *

Date/Time format

6.4. Work module

6.4.1. Work request: MR

Seq. Contents Comment

0

Record identifier *

Value = MR

1

Work request code (for update)

Code format

2

Work request code (for creation) *

Code format

3

Request title

Description format

4

Priority

Value from PRIORITYLEVEL list

5

WR addressee

Code format

6

Observed symptom

Code format

7

Desired end date

Date/Time format

8

Acceptance of work?

Boolean

9

Requester (if different from issuer)

Free text

10

Requester contact details

Free text

11

WR issuer

Code format

12

Date WR created

Date/Time format

13

Location point

Code format

14

Main point

Code format

15

Asset

Code format

16

Site

Code format

17

Customer

Code format

18

Quotations

Code format

19

Asset out of order?

Boolean

20

Asset unavailable?

Boolean

21

Work category

Value from WORKCATEGORY list

22

Total

Numeric

23

Latitude

Numeric

24

Longitude

Numeric

25

Free text 1

Free text

26

Free text 2

Free text

27

Free text 3

Free text

28

Free text 4

Free text

29

Free text 5

Free text

30

Free text 6

Free text

31

Free text 7

Free text

32

Free text 8

Free text

33

Free text 9

Free text

34

Free text 10

Free text

35

Free numeric 1

Numeric format

36

Free numeric 2

Numeric format

37

Free numeric 3

Numeric format

38

Free date 1

Date/Time format

39

Free date 2

Date/Time format

40

Free date 3

Date/Time format

41

Free boolean 1

Boolean

42

Free boolean 2

Boolean

43

Free boolean 3

Boolean
6.4.1.1. WR: Comment
Seq. Contents Comment

0

Record identifier *

Value = MRDESCRIPTION

1

Contents

Long description
6.4.1.2. WR: State
Seq. Contents Comment

0

Record identifier *

Value = MRSTATUS

1

Status code *

Code format (ACTIVE)

2

User who changed the status *

Code format

3

Status change date *

Date/Time format
6.4.1.3. WR: Safety
Seq. Contents Comment

0

Record identifier *

Value = MRRISK

1

Risk *

Code format

6.4.2. Work order

The work order norm contains the elements most commonly affected by data exchange. It may be copied and completed with other line types.

Seq. Column Format/values

0

Record identifier *

Value = WO

1

Work order code (* for update)

Code

2

Work order code (* for creation)

Code

3

Work order name

Name

4

Start date *

Date/Time

5

End date *

Date/Time

6

Set dates

Boolean

7

Priority *

Value from PRIORITYLEVEL list

8

Work order type *

Code

9

Section *

Code

10

Type

Value from WORKTYPE list

11

Symptom

Code

12

Cause

Code

13

Remedy

Code

14

Asset out of order

Boolean

15

Asset stopped

Boolean

16

Acceptance of work

Boolean

17

Stoppage time

Numeric

18

Expected charge

Numeric

19

Location point

Code

20

Main point

Code

21

Asset

Code

22

Template

Code

23

Family

Code

24

Customer

Code

25

Contract

Code

26

Contract period

Code

27

Non-contract

Boolean

28

Service provider

Code

29

Site

Code

30

Manager

Code

31

Quotations

Code

32

Work order generated from quotation?

Boolean

33

Invoiceable?

Boolean

34

Target end

Date/Time

35

Guarantee

Code

36

Out of guarantee

Boolean

37

Date created

Date/Time

38

Created by

Code

39

Latitude

Numeric

40

Longitude

Numeric

41

Free text 1

Text

42

Free text 2

Text

43

Free text 3

Text

44

Free text 4

Text

45

Free text 5

Text

46

Free text 6

Text

47

Free text 7

Text

48

Free text 8

Text

49

Free text 9

Text

50

Free text 10

Text

51

Free numeric 1

Numeric

52

Free numeric 2

Numeric

53

Free numeric 3

Numeric

54

Free date 1

Date/Time

55

Free date 2

Date/Time

56

Free date 3

Date/Time

57

Free boolean 1

Boolean

58

Free boolean 2

Boolean

59

Free boolean 3

Boolean

60

Assessment

Code

61

Transport: Consequence

Value from CONSEQUENCE list

62

Transport: Date withdrawn from network

Date/Time

63

Transport: Date returned to network

Date/Time

61

Healthcare: Result

Value from WORESULT list

62

Healthcare: Required follow-up

Text
6.4.2.1. Work order: State
Seq. Contents Comment

0

Record identifier *

Value = WOSTATUS

1

Status code *

Code format (ACTIVE)

2

User who changed the status *

Code format

3

Status change date *

Date/Time format
6.4.2.2. Work order: Comment
Seq. Contents Comment

0

Record identifier *

Value = WOCOMMENT

1

Long description

Long description
6.4.2.3. Work order: Related work order
Seq. Contents Comment

0

Record identifier *

Value = WOLINK

1

Related work order

Code format

2

Link order

Integer

3

Hierarchical link

Boolean

4

Link to synchronized dates

Boolean

5

Status inheritance

Boolean

6

Type of link

Value from LINKTYPE list

7

Comment

Free text
6.4.2.4. Work order: Non-validated work order operation

The verification operation for a non-validated work order is identical to that for a ‘conventional' operation, with record name EXPWODIAGPROCESS.

Seq. Contents Comment

0

Record identifier *

Value = EXPWOPROCESS

1

Seq. *

Integer

2

Operation code *

Code format

3

Description

Free text

4

Required

Boolean

5

Skill

Code format

6

Structure point

Code format

7

Asset

Code format

8

Reading point

Code format

9

Type of cost

Code from COSTTYPE list

10

Unit price

Numeric

11

Quantity

Numeric

12

Cost

Numeric

13

Forecast time

Numeric

14

Technician

Code

15

Free text 1

Free text

16

Free text 2

Free text

17

Free text 3

Free text

18

Free text 4

Free text

19

Free text 5

Free text

20

Free text 6

Free text

21

Free text 7

Free text

22

Free text 8

Free text

23

Free text 9

Free text

24

Free text 10

Free text

25

Free numeric 1

Numeric format

26

Free numeric 2

Numeric format

27

Free numeric 3

Numeric format

28

Free date 1

Date/Time format

29

Free date 2

Date/Time format

30

Free date 3

Date/Time format

31

Free boolean 1

Boolean

32

Free boolean 2

Boolean

33

Free boolean 3

Boolean
6.4.2.5. Work order: Validated work order operation
Seq. Contents Comment

0

Record identifier *

Value = WOPROCESS

1

Seq. *

Integer

2

Operation code *

Code format

3

Description

Free text

4

Required

Boolean

5

Skill

Code format

6

Structure point

Code format

7

Asset

Code format

8

Reading point

Code format

9

Type of cost

Code from COSTTYPE list

10

Unit price

Numeric

11

Quantity

Numeric

12

Cost

Numeric

13

Forecast time

Numeric

14

Performed on

Date/Time

15

Technician

Code

16

Time type

Code

17

Duration (if the above three fields are entered, the corresponding labor is created)

Numeric

18

Free text 1

Free text

19

Free text 2

Free text

20

Free text 3

Free text

21

Free text 4

Free text

22

Free text 5

Free text

23

Free text 6

Free text

24

Free text 7

Free text

25

Free text 8

Free text

26

Free text 9

Free text

27

Free text 10

Free text

28

Free numeric 1

Numeric format

29

Free numeric 2

Numeric format

30

Free numeric 3

Numeric format

31

Free date 1

Date/Time format

32

Free date 2

Date/Time format

33

Free date 3

Date/Time format

34

Free boolean 1

Boolean

35

Free boolean 2

Boolean

36

Free boolean 3

Boolean
6.4.2.6. Work order: Verification operation on validated work order
Seq. Contents Comment

0

Record identifier *

Value = WODIAGPROCESS

1

Seq. *

Integer

2

Operation code *

Code format

3

Description

Free text

4

Required

Boolean

5

Skill

Code format

6

Structure point

Code format

7

Asset

Code format

8

Reading point

Code format

9

Type of cost

Code from COSTTYPE list

10

Unit price

Numeric

11

Quantity

Numeric

12

Cost

Numeric

13

Forecast time

Numeric

14

Performed on

Date/Time

15

Technician

Code

16

Time type

Code

17

Duration (if the above three fields are entered, the corresponding labor is created)

Numeric

18

Assessment

Code

19

Reservation number

Free text

20

WR created

Code

21

Work order created

Code

22

Free text 1

Free text

23

Free text 2

Free text

24

Free text 3

Free text

25

Free text 4

Free text

26

Free text 5

Free text

27

Free text 6

Free text

28

Free text 7

Free text

29

Free text 8

Free text

30

Free text 9

Free text

31

Free text 10

Free text

32

Free numeric 1

Numeric format

33

Free numeric 2

Numeric format

34

Free numeric 3

Numeric format

35

Free date 1

Date/Time format

36

Free date 2

Date/Time format

37

Free date 3

Date/Time format

38

Free boolean 1

Boolean

39

Free boolean 2

Boolean

40

Free boolean 3

Boolean
6.4.2.7. Work order: Labor
Seq. Contents Comment

0

Record identifier *

Value = LABOR

1

Technician *

Code

2

Labor date *

Date

3

Duration *

Numeric

4

Time type

Code

5

Labor cost

Numeric

6

Comment

Long description

6.4.3. Labor

Seq. Column Format/values

0

Record identifier *

Value = LABOR

1

Labor identifier (for update)

Identifier

2

Technician *

Code

3

Labor date *

Date

4

Duration *

Numeric

5

Work order (mandatory if type not entered)

Code

6

Labor type (mandatory if work order not entered)

Code

7

Time type

Code

8

Labor cost

Numeric

9

Comment

Free text
6.4.3.1. Labor: Long description
Seq. Column Format/values

0

Record identifier *

Value = DESCRIPTION

1

Long description

Long description

6.4.4. Inspection report (imported as diagnosis)

6.4.4.1. Diagnosis (Inspection report)
Seq. Column Format/values

0

Record identifier *

Value= WOEXTPROVIDER

1

Service provider work order identifier *

Free text

2

Work order code (in CARL Source)

Code

3

Service provider work order domain

Free text

4

Date of request

Date

5

External service provider

Code

6

Site concerned

Code/free text

7

Work order description

Free text

8

Work order comment

Long text

9

Work order start date

Date

10

Work order end date

Date

11

Asset

Code/free text

12

Main point

Code/free text

13

Geographic point code

Code/free text
6.4.4.2. Diagnosis operation (observation)
Seq. Column Format/values

0

Record identifier *

Value= OBSEXTPROVIDER

1

Asset bar code to locate CS asset

Free text

2

Bookmark for observation in initial PDF report

Free text

3

Reference for equipment (at service provider)

Free text

4

Assessment (service provider)

Free text

5

First year of observation

Date

6

Customer asset code

Code/free text

7

Observation date

Date

8

Observation number * (Reservation number)

Free text

9

Serial number

Free text

10

Location code (Location point)

Code/free text

11

Location description (Location point)

Free text

12

Recurrent observation?

Boolean

13

Regulations topic

Free text

14

Regulation item

Free text

15

Regulations section

Free text

16

Regulation point

Free text
6.4.4.3. Description of diagnosis operation (Observation)
Seq. Column Format/values

0

Record identifier *

Value = OBSDESC

1

Observation description

Long description
6.4.4.4. Recommendation from diagnosis operation (Observation)
Seq. Column Format/values

0

Record identifier *

Value = PRECONIZATION

1

Observation description

Long description
6.4.4.5. Attachments to the work order
Seq. Contents Comment

0

Record identifier *

Value = REPORTEXTPROVIDER

1

Filename

Free text

2

Date report first published

Date format

3

Report name

Free text

6.5. Stock module

6.5.1. Stock movement

The records are independent of each other.

6.5.1.1. Inventory
Seq. Contents Comment

0

Record identifier *

Value = INVENTORY

1

Movement type code *

Code format

2

Date of inventory *

Date/Time format

3

Note No.

Code format

4

Inventory cost center

Code format

5

Code of agent performing inventory

Code format

6

Code of agent entering inventory data

Code format

7

Item code *

Code format

8

Warehouse code *

Code format

9

Location code

Code format

10

Warehouse-specific location code (if code used in several warehouses)

Code format

11

Batch No.

Free text

12

Batch description

Free text

13

Inventoried asset code (if serialized item)

Code format

14

Quantity recorded on entry, movement quantity on withdrawal *

Quantity

15

Unit

Code format

16

Batch use-by date

Date format

17

Inventory comment

Free text
6.5.1.2. Entry
Seq. Contents Comment

0

Record identifier *

Value = ENTRY

1

Movement type code *

Code format

2

Date of entry *

Date/Time format

3

Note No.

Code format

4

Code of agent performing entry

Code format

5

Created by (Code of agent who entered data)

Code format

6

Cost center

Code format (deduced from work order or equipment if entered)

7

Work order

Code format. Only one of the three fields is to be filled in.

8

Structure point

9

Allocation asset

10

Item code *

Code format

11

Warehouse code *

Code format

12

Location code

Code format

13

Warehouse-specific location code (if code used in several warehouses)

Code format

14

Quantity entered *

Quantity

15

Unit

Code format

16

Batch No.

Free text

17

Batch description

Free text

18

Use-by date

Date format

19

Inventoried asset (if serialized item)

Code format

20

Unit price

Amount format

21

Purchase line (for entry from purchase)

Identifier format

22

Receipt line (for entry from purchase)

Identifier format

23

Entry line comment

Free text
6.5.1.3. Withdrawal
Seq. Contents Comment

0

Record identifier *

Value = ISSUE

1

Type of movement *

Code format (WITHDRAWAL)

2

Movement date *

Date/Time format

3

Note No.

Code format

4

Agent performing withdrawal

Code format

5

Created by (agent who entered data)

Code format

6

Cost center

Code format (deduced from work order or equipment if entered)

7

Allocation work order

Code format.
Only one of the three fields is to be filled in.

8

Structure point

9

Allocation asset

10

Item *

Code format

11

Warehouse *

Code format

12

Location

Code format

13

Warehouse-specific location code (if code used in several warehouses)

Code format

14

Quantity *

Numeric

15

Unit

Numeric

16

Batch number

Free text

17

Batch description

Free text

18

Asset withdrawn (if serialized item)

Code format

19

Reservation (for consumption reservation)

Identifier format

20

Return line (for entry from purchase)

Identifier format

21

Movement comment

Free text

6.5.2. Item

Seq. Contents Comment

0

Record identifier *

Value = ITEM

1

Item code (* for update)

Code format

2

Item code (* for creation)

Code format

3

Name

Description format

4

Unit *

Code format

5

Number of decimal places *

Integer

6

Category

Value from CATEGORYTYPE list

7

Family

Code format

8

Main supplier

Code format

9

Manufacturer

Code format

10

Manufacturer’s reference

Free text

11

Purchase type

Code format

12

Asset

Code format

13

Bar code

Free text

14

Budget

Code format

15

Cost center

Code format

16

Accounting code

Code format

17

Tax

Code format

18

Standard price

Numeric

19

Average weighted price

Numeric

20

Managed in stock?

Boolean

21

Managed by batch?

Boolean

22

Serialized?

Boolean

23

Model?

Boolean

24

Repairable?

Boolean

25

Asset?

Boolean

26

Check reservation?

Boolean

27

Incoming inspection?

Boolean

28

Direct purchase?

Boolean

29

Weight

Numeric

30

Agent who performed the last update

Code format

31

Date of latest update

Date/Time format

32

Stock reorder?

Boolean

33

Resupply conditions

Value from MODEQUANTITY list

34

Minimum quantity

Numeric

35

Maximum quantity

Numeric

36

Quantity to be ordered

Numeric

37

Safety quantity

Numeric

38

Reorder period

Integer

39

Item label

Boolean

40

Number of items per label

Integer

41

Holding cost ratio

Numeric

42

Packaging

Numeric

43

Order costs

Numeric

44

Free text 1

Free text

45

Free text 2

Free text

46

Free text 3

Free text

47

Free text 4

Free text

48

Free text 5

Free text

49

Free text 6

Free text

50

Free text 7

Free text

51

Free text 8

Free text

52

Free text 9

Free text

53

Free text 10

Free text

54

Free numeric 1

Numeric format

55

Free numeric 2

Numeric format

56

Free numeric 3

Numeric format

57

Free date 1

Date/Time format

58

Free date 2

Date/Time format

59

Free date 3

Date/Time format

60

Free boolean 1

Boolean

61

Free boolean 2

Boolean

62

Free boolean 3

Boolean
6.5.2.1. Item: State
Seq. Contents Comment

0

Record identifier *

Value = ITEMSTATUS

1

Status code *

Code format (ACTIVE)

2

User who changed the status *

Code format

3

Status change date *

Date/Time format
6.5.2.2. Item: Long description
Seq. Contents Comment

0

Record identifier *

Value = DESCRIPTION

1

Long description

Long description
6.5.2.3. Item [Warehouse]

For general resupply mode, only the warehouse, budget and accounting code columns should be entered.

Seq. Contents Comment

0

Record identifier *

Value = ITEMWAREHOUSE

1

Warehouse code *

Code (coderef)

2

Item *

Code (coderef)

3

Warehouse code *

Code

4

Budget

Code

5

Accounting code

Code

6

Supply type

  • 0 - none,

  • 1- supply,

  • 2 - replenishment,

  • 3 - mixed.

Value from REORDERTYPE list

7

Supply mode

  • 0 for Fixed,

  • 1 for variable

Value from MODEQUANTITY list

8

Supplier

Code

9

Quantity to be ordered, mandatory if fixed mode

Numeric

10

Minimum quantity

Numeric

11

Maximum quantity

Numeric

12

Safety quantity

Numeric

13

Reorder period

Integer

14

Item label?

Boolean

15

Number of items per label

Integer

16

Holding cost ratio

Numeric

17

Packaging

Numeric

18

Order costs

Numeric
6.5.2.4. Item [Characteristic]
Seq. Contents Comment

0

Record identifier *

Value = ITEMCHARACT

1

Characteristic code *

Code

2

Value

Depending on the type, YYYY-MM-DD if date
6.5.2.5. Item catalog
Seq. Column Format/values

0

Record identifier *

Value = VENDORITEM

1

Supplier (* for updating)

Code

2

Supplier(* for creation)

Code

3

Item reference

Name

4

Name of the conditions

Name

5

Gross unit price excl. tax *

Numeric

6

Discount

Numeric, between 0 and 100

7

Purchase unit *

Code

8

No. of decimal places

Numeric

9

Purchase coefficient

Numeric

10

Minimum purchase quantity

Numeric

11

Packaging

Numeric

12

Warehouse (* for updating)

Code

13

Warehouse (* for creation)

Code

14

Manufacturer

Code

15

Manufacturer’s reference

Name

16

Warranty period (months)

Numeric

17

Delivery lead time (days)

Numeric

18

Date of latest update

Date/Time

19

State

Status code (ACTIVE/INACTIVE)

20

PrupdateCatalog

Update catalog when closing PR/Order?

6.5.3. Locations

Seq. Contents Comment

0

Record identifier *

Value = LOCATION

1

Location code (* for updating)

Code format

2

Location code (* for creation)

Code format

3

Description

Free text

4

Warehouse

Free text

5

Height

Numeric

6

Width

Numeric

7

Depth

Numeric

8

Weight

Numeric

9

State

Code format (ACTIVE/INACTIVE)

6.6. Purchasing module

6.6.1. Purchase type

Seq. Contents Comment

0

Record identifier *

Value = PURCHASETYPE

1

Purchasing type code *

Code

2

Purchasing type description

Name

3

Purchasing type status

List value PURCHASETYPESTATUS

4

Purchase threshold

Numeric

6.6.2. Supplier

Seq. Column Format

0

Record identifier *

Value = VENDOR

1

Supplier code (* for update)

Code

2

Supplier code (* for creation)

Code

3

Name

Name

4

Currency *

Code

5

Customer number

Text

6

Supplier’s web site

Text

7

Supplier’s company registration number

Text

8

Supplier activity code (NAF)

Text

9

DUNS No.

Text

10

Manufacturer?

Boolean

11

After-sales service?

Boolean

12

Energy distributor

Boolean

13

Order form transmission mode

Value from SENDINGMODE list

14

Item shipment mode

Value from SHIPMENTMODE list

15

Incoterms (transport liability)

Value from INCOTERMS list

16

Minimum purchase amount

Numeric

17

Supplier discount

Numeric

18

VAT rate

Code

19

VAT type

Code

20

Other tax

Numeric

21

Payment terms

Numeric

22

Accounting code

Code

23

Payment method

Value from PAYMENTMETHOD list

24

Bank name

Text

25

Bank reference

Text

26

Estimated quality

Value from QUALITYINDEX list

27

Responsiveness

Value from QUALITYINDEX list

28

Quality Report

Value from QUALITYINDEX list

29

Average delivery delay (days)

Numeric

30

Financial risk

Value from RISKLEVEL list

31

Competition

Value from RISKLEVEL list

32

Free text 1

Text

33

Free text 2

Text

34

Free text 3

Text

35

Free text 4

Text

36

Free text 5

Text

37

Free text 6

Text

38

Free text 7

Text

39

Free text 8

Text

40

Free text 9

Text

41

Free text 10

Text

42

Free numeric 1

Numeric

43

Free numeric 2

Numeric

44

Free numeric 3

Numeric

45

Free date 1

Date/Time

46

Free date 2

Date/Time

47

Free date 3

Date/Time

48

Free boolean 1

Boolean

49

Free boolean 2

Boolean

50

Free boolean 3

Boolean
6.6.2.1. Supplier: State
Seq. Contents Comment

0

Record identifier *

Value = VENDORSTATUS

1

Status code *

Code format (ACTIVE)

2

User who changed the status *

Code format

3

Status change date *

Date/Time format
6.6.2.2. Order/billing address
Seq. Column Format/values

0

Record identifier *

Value = VENDORADDRESS

1

Main address

Boolean

2

Order address

Boolean

3

Invoicing address

Boolean

4

Street number

Free text

5

Additional to number (b, …​)

Free text

6

First address line

Free text

7

second address line

Free text

8

third address line

Free text

9

Post code

Free text

10

City

Free text

11

Status

Free text

12

Country

Free text

13

Street

Free text

14

Code

Code format

15

Description

Name
6.6.2.3. Supplier contact
Seq. Column Format/values

0

Record identifier *

Value = SUPPLIERCONTACT

1

Contact type

PURCHASE or INVOICE

2

Contact name

Free text

3

Function

Free text
6.6.2.4. Contact details
Seq. Column Format/values

0

Record identifier *

Value = CONTACTPHONE

1

Type

Value = FAX, HOME_PHONE, MOBILE_PHONE, EMAIL.

2

Number

Free text

6.6.3. Purchase order

Seq. Column Format/values

0

Record identifier *

Value = PO

1

Order code (* for update)

Code

2

Order code (* for creation)

Code

3

Urgent order *

Boolean

4

Open order *

Boolean

5

Supplier *

Code

6

Currency *

Code

7

Exchange rate *

Numeric

8

Order transmission mode

Value from SENDINGMODE list

9

External order

Name

10

Package

Name

11

Budget

Code

12

Contract

Code

13

Contract period

Code

14

Site

Code

15

Date received

Date

16

Shipment mode

Value from SHIPMENTMODE list

17

Incoterms (transport liability)

Value from INCOTERMS list

18

Invoice site

Code

19

Payment terms

Code

20

Means of payment

Value from PAYMENTMETHOD list

21

Created by

Code

22

Free text 1

Free text

23

Free text 2

Free text

24

Free text 3

Free text

25

Free text 4

Free text

26

Free text 5

Free text

27

Free text 6

Free text

28

Free text 7

Free text

29

Free text 8

Free text

30

Free text 9

Free text

31

Free text 10

Free text

32

Free numeric 1

Numeric

33

Free numeric 2

Numeric

34

Free numeric 3

Numeric

35

Free date 1

Date/Time

36

Free date 2

Date/Time

37

Free date 3

Date/Time

38

Free boolean 1

Boolean

39

Free boolean 2

Boolean

40

Free boolean 3

Boolean
6.6.3.1. Purchase order: State
Note

Comment: To create orders with validated or issued status, specific processing must be defined or a transition file must be imported (see importPOTransition.xml).
Seq. Contents Comment

0

Record identifier *

Value = POSTATUS

1

Status code *

Code format (AWAITINGVALID)

2

User who changed the status *

Code format

3

Status change date *

Date/Time format
6.6.3.2. Purchase order: Supplier comment
Seq. Contents Comment

0

Record identifier *

Value = COMMENTTOSUPPLIER

1

Long description

Long description
6.6.3.3. Purchase order: Internal comments
Seq. Contents Comment

0

Record identifier *

Value = PRIVATECOMMENT

1

Long description

Long description
6.6.3.4. Purchase order: Overall additional costs
Seq. Column Format/values

0

Record identifier *

Value = POEXTRACOST

1

Additional cost *

Code

2

Amount of additional cost *

Numeric

3

Tax on additional cost

Code

4

Tax rate on additional cost

Numeric

5

Budget for additional cost *

Code

6

Accounting code for additional cost

Code
6.6.3.5. Purchase order: Contact
Seq. Column Format/values

0

Record identifier *

Value = POCONTACT

1

Contact name

Free text

2

Contact type

‘PURCHASE'

3

Contact phone number

Free text

4

Contact mobile phone number

Free text

5

Contact fax number

Free text

6

Contact email address

Free text
6.6.3.6. Purchase order: Order address
Seq. Column Format/values

0

Record identifier *

Value = ORDERADDRESS

1

Order address: Line 1

Free text

2

Order address: Line 2

Free text

3

Order address: Line 3

Free text

4

Order address: Post code

Free text

5

Order address: City

Free text

6

Order address: State

Free text

7

Order address: Country

Free text

8

Extra (Additional information to street number)

Free text

9

Street number

Free text
6.6.3.7. Purchase order: Delivery address
Seq. Column Format/values

0

Record identifier *

Value = DELIVERYADDRESS

1

Delivery address: Line 1

Free text

2

Delivery address: Line 2

Free text

3

Delivery address: Line 3

Free text

4

Delivery address: Post code

Free text

5

Delivery address: City

Free text

6

Delivery address: State

Free text

7

Delivery address: Country

Free text

8

Extra (Additional information to street number)

Free text

9

Street number

Free text
6.6.3.8. Purchase order: Billing address
Seq. Column Format/values

0

Record identifier *

Value = INVOICEADDRESS

1

Invoicing address: Line 1

Free text

2

Invoicing address: Line 2

Free text

3

Invoicing address: Line 3

Free text

4

Invoicing address: Post code

Free text

5

Invoicing address: City

Free text

6

Invoicing address: State

Free text

7

Invoicing address: Country

Free text

8

Extra (Additional information to street number)

Free text

9

Street number

Free text
6.6.3.9. Purchase order line
Seq. Column Format/values

0

Record identifier *

Value = POLINE

1

Order line identifier

Identifier

2

Order line number *

Integer

3

Source *

‘STOCK', ‘USER' or ‘WORK ORDER'

4

Requested by

Code

5

Type of purchase *

‘ITEM' or ‘SERVICE'

6

Item code (Mandatory if origin = STOCK)

Code

7

Service code

Code

8

Supplier reference

Name

9

Order line description

Name

10

Purchase type *

Code

11

Warehouse (Mandatory if origin = STOCK)

Code

12

Work order (Mandatory if origin = WORK ORDER)

Code

13

PR purchase line

Identifier

14

Contract period (Mandatory if origin = CONTRACT)

Code

15

Equipment

Code

16

Delivery lead time

Numeric

17

Expected receipt date

Date

18

Incoming inspection?

Boolean

19

Purchase unit

Code

20

Quantity ordered *

Numeric

21

Purchase coefficient

Numeric

22

Gross unit price

Numeric

22

Discount (Between 0 and 100)

Numeric

23

Tax 1

Code

24

Tax 1 rate

Numeric

25

Tax 2

Code

26

Tax 2 rate

Numeric

27

Tax 3

Code

28

Tax 3 rate

Numeric

29

Budget (Mandatory only if not entered on order)

Code

30

Cost center (Mandatory if origin = USER)

Code

31

Accounting code

Code
6.6.3.10. Order line: Comment
Seq. Contents Comment

0

Record identifier *

Value = POLINELONGDESC

1

Long description

Free text
6.6.3.11. Order line: Additional cost
Seq. Column Format/values

0

Record identifier *

Value = POLINEEXTRACOST

1

Additional cost *

Code

2

Amount of additional cost *

Numeric

3

Tax on additional cost

Code

4

Tax rate on additional cost

Numeric

6.6.4. Receipt

Seq. Column Format/values

0

Record identifier *

Value = DELIVERY

1

Delivery note *

Code

2

Delivery date *

Date

3

Created by

Code
6.6.4.1. Receipt: Comment
Seq. Contents Comment

0

Record identifier *

Value = DELIVERYCOMMENT

1

Long description

Free text
6.6.4.2. Receipt line
Seq. Column Format/values

0

Record identifier *

Value = DELIVERYLINE

1

Delivery line identifier (Mandatory to enable it to be referenced in returns and stock entries)

Identifier

2

Order line identifier *

Identifier

3

Order line identifier * (for link with the PR)

Identifier

4

Purchase line identifier *

Identifier

5

Item

Code

6

Service

Code

7

Quantity *

Numeric

8

Net unit price *

Numeric

9

Completed? *

Boolean

10

Comment on line

Free text

11

Dispute type

Value from LITIGATIONTYPE list

12

Disputed quantity

Numeric

13

Comment on the dispute

Free text

6.6.5. Supplier return

Seq. Column Format/values

0

Record identifier *

Value = RETURN

1

Return note *

Code

2

Return date *

Date

3

Created by

Code
6.6.5.1. Return: Return line
Seq. Column Format/values

0

Record identifier *

Value = RETURNLINE

1

Return line identifier (Mandatory for stock withdrawals)

Identifier

2

Delivery line identifier *

Identifier

3

Quantity returned *

Numeric

4

Receipt required? *

Boolean

5

Reason for return

Free text

6.7. Resource module

6.7.1. Management

Seq. Contents Comment

0

Record identifier *

Value = DEPARTMENT

1

Management code (for updating)

Code

2

Management code (* for creation)

Code

3

Name

Name

4

Manager

Code

5

Cost center

Code

6

Organization

Code

7

Status

List value DEPARTMENTSTATUS

8

Free text 1

Free text

9

Free text 2

Free text

10

Free text 3

Free text

11

Free text 4

Free text

12

Free text 5

Free text

13

Free text 6

Free text

14

Free text 7

Free text

15

Free text 8

Free text

16

Free text 9

Free text

17

Free text 10

Free text

18

Free numeric 1

Numeric

19

Free numeric 2

Numeric

20

Free numeric 3

Numeric

21

Free date 1

Date/Time

22

Free date 2

Date/Time

23

Free date 3

Date/Time

24

Free boolean 1

Boolean

25

Free boolean 2

Boolean

26

Free boolean 3

Boolean

6.8. Accounts module

6.8.1. Budget

Seq. Contents Comment

0

Record identifier *

Value = BUDGACC

1

Budget code (for updates)

Code

2

Budget code (* for creation)

Code

3

Name

Name

4

Start date *

Date

5

End date

Date

6

Budget control level

Value from BUDGACCCTRL list

7

Type of budget

Value from BUDGACCTYPE list

8

Parent budget

Code

9

Site

Code

10

Manager

Code
6.8.1.1. Budget: Long description
Seq. Contents Comment

0

Record identifier *

Value = DESCRIPTION

1

Long description

Long description
6.8.1.2. Budget: State
Seq. Contents Comment

0

Record identifier *

Value = BUDGACCSTATUS

1

Status code *

Code format

2

User who changed the status *

Code format

3

Status change date *

Date/Time format

6.8.2. Cost center

Seq. Contents Comment

0

Record identifier *

Value = COSTCENTER

1

Cost center code (* for update)

Code

2

Cost center code (* for creation)

Code

3

Name

Name

4

Start date *

Date

5

End date

Date

6

Cost center control level

Value from BUDGACCCTRL list

7

Parent cost center

Code

8

Site

Code

9

Manager

Code
6.8.2.1. Cost center: Long description
Seq. Contents Comment

0

Record identifier *

Value = DESCRIPTION

1

Long description

Long description
6.8.2.2. Cost center: State
Seq. Contents Comment

0

Record identifier *

Value = COSTCENTERSTATUS

1

Status code *

Code format

2

User who changed the status *

Code format

3

Status change date *

Date/Time format

6.8.3. AP/AE/Assignments

Seq. Contents Comment

0

Record identifier *

Value = BUDGETAUTHORITY

1

AP/AE/Assignment code (* for updating)

Code

2

AP/AE/Assignment code (* for creation)

Code

3

Description

Name

4

Budget carrying the PA/AE/Assignment *

Code

5

AP/AE/Assignment type

List value BUDGETAUTHORITYTYPE

6

Start date

Date

7

End date

Date

6.8.4. Characteristic

Seq. Contents Comment

0

Record identifier *

Value = CHARACT

1

Characteristic code (* for creation)

Code

2

Description

Name

3

Category *

Code

4

Domain *

Code

5

Number of characters

Integer

6

Decimals (Available according to compatible domain)

Integer

7

Minimum (Available according to compatible domain)

Integer

8

Maximum (Available according to compatible domain)

Integer

9

Unit (Available according to compatible domain)

Code

10

Value list (Available according to compatible domain)

Code

11

Choice list (Available according to compatible domain)

Code

12

Historized

Boolean

13

Important: Default value

Boolean
6.8.4.1. Characteristic: Description help
Seq. Contents Comment

0

Record identifier *

Value = CHARACTDESC

1

Characteristic help

Long description

 

Trademark notice

Every effort has been made to ensure the accuracy of the information at the time of publication of this document.
As CARL Source is constantly evolving, CARL Berger-Levrault cannot be held responsible for any gaps or errors in this document.
If you notice any inconsistencies or errors, please contact CARL Berger-Levrault’s support department.
 
Any reproduction, in whole or in part, in any form whatsoever, is strictly prohibited without the prior authorization of CARL Berger-Levrault.
 
All trademarks and product names mentioned in this document are the property of their respective owners as listed below:

  • Android™ and Google Chrome® are registered trademarks of Google LCC.

  • ArcGIS® is a registered trademark of the Environmental Systems Research Institute.

  • Elasticsearch® is a registered trademark of Elasticsearch B.V. in the United States and other countries.

  • Firefox® is a registered trademark of the Mozilla Foundation.

  • Java™ and Oracle® are registered trademarks of Oracle Corporation.

  • PostgreSQL® is a registered trademark of The PostgreSQL Community Association of Canada.

  • Safari® is a trademark of Apple Inc. registered in the U.S. and other countries.

  • Azure®, SQL Server®, Microsoft Edge® and Windows® are registered trademarks of Microsoft Corporation.

  • Tomcat® is a registered trademark of the Apache Software Foundation in the United States and other countries.