ORTEMS setup
This function is used to setup the interface with the advanced planning and scheduling software (APS): ORTEMS.
This setup is used to manage, through data files in the .csv format, the flows coming from and designed for ORTEMS.
This flows, concerning the Manufacturing module, are the following:
Flow X3 to ORTEMS:
- Work orders/operations
- Products
- Customers
- Projects
- Orders
Material tracking
- BOMs
- Purchasing
- Inventory
Resources
- Work center groups
- Work centers
- Work centers by work center group
- Replacement work centers
- Secondary resources
Flow ORTEMS to X3:
- Planning results
Once the setup carried out, the processing starts via the function: Start ORTEMS interface.
Prerequisite
Refer to documentation Implementation
Screen management
Entry screen
The setup consists in indicating:
- The pivot references giving the description of .csv files to export.
- The optimization margin
- The destination directory where the files designed to ORTEMS are indicated.
- The directory to check where the files to import coming from ORTEMS will be read.
- The storage directory where the processed files will be converted, after import.
- The directories necessary to start ORTEMS automatically when starting the interface processing and when integrating product files in ORTEMS.
Block number 1
Identifier (field ID) |
Identification code of the interface setup. |
field INTIT |
Pivots for export
Operations (field OPEPIT) |
Enter the pivot code describing the file lines of the Operations/WOs to export: EXPOF.csv. |
Products (field ITMPIT) |
Enter the pivot code describing the file lines of the Products to export: EXPITM.csv. |
Customers (field BPCPIT) |
Enter the pivot code describing the file lines of the Customersto export: SCMDBPC.csv. |
Projects (field PJTPIT) |
Enter the pivot code describing the file lines of the Projectsto export: EXPPJT.csv. |
Orders (field ORDPIT) |
Enter the pivot code describing the file lines of the Orders to export: EXPSOH.csv. |
BOMs (field BOMPIT) |
Enter the pivot code describing the file lines of the BOMs to export: EXPBOM.csv. |
Grouping (field GRUBOMFLG) |
This indicator is activated to specify that all material requirements of a WO must be grouped by product: the quantities required for all the WO operations will be added to the first operation of the WO requiring this product. |
Purchasing (field POFPIT) |
Enter the pivot code describing the file lines of the Purchasing to export: EXPPUR.csv. |
Stock (field STOPIT) |
Enter the pivot code describing the file lines of the Stocks to export: EXPSTO.csv. |
Work center groups (field TWCPIT) |
Work centers (field MWSPIT) |
Enter the pivot code describing the file lines of the work centers to export: EXPWST.csv. |
Work centers by group (field WSTPIT) |
Alternate work centers (field RPLPIT) |
Enter the pivot code describing the file lines of the replacement work centers to be exported: EXPWSTALT.csv. |
Secondary resources (field RSSPIT) |
Enter the pivot code describing the file lines of the Secondary resources to export: EXPBOM.csv. |
Optimization
Release margin (field WOMAR) |
This field is used to enter the margin to take into account in the calculation of the "earlier" start date. |
field FILJOUR1 |
Directories
Destination type (field TYPEXP) |
Index destination (field VOLFILISS) |
Directory to be scanned (field VOLFILRCP) |
Storage directory (field VOLFILSTO) |
APS
Planning leadtime (field ORTLTI) |
Enter the planning lead-time in days in order to calculate on the interface launch screen the horizon end date from the start date entered on the launch screen. |
field FILJOUR2 |
Principles of functioning
The interface processing is carried out via the .csv files.
General information on the files
- The files are DOS files (end of line characters: \013\010 or \r\n).
- Format: .csv
- Type: ASCII (can be modified by entry point, see below)
- The fields have a variable length with separators ";" (can be modified by entry point, see below)
- The numbers have as decimal separator: the point.
- The dates are entered under the "YYYYMMDDHHmm" or "YYYYMMDD" forms
- The durations are expressed in hours
- The Booleans can either take the value: 0 (false, or 1 (true)
- The files display standard headers (column names = pivot field code)
- For the Sage X3 flows to ORTEMS, the description of each file line is given by a Pivot specifying the fields order, their size and describing their loading (directly via table fields or via functions).
The files name, their description and the pivots used by default are indicated below.
- For the ORTEMS flows to Sage X3, the import is carried out by reading a fixed file that cannot be set up.
Export flow: X3 --- ORTEMS
Expected files |
|
Default |
Work orders/operations |
ORTOPE |
|
Products |
ORTITM |
|
Customers |
ORTBPC |
|
Projects |
ORTPJT |
|
Orders |
ORTSOH |
|
|
Material tracking files: |
|
BOMs |
ORTBOM |
|
Inventory |
ORTSTO |
|
Purchasing |
ORTPUR |
|
Resource files: |
|
|
Work stations |
ORTWST |
|
Work center groups |
ORTWCR |
|
Work centers by work center group (resources matrix) |
ORTWSTWCR |
|
Replacement work centers |
ORTWSTALT |
|
|
Secondary resource files: |
|
Secondary resources |
ORTRSS |
Import flows: ORTEMS --- X3
Expected files |
|
Pivot |
Planning results |
No pivot |
This file is fixed and cannot be set up via a pivot.
Entry points
The PIVOTSFILE entry point of the CONNECTFCT processing is used to modify the files coding and the column separator.
Description of the exported files from Sage X3
- WO/Operations: EXPOF.csv
- Products: EXPITM.csv
- Customers: EXPBPC.csv
- Projects: EXPPJT.csv
- Orders: EXPSOH.csv
- BOMs: EXPBOM.csv
- Stock: EXPSTO.csv
- Purchasing: EXPPUR.csv
- Work stations/Machines: EXPWST.csv
- Work center groups: EXPWCR.csv
- Work centers by work center group: EXPWSTWCR.csv
- Replacement work stations: EXPWSTALT.csv
- Secondary resources: EXPRSS.csv
WO/Operations: EXPOF.csv
Pivot: ORTOPE
File |
No. |
Title |
Type |
Optional |
Pivot |
Table code |
Field code |
Title |
Field |
|
1 |
WO number |
A |
No |
|
OPERATIONS |
MFGNUM |
Order no. |
No |
|
2 |
WO description |
A |
Yes |
|
MFGITM |
MFGDES |
WO description |
No |
|
3 |
WO status (1) |
N |
Yes |
|
OPERATIONS |
OPSSTA |
Order status |
No |
|
4 |
Priority (2) |
N |
Yes |
|
MFGHEAD |
MFGPIO |
Priority |
No |
|
5 |
Product code |
A |
No |
|
MFGITM |
ITMREF |
Product |
No |
|
6 |
Remaining quantity |
N |
No |
|
MFGOPE |
EXTQTY |
Planned quantity |
No |
|
7 |
Operation status (3) |
N |
No |
|
OPERATIONS |
OPESTA |
Operation status |
No |
|
|
|
|
|
|
OPERATIONS |
WFICTRTDAT |
|
Yes |
|
8 |
Reconciliation date (file extraction) |
DH |
No |
|
OPERATIONS |
WDHFIC |
|
No |
|
9 |
Unit |
A |
Yes |
|
ITMMASTER |
STU |
Stock unit |
No |
|
10 |
WO end lead-times |
D |
No |
|
MFGHEAD |
OBJDAT |
Initial objective |
No |
|
11 |
Customer code |
A |
Yes |
|
OPERATIONS |
WCLI |
|
No |
|
12 |
Project code |
A |
Yes |
|
MFGITM |
PJT |
Project |
No |
|
13 |
Order code |
A |
Yes |
|
MFGITM |
VCRNUMORI |
Original journal |
No |
|
14 |
Operation number |
N |
No |
|
OPERATIONS |
OPENUM |
Operation |
No |
|
15 |
Operation title |
A |
Yes |
|
OPERATIONS |
WDES |
|
No |
|
16 |
Work center (Workshop) |
A |
No |
|
OPERATIONS |
WCR |
|
No |
|
17 |
Main work center (4) |
A |
No |
|
OPERATIONS |
EXTWST |
Planned work station |
No |
|
18 |
Type of Process Time (5) |
N |
No |
|
OPERATIONS |
PROTIMTYP |
No |
|
|
19 |
Process time |
N |
No |
|
OPERATIONS |
EXTOPETIM |
Planned op. time |
No |
|
20 |
X3 setting time (6) |
N |
Yes |
|
OPERATIONS |
EXTSETTIM |
Planned setting time |
No |
|
21 |
Preparation time (7) |
N |
Yes |
|
OPERATIONS |
PRPTIM |
Picking time |
No |
|
22 |
Wait or move time (8) |
N |
Yes |
|
OPERATIONS |
PSPTIM |
Post operating time |
No |
|
23 |
Overlapping in % (9) |
N |
No |
|
OPERATIONS |
WLNKTIM |
|
No |
|
24 |
Overlapping code (10) |
N |
No |
|
OPERATIONS |
WLNKTYP |
|
No |
|
25 |
Grouping code (11) |
A |
Yes |
|
OPERATIONS |
SCHGRP |
Grouping criteria |
No |
|
26 |
Operator secondary Constraint |
A |
Yes |
|
MFGOPE |
EXTLAB |
Planned labor work center |
No |
|
27 |
Operators No. |
N |
Yes |
|
MFGOPE |
EXTLABNBR |
Planned labor number |
No |
|
28 |
% operator use |
N |
Yes |
|
MFGOPE |
OPELABCOE |
Operation labor time coefficients |
No |
|
29 |
Tool secondary constraint |
A |
Yes |
|
MFGOPE |
EQUNUM |
Tools |
No |
|
30 |
Tools no. |
N |
Yes |
|
MFGOPE |
WEQUNBR |
|
No |
|
31 |
% tools use |
N |
Yes |
|
MFGOPE |
WEQUPER |
|
No |
|
32 |
Earliest start date (12) |
D |
yes |
|
MFGHEAD |
STRDAT |
|
No |
(1) 1 = Firm, 2 = Planned, 3 = Suggested
(2) 1 = Normal, 2 = Urgent, 3 = Very urgent.
(3) 1 = Pending, 2 = Previous in progress, 3 = Previous paid, 4 = In progress.
(4) the alternative work centers are given via the alternative work centers file.
(5) 1 = unitary time, 2 = global time.
(6) Setting time: can be reduced thanks to the grouping code (11) if 2 operations having the same grouping code follow one another.
(7) Added to the previous operation wait time.
(8) The longest time between the move and wait times set up on the operation.
(9) 100% = no overlapping
(10) 1 = start - start = synchro at start, 2 = successor = no overlapping, 3 = end - end = synchro at the end, 4 = WO synchro
The overlapping code and the overlapping % on an operation indicate the position of the next operation. So the overlapped operation has the code 1 and the overlapping %.
The overlapping code 4 is contained in the concerned operation, it indicates that the operation has to start at the same moment as the WO first operation.
(11) The grouping code is used to optimize the setting time if 2 operations having the same grouping code follow one another.
(12) Earliest date for the WO = Date of the WO objective - production lead-time - release margin. If later than WO start, then = WO start date - margin.
Notes:
- All the times are expressed in hours.
- The operations paid are not exported.
- The WOs are not exported if all the WO operations are paid.
- The number of work centers used must be set to 1 on the range operations for a multi-resource work center.
- The labor work centers always have an infinite capacity.
Products: EXPITM.csv
Pivot: ORTITM
File |
No. |
Title |
Type |
Optional |
Pivot |
Table code |
Field code |
Title |
Field |
|
1 |
Product code |
A |
No |
|
MFGITM |
ITMREF |
Product |
No |
|
2 |
Description 1 |
A |
Yes |
|
ITMMASTER |
ITMDES1 |
Description 1 |
No |
|
3 |
Description 2 |
A |
Yes |
|
ITMMASTER |
ITMDES2 |
Description 2 |
No |
|
4 |
Description 3 |
A |
Yes |
|
ITMMASTER |
ITMDES3 |
Description 3 |
No |
|
5 |
Product category |
A |
Yes |
|
ITMMASTER |
TCLCOD |
Category |
No |
|
6 |
Attribute 1 |
A |
Yes |
|
ITMMASTER |
ATT1 |
|
No |
|
7 |
Attribute 2 |
A |
Yes |
|
ITMMASTER |
ATT2 |
|
No |
|
8 |
Attribute 3 |
A |
Yes |
|
ITMMASTER |
ATT3 |
|
No |
|
9 |
Attribute 4 |
A |
Yes |
|
ITMMASTER |
ATT4 |
|
No |
|
10 |
Attribute 5 |
A |
Yes |
|
ITMMASTER |
ATT5 |
|
No |
Notes:
- The attributes are appropriate fields but they are not loaded in the standard. They can be set up to transmit additional information.
Customers: EXPBPC.csv
Pivot: ORTBPC
File |
No. |
Title |
Type |
Optional |
Pivot |
Table code |
Field code |
Title |
Field |
|
1 |
Customer code |
A |
No |
|
BPCUSTOMER |
BPCNUM |
Customer |
No |
|
2 |
Customer name |
A |
Yes |
|
BPCUSTOMER |
BPCNAM |
Corporate name |
No |
|
3 |
Postcode |
A |
Yes |
|
BPADDRESS |
POSCOD |
Postcode |
No |
|
4 |
Town/city |
A |
Yes |
|
BPADDRESS |
CTY |
Town/city |
No |
|
5 |
Contact number |
A |
Yes |
|
BPCUSTOMER |
CNTNAM |
Default contact |
No |
|
6 |
Contact's phone no. |
A |
Yes |
|
CONTACT |
TEL |
Telephone |
No |
|
7 |
Email address |
A |
Yes |
|
CONTACT |
WEB |
|
No |
Note:
- They are the exported WO clients.
Projects: EXPPJT.csv
Pivot: ORTPJT
File |
No. |
Title |
Type |
Optional |
Pivot |
Table code |
Field code |
Title |
Field |
|
1 |
Project code |
A |
No |
|
OPPOR |
OPPNUM |
Project chrono |
No |
|
2 |
Project description |
A |
Yes |
|
OPPOR |
OPPDES |
Project description |
No |
Note:
- They are the exported WO projects.
Orders: EXPSOH.csv
Pivot: ORTSOH
File |
No. |
Title |
Type |
Optional |
Pivot |
Table code |
Field code |
Title |
Field |
|
1 |
Order code |
A |
No |
|
SORDER |
SOHNUM |
Order no. |
No |
|
2 |
Order description |
A |
Yes |
|
SORDER |
WDES |
|
No |
Note:
- They are the exported WO orders.
BOMs: EXPBOM.csv
Pivot: ORTBOM
File |
No. |
Title |
Type |
Optional |
Pivot |
Table code |
Field code |
Title |
Field |
|
1 |
WO number |
A |
No |
|
ORDERS |
VCRNUM |
Journal |
No |
|
2 |
Product reference |
A |
No |
|
ORDERS |
ITMREF |
Product |
No |
|
3 |
Quantity |
N |
No |
|
ORDERS |
RMNEXTQTY |
Remaining quantity |
No |
|
4 |
Operation number |
N |
No |
|
ORDERS |
VCRSEQ |
Document sequence no. |
No |
Notes:
- It is possible that the same product is necessary for different operations. The duplicates on WO/Product are not managed in ORTEMS, a flag in the setup is used to group all the material needs of a WO by product: the quantities required for all the WO operations will be added to the first operation of the WO requiring this product.
Stock: EXPSTO.csv
Pivot: ORTSTO
File |
No. |
Title |
Type |
Optional |
Pivot |
Table code |
Field code |
Title |
Field |
|
1 |
Product code |
A |
No |
|
ITMMVT |
ITMREF |
Product |
No |
|
2 |
Inventory or extraction date |
D |
No |
|
ITMMVT |
WDATSTO |
|
No |
|
3 |
Quantity in stock |
N |
Yes |
|
ITMMVT |
PHYSTO |
'A' internal stock |
No |
|
4 |
Replenishment lead-time (1) |
N |
Yes |
|
ITMFACILIT |
OFS |
Reorder lead-time |
No |
(1) the replenishment lead-time is expressed in days.
Purchasing: EXPPUR.csv
Pivot: ORTPUR
File |
No. |
Title |
Type |
Optional |
Pivot |
Table code |
Field code |
Title |
Field |
|
1 |
Purchase order no. |
A |
No |
|
ORDERS |
VCRNUM |
Journal |
No |
|
2 |
Product reference |
A |
No |
|
ORDERS |
ITMREF |
Product |
No |
|
3 |
Ordered quantity |
N |
No |
|
ORDERS |
RMNEXTQTY |
Remaining quantity |
No |
|
4 |
Planned due date |
D |
No |
|
ORDERS |
ENDDAT |
End date |
No |
Work stations/Machines: EXPWST.csv
Pivot: ORTWST
File |
No. |
Title |
Type |
Optional |
Pivot |
Table code |
Field code |
Title |
Field |
|
1 |
Code |
A |
No |
|
WORKSTATIO |
WST |
Work centre |
No |
|
2 |
Description |
A |
Yes |
|
WORKSTATIO |
WSTDES |
Work center title |
No |
|
3 |
Type (1) |
A |
Yes |
|
WORKSTATIO |
WSTTYP |
Work center type |
No |
|
4 |
Efficiency (2) |
N |
Yes |
|
WORKSTATIO |
EFF |
Efficiency in % |
No |
|
5 |
Finished or Infinite? (3) |
B |
Yes |
|
WORKSTATIO |
CONSTRAINT |
Valuation dimension |
No |
|
6 |
Dimension |
A |
Yes |
|
WORKSTATIO |
VLTCCE |
|
No |
(1) 1 = Machine, 2 = MO, 3 = Sub-contracting.
(2) If not entered, the value is set by default on 100%.
(3) If this value is not entered in the file, it should be done manually in the ORTEMS table; it must follow the rule: 0 = Infinite, 1 = Finished.
Notes:
- The work centers must have a resource number set to 1.
Work center groups: EXPWCR.csv
Pivot: ORTWCR
File |
No. |
Title |
Type |
Optional |
Pivot |
Table code |
Field code |
Title |
Field |
|
1 |
Code |
A |
No |
|
TABWRKCTR |
WCR |
Work centre group |
No |
|
2 |
Description |
A |
Yes |
|
TABWRKCTR |
WCRDES |
Center title |
No |
Notes:
- This file contains the list of work center groups.
The work center groups all the resources that belong to the same workshop. However, it has no technical meaning. In order to determine the list of possible resources for a given operation, ORTEMS uses the main work station of the range and alternative work stations included in the Work stations file.
Work centers by work center group: EXPWSTWCR.csv
Pivot: ORTWSTWCR
File |
No. |
Title |
Type |
Optional |
Pivot |
Table code |
Field code |
Title |
Field |
|
1 |
Work center code |
A |
No |
|
WORKSTATIO |
WCR |
Work centre group |
No |
|
2 |
Work station code |
A |
No |
|
WORKSTATIO |
WST |
Work centre |
No |
Notes:
- This file contains the list of resources by work center.
- Each work center is duplicated for each workstation that belongs to it. A work station can belong to several work centers.
- The extraction is carried out on one single site, so there will only be one work center group by work center.
Replacement work stations: EXPWSTALT.csv
Pivot: ORTWSTALT
File |
No. |
Title |
Type |
Optional |
Pivot |
Table code |
Field code |
Title |
Field |
|
1 |
Main work station code |
A |
No |
|
RPLWST |
WST |
Work centre |
No |
|
|
|
|
|
|
RPLWST |
I |
|
Yes |
|
2 |
Alternative work station code |
A |
Yes |
|
RPLWST |
RPLWST |
Replacement work center |
No |
Secondary resources: EXPRSS.csv
Pivot: ORTRSS
File |
No. |
Title |
Type |
Optional |
Pivot |
Table code |
Field code |
Title |
Field |
|
1 |
Code |
A |
No |
|
WORKSTATIO |
WST |
Work centre |
No |
|
2 |
Description |
A |
Yes |
|
WORKSTATIO |
WSTDES |
Work center title |
No |
|
3 |
Type (1) |
A |
No |
|
WORKSTATIO |
WSTTYP |
Work center type |
No |
|
4 |
Number of copies (2) |
N |
Yes |
|
WORKSTATIO |
WSTNBR |
Number of work centers |
No |
(1) Resource type: 2 = Operator, 3 = Tools
(2) concerning the tools, the number of resources is not known in Sage X3 and will be managed in ORTEMS.
Description of the file imported in Sage X3
Planning results: OrdersOut.csv
No. |
Title |
Type |
Optional |
1 |
WO number |
A |
No |
2 |
Operation number |
N |
No |
3 |
Work station |
A |
No |
4 |
Picking start date |
DH |
No |
5 |
Setup start date |
DH |
No |
6 |
Process end date |
DH |
No |
7 |
Wait end date (1) |
DH |
No |
(1) Wait end date: this time is never planned but must be taken into account. It is a non-productive time. It is possible to use the start date of the next operation except for the last one, for which it will be possible to take the WO end date.
Notes:
- this file is a fixed .csv file, and cannot be setup via a pivot.
- It contains the planning results, i.e. the start and end dates of each operation.