Skip to Content
Version 43.3 by Luca de Laat on 2024/04/10 11:46
Show last authors
1 = Creating a Delivery file and binding them to a customer =
2
3 This chapter contains the information needed to understand the lab delivery file. A Lab delivery file only has to be updated when there are changes. Otherwise, TerraIndex will always show the last imported file.
4
5 {{warning}}
6 Latest version can be found here: [[https:~~/~~/www.sikb.nl/datastandaarden/sikb0101-bodembeheer>>url:https://www.sikb.nl/datastandaarden/sikb0101-bodembeheer]]
7 {{/warning}}
8
9 == What is a lab delivery file? ==
10
11 A lab delivery file contains the Customer code of the customer that will be sending the lab assignment. It also contains the analyses that can be requested from the lab by the customer. A Lab delivery file needs to be custom for every user and needs to be a XML file. This file will be available for the customer to choose their options for requesting and ordering an analysis at the lab. It's the Menu-card of the Lab, the user can choose from.
12
13 **Example files**:  [[attach:Labdeliveryfile.xml||rel="noopener noreferrer" target="_blank"]]
14
15 **XSD**:  [[attach:LabDelivery_v14.8.0.xsd||rel="noopener noreferrer" target="_blank"]]
16
17 **Domaintable files**:  [[immetingen lookup v14.8.0.xml>>url:https://wiki.terraindex.com/bin/download/Implementation%20documentation/Setting%20up%20Lab%20communication%20by%20REST%20services%20with%20TerraIndex/Lab%20assignment%20file/WebHome/immetingen%20lookup%20v14.8.0.xml?rev=1.2]]   [[imsikb0101 lookup v14.8.0.xml>>url:https://wiki.terraindex.com/bin/download/Implementation%20documentation/Setting%20up%20Lab%20communication%20by%20REST%20services%20with%20TerraIndex/Lab%20assignment%20file/WebHome/imsikb0101%20lookup%20v14.8.0.xml?rev=1.1]]
18 extracted from: **[[https:~~/~~/codes.sikb.nl>>url:https://codes.sikb.nl/]] **
19
20 {{toc/}}
21
22
23 ~==> nle Add field Certification (screen 1 of labassignment)
24
25 == File structure ==
26
27 In the image below the main structure of the XML file is shown. Every table is described in more detail later on in this chapter.
28
29 ~==> nle Dutch text in screenshot
30 [[image:1712158795900-531.png||height="604" width="391"]]
31
32 (% class="table-hover" %)
33 |(% colspan="1" rowspan="1" %)**Attribute name**|(% colspan="1" rowspan="1" %)**Description**|(% colspan="1" rowspan="1" %)**Unit**
34 |(% colspan="1" rowspan="1" %)**version**|(% colspan="1" rowspan="1" %)SIKB version. This must be: **14.8.0**|(% colspan="1" rowspan="1" %)string
35 |(% colspan="1" %)**versionDeliveryData**|(% colspan="1" %)A lab indication of the version of the delivered data for this user. Could be a generation date with version: '12-7-2024' or a version 'v12.1'|(% colspan="1" %)string
36 |(% colspan="1" rowspan="1" %)**laboratory**|(% colspan="1" rowspan="1" %)A number given by SIKB/TerraIndex to the lab when requesting to connect to TerraIndex
37 [[Domaintable: Meetinstantie>>https://codes.sikb.nl/tablet/domain-table-details/4e270f0a-cefe-446e-9d4d-6666c91180a8]]|(% colspan="1" rowspan="1" %)integer
38 |(% colspan="1" rowspan="1" %)**language**|(% colspan="1" rowspan="1" %)(((
39 The language of the Delivery file content, like the package names, urgencies etc, in a three-letter ISO-639-2 code:
40
41 - dut = Dutch
42 - eng = English
43 - fra = French
44 - spa = Spanish
45 - ita = Italian
46 - deu = German
47 )))|(% colspan="1" rowspan="1" %)string
48 |(% colspan="1" rowspan="1" %)**Links**|(% colspan="1" rowspan="1" %)A table to connect the “AnalysisSet” and the “Clients”|(% colspan="1" rowspan="1" %)-
49 |(% colspan="1" rowspan="1" %)**AnalysisSets**|(% colspan="1" rowspan="1" %)A table containing the name and lab code of analysis set|(% colspan="1" rowspan="1" %)-
50 |(% colspan="1" rowspan="1" %)**Categories**|(% colspan="1" rowspan="1" %)A table containing all the possible lab categories|(% colspan="1" rowspan="1" %)-
51 |(% colspan="1" rowspan="1" %)**AnalysisLinks**|(% colspan="1" rowspan="1" %)A table containing all the analyses for an analysis set|(% colspan="1" rowspan="1" %)-
52 |(% colspan="1" rowspan="1" %)**Clients**|(% colspan="1" rowspan="1" %)A table of all the customer codes that are available for the company|(% colspan="1" rowspan="1" %)-
53 |(% colspan="1" rowspan="1" %)**LabSampleMatrices**|(% colspan="1" rowspan="1" %)A table of all the Lab sample Matrices a lab would like to have selectable.|(% colspan="1" rowspan="1" %)-
54 |(% colspan="1" rowspan="1" %)**SpecialAppointments**|(% colspan="1" rowspan="1" %)A table of all the special price agreements besides the default quote.|(% colspan="1" %)-
55 |(% colspan="1" rowspan="1" %)**Urgencies**|(% colspan="1" rowspan="1" %)A table containing a list of time frames in which the lab results need to be returned|(% colspan="1" %)-
56 |(% colspan="1" rowspan="1" %)//StoragePeriods//|(% colspan="1" rowspan="1" %)-not in use-|(% colspan="1" rowspan="1" %)
57 |(% colspan="1" rowspan="1" %)//Reports//|(% colspan="1" rowspan="1" %)-not in use-|(% colspan="1" rowspan="1" %)
58 |(% colspan="1" rowspan="1" %)//FractionLinks//|(% colspan="1" rowspan="1" %)-not in use-|(% colspan="1" rowspan="1" %)
59
60 == Structure explanation AnalysisSets ==
61
62 This table contains all the analyses sets or packages that your lab supports. The “AnalysisSetId” is your own identification code for the analysis packages.
63
64 It will be the chosen analysis and name, showed in the interface of TerraIndex:
65 \\[[image:1712163759805-731.png]]
66
67 [[image:1712163688142-709.png||height="443" width="599"]]
68
69 (% class="table-hover" %)
70 |(% colspan="1" rowspan="1" %)**Attribute name**|(% colspan="1" rowspan="1" %)**Description**|(% colspan="1" rowspan="1" %)**Unit**
71 |(% colspan="1" rowspan="1" %)**AnalysisSetId**|(% colspan="1" rowspan="1" %)The identification code of the lab for the analyses Set or package|(% colspan="1" rowspan="1" %)string
72 |(% colspan="1" rowspan="1" %)**Description**|(% colspan="1" rowspan="1" %)The name/description of the analysis content of the set (This will also be shown in the user interface)|(% colspan="1" rowspan="1" %)string
73 |(% colspan="1" rowspan="1" %)//Sequence//|(% colspan="1" rowspan="1" %)-not in use-|(% colspan="1" rowspan="1" %)string
74 |(% colspan="1" rowspan="1" %)//MinimalDeliveryTime//|(% colspan="1" rowspan="1" %)-not in use-|(% colspan="1" rowspan="1" %)string
75
76 == Structure explanation Categories ==
77
78 “Category” does not need a lot of explanation. A category is a group defined by the lab where certain values in the “koppeltabel” can be grouped under. A category is determined by the lab and can be used in the “Links”.
79
80 In TerraIndex, it will be shown as Header/Group:
81 [[image:1712162927138-349.png]]
82
83
84 [[image:1712162765631-966.png||height="504" width="609"]]
85
86
87 (% class="table-hover" %)
88 |(% colspan="1" rowspan="1" %)**Attribute name**|(% colspan="1" rowspan="1" %)**Description**|(% colspan="1" rowspan="1" %)**Unit**
89 |(% colspan="1" rowspan="1" %)**CategorieId**|(% colspan="1" rowspan="1" %)The code/Id of the category or group given by the lab|(% colspan="1" rowspan="1" %)string
90 |(% colspan="1" rowspan="1" %)**Description**|(% colspan="1" rowspan="1" %)The name/description of the category (This will also be shown in the user interface)|(% colspan="1" rowspan="1" %)string
91 |(% colspan="1" rowspan="1" %)**Sequence**|(% colspan="1" rowspan="1" %)Field is redundant and does not have to be filled|(% colspan="1" rowspan="1" %)integer
92
93 == Structure explanation AnalysisLink and Analysis ==
94
95 This table contains all the analyses that an analysis package can contain. Be sure the “analysepakketcode” corresponds to a code in the table: “analysepakketten”. The analysecode is your own identification code for the analyses.
96 \\[[image:1712163145392-331.png]]
97 \\[[image:1712163459761-326.png||height="488" width="799"]]
98
99 (% class="table-hover" %)
100 |(% colspan="1" rowspan="1" %)**Attribute name**|(% colspan="1" rowspan="1" %)**Description**|(% colspan="1" rowspan="1" %)**Unit**
101 |(% colspan="1" rowspan="1" %)**AnalysisSetId**|(% colspan="1" rowspan="1" %)The analysis set code that corresponds to a code in the “//AnalysisSets//”|(% colspan="1" rowspan="1" %)string
102 |(% colspan="1" rowspan="1" %)**Analysis**|(% colspan="1" rowspan="1" %)A table containing all the analyses that should be in this analysis set or package|(% colspan="1" rowspan="1" %)-
103
104 === __Analysis__ ===
105
106 (% class="table-hover" %)
107 |(% colspan="1" rowspan="1" %)**Attribute name**|(% colspan="1" rowspan="1" %)**Description**|(% colspan="1" rowspan="1" %)**Unit**
108 |(% colspan="1" rowspan="1" %)**AnalysisId**|(% colspan="1" rowspan="1" %)The identification code of the lab for the analyses|(% colspan="1" rowspan="1" %)string
109 |(% colspan="1" rowspan="1" %)**Description**|(% colspan="1" rowspan="1" %)The name/description of the analysis content of the set (This will also be shown in the user interface)|(% colspan="1" rowspan="1" %)string
110 |(% colspan="1" rowspan="1" %)//MinimalDeliveryTime//|(% colspan="1" rowspan="1" %)-not in use-|(% colspan="1" rowspan="1" %)string
111 |(% colspan="1" rowspan="1" %)//Observation//|(% colspan="1" rowspan="1" %)-not in use-|(% colspan="1" rowspan="1" %)
112
113 == Structure explanation Clients ==
114
115 A customer can have multiple “clients”. There always needs to be one “client” so that a lab assignment can be sent. But for example, when there is a price agreement for a certain project, a new “Client” can be added. Or when a company has multiple offices, every office can have its own “Client”.
116 \\It will be shown in the interface of TerraIndex, and needs to be chosen before selecting analysis sets:
117 [[image:1712163957735-690.png]]
118 \\[[image:1712163986350-364.png||height="409" width="544"]]
119
120 |(% colspan="1" rowspan="1" %)**Attribute name**|(% colspan="1" rowspan="1" %)**Description**|(% colspan="1" rowspan="1" %)**Unit**
121 |(% colspan="1" rowspan="1" %)**ClientId**|(% colspan="1" rowspan="1" %)The customer identification code(s) for the company or office|(% colspan="1" rowspan="1" %)string
122 |(% colspan="1" rowspan="1" %)**Description**|(% colspan="1" rowspan="1" %)The name\description of the customer code, as shown in the interface, and will be invoiced.|(% colspan="1" rowspan="1" %)string
123
124 == Structure explanation LabSampleMatrices ==
125
126 The “LabSampleMatrices” is an important section of the XML. The “matrix” defines the main type of sample for the lab, and can contain multiple or predefined additional pretreatments of preservatives. Without a sample type in this table, a customer will not be able to send in lab assignments to the laboratory.
127
128 It needs to be chosen in the interface of TerraIndex, before any analysis set can be chosen:
129 \\[[image:1712164314258-543.png]]
130
131
132 [[image:1712164255757-638.png||height="556" width="716"]]
133
134 (% class="table-hover" %)
135 |(% colspan="1" rowspan="1" %)**Attribute name**|(% colspan="1" rowspan="1" %)**Description**|(% colspan="1" rowspan="1" %)**unit**
136 |(% colspan="1" rowspan="1" %)**CompartimentId**|(% colspan="1" rowspan="1" %)An SIKB ID that determines to which matrix the analyses belongs.
137 Domaintable: [[Compartment/Matrix>>https://codes.sikb.nl/tablet/domain-table-details/6134f3bb-6048-431d-a130-01290d84172c]]|(% colspan="1" rowspan="1" %)int
138 |(% colspan="1" rowspan="1" %)//CompartimentCode//|(% colspan="1" rowspan="1" %)-not in use-|(% colspan="1" rowspan="1" %)
139 |(% colspan="1" rowspan="1" %)**LabSampleMatrixCode**|(% colspan="1" rowspan="1" %)The laboratory matrix- or compartment-code of the lab, that will be also be sent in the Labassignment to the lab|(% colspan="1" %)string
140 |(% colspan="1" rowspan="1" %)**Description**|(% colspan="1" rowspan="1" %)The name\description of the matrix or compartment of the lab, as shown in the interface.|(% colspan="1" rowspan="1" %)string
141
142 == Structure explanation SpecialAppointment ==
143
144 The “SpecialAppointment" contains the names of the price catalogs, the default quote or the special project quote. This way, extra discount options are possible. It will be sent in the labassignment to the lab.
145
146 It needs to be chosen in the interface of TerraIndex, before any analysis set can be chosen, and empty means 'default quote':
147
148 [[image:1712164853683-202.png]]
149
150 [[image:1712165258813-987.png||height="619" width="697"]]
151
152
153 (% class="table-hover" %)
154 |(% colspan="1" rowspan="1" %)**Attribute name**|(% colspan="1" rowspan="1" %)**Description**|(% colspan="1" rowspan="1" %)**unit**
155 |(% colspan="1" rowspan="1" %)**SpecialAppointmentId**|(% colspan="1" rowspan="1" %)An identifcation code from the lab that will be send in the Labassignment to the lab.|(% colspan="1" rowspan="1" %)string
156 |(% colspan="1" rowspan="1" %)**Description**|(% colspan="1" rowspan="1" %)The name\description of the matrix or compartment of the lab, as shown in the interface.|(% colspan="1" rowspan="1" %)string
157 |(% colspan="1" rowspan="1" %)//startdate//|(% colspan="1" rowspan="1" %)-not in use-|(% colspan="1" rowspan="1" %)
158 |(% colspan="1" rowspan="1" %)//finaldate//|(% colspan="1" rowspan="1" %)-not in use-|(% colspan="1" rowspan="1" %)
159 |(% colspan="1" rowspan="1" %)**AppointmentTypeCode**|(% colspan="1" rowspan="1" %)The  type of appointment, like: total pricelist, default quotation or special project agreement.
160 Domaintable: [[PriceAgreement Type>>https://codes.sikb.nl/tablet/domain-table-details/60028a8a-f386-47bf-bf2e-f46af49b7b56]]|(% colspan="1" rowspan="1" %)int
161
162 == Structure explanation Links ==
163
164 The “Links” is one of the most important sections of the XML. The “Link” defines the combination of Analysespackages, custerom/clientcode, categories and sampletype. Without a combination in this table a customer will not be able to send in lab assignments to the laboratory.
165 [[image:1712158823685-514.png||height="563" width="531"]]
166
167
168 (% class="table-hover" %)
169 |(% colspan="1" rowspan="1" %)**Attribute name**|(% colspan="1" rowspan="1" %)**Description**|(% colspan="1" rowspan="1" %)**unit**
170 |(% colspan="1" rowspan="1" %)**AnalysisSetId**|(% colspan="1" rowspan="1" %)The AnalysisSet code that corresponds to a code in the AnalysisSets table|(% colspan="1" rowspan="1" %)string
171 |(% colspan="1" rowspan="1" %)**ClientId**|(% colspan="1" rowspan="1" %)The code that corresponds to a code in Clients table|(% colspan="1" rowspan="1" %)string
172 |(% colspan="1" %)**SpecialAppointmentId**|(% colspan="1" %)The code that corresponds to a code in SpecialAppointments table|(% colspan="1" %)
173 |(% colspan="1" rowspan="1" %)**LabSampleMatrixCode**|(% colspan="1" rowspan="1" %)The code that corresponds to a code in LabSampleMatrix table|(% colspan="1" rowspan="1" %)(((
174 integer
175
176
177 )))
178 |(% colspan="1" %)Price|(% colspan="1" %)The optional Price indication for this combination of the Analysis|(% colspan="1" %)decimal
179 |(% colspan="1" %)CertificationId|(% colspan="1" %)The optional code that corresponds to the way of Sample and analysis handling as described in a certification.
180 Some other labs have this arragened by the LabSampleMatrix types.
181 Domaintable: [[CertificeringsCode >>https://codes.sikb.nl/tablet/domain-table-details/df7ffd7c-192c-44f7-ae9f-0461d9266b30]]|(% colspan="1" %)int
182 |(% colspan="1" rowspan="1" %)**CategoryId**|(% colspan="1" rowspan="1" %)The code that corresponds to a category code in Categories table|(% colspan="1" rowspan="1" %)string
183 |(% colspan="1" rowspan="1" %)//Accredited//|(% colspan="1" rowspan="1" %)-not in use-|(% colspan="1" rowspan="1" %)bool
184
185 == Structure explanation Urgencies ==
186
187 This table contains a list with different delivery times for analyses results. For example 5 work days, overnight, within 48 hours and so on. The “UrgencyId” is a code given by the lab.
188
189 [[image:1712324236054-772.png||height="372" width="511"]]
190
191 (% class="table-hover" %)
192 |(% colspan="1" rowspan="1" %)**Attribute name**|(% colspan="1" rowspan="1" %)**Description**|(% colspan="1" rowspan="1" %)**Unit**
193 |(% colspan="1" rowspan="1" %)**UrgencyId**|(% colspan="1" rowspan="1" %)The code of the lab for when the analysis results need to be returned to the customer|(% colspan="1" rowspan="1" %)string
194 |(% colspan="1" rowspan="1" %)**Description**|(% colspan="1" rowspan="1" %)The name/ description of the urgency, to show in the interface.|(% colspan="1" rowspan="1" %)string
195
196 == Structure explanation StoragePeriods ==
197
198 This table contains a list with different storage periods for the storage of the delivered Samples and it's containers. For example '1 month', '5 weeks', 'customer agreement' and so on. The “StroragePeriodId” is a code given by the lab.
199
200 [[image:1712324393233-546.png||height="359" width="519"]]
201
202 (% class="table-hover" %)
203 |(% colspan="1" rowspan="1" %)**Attribute name**|(% colspan="1" rowspan="1" %)**Description**|(% colspan="1" rowspan="1" %)**Unit**
204 |(% colspan="1" rowspan="1" %)**StoragePeriodId**|(% colspan="1" rowspan="1" %)The code of the lab for when the analysis results need to be returned to the customer|(% colspan="1" rowspan="1" %)string
205 |(% colspan="1" rowspan="1" %)**Description**|(% colspan="1" rowspan="1" %)The name/ description of the Storage Period, to show in the interface.|(% colspan="1" rowspan="1" %)string