Skip to Content
Last modified by Robin Huisman on 2024/12/18 14:57
From version 43.3
edited by Luca de Laat
on 2024/04/10 11:46
Change comment: There is no comment for this version
To version 36.2
edited by Robin Huisman
on 2024/04/03 19:29
Change comment: (Autosaved)

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.LucadeLaat
1 +XWiki.RobinHuisman
Content
... ... @@ -1,14 +1,14 @@
1 1  = Creating a Delivery file and binding them to a customer =
2 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.
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 4  
5 5  {{warning}}
6 6  Latest version can be found here: [[https:~~/~~/www.sikb.nl/datastandaarden/sikb0101-bodembeheer>>url:https://www.sikb.nl/datastandaarden/sikb0101-bodembeheer]]
7 7  {{/warning}}
8 8  
9 -== What is a lab delivery file? ==
9 +== What is a lab delivery file ==
10 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.
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 a lab by the customer. A Lab delivery file needs to be custom for every user and needs to be a XML file
12 12  
13 13  **Example files**:  [[attach:Labdeliveryfile.xml||rel="noopener noreferrer" target="_blank"]]
14 14  
... ... @@ -20,13 +20,9 @@
20 20  {{toc/}}
21 21  
22 22  
23 -~==> nle Add field Certification (screen 1 of labassignment)
24 -
25 25  == File structure ==
26 26  
27 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 30  [[image:1712158795900-531.png||height="604" width="391"]]
31 31  
32 32  (% class="table-hover" %)
... ... @@ -53,9 +53,9 @@
53 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 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 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" %)
52 +|(% colspan="1" rowspan="1" %)StoragePeriods|(% colspan="1" rowspan="1" %)-not in use-|(% colspan="1" rowspan="1" %)
53 +|(% colspan="1" rowspan="1" %)Reports|(% colspan="1" rowspan="1" %)-not in use-|(% colspan="1" rowspan="1" %)
54 +|(% colspan="1" rowspan="1" %)FractionLinks|(% colspan="1" rowspan="1" %)-not in use-|(% colspan="1" rowspan="1" %)
59 59  
60 60  == Structure explanation AnalysisSets ==
61 61  
... ... @@ -64,24 +64,24 @@
64 64  It will be the chosen analysis and name, showed in the interface of TerraIndex:
65 65  \\[[image:1712163759805-731.png]]
66 66  
67 -[[image:1712163688142-709.png||height="443" width="599"]]
63 +[[image:1712163688142-709.png||height="580" width="784"]]
68 68  
69 69  (% class="table-hover" %)
70 70  |(% colspan="1" rowspan="1" %)**Attribute name**|(% colspan="1" rowspan="1" %)**Description**|(% colspan="1" rowspan="1" %)**Unit**
71 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 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
69 +|(% colspan="1" rowspan="1" %)Sequence|(% colspan="1" rowspan="1" %)-not in use-|(% colspan="1" rowspan="1" %)string
70 +|(% colspan="1" rowspan="1" %)MinimalDeliveryTime|(% colspan="1" rowspan="1" %)-not in use-|(% colspan="1" rowspan="1" %)string
75 75  
76 76  == Structure explanation Categories ==
77 77  
78 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 79  
80 -In TerraIndex, it will be shown as Header/Group:
76 +In TerraIndex it will be showed as Header/Group:
81 81  [[image:1712162927138-349.png]]
82 82  
83 83  
84 -[[image:1712162765631-966.png||height="504" width="609"]]
80 +[[image:1712162765631-966.png]]
85 85  
86 86  
87 87  (% class="table-hover" %)
... ... @@ -92,14 +92,14 @@
92 92  
93 93  == Structure explanation AnalysisLink and Analysis ==
94 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.
91 +This table contains all the analyses that a analyses 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 96  \\[[image:1712163145392-331.png]]
97 -\\[[image:1712163459761-326.png||height="488" width="799"]]
93 +\\[[image:1712163459761-326.png]]
98 98  
99 99  (% class="table-hover" %)
100 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" %)-
97 +|(% colspan="1" rowspan="1" %)**AnalysisSetId**|(% colspan="1" rowspan="1" %)The analyse set code that corresponds to a code in the “//AnalysisSets//”|(% colspan="1" rowspan="1" %)string
98 +|(% colspan="1" rowspan="1" %)**Analysis**|(% colspan="1" rowspan="1" %)A table containing ale the analyses that should be in this analysis set or package|(% colspan="1" rowspan="1" %)-
103 103  
104 104  === __Analysis__ ===
105 105  
... ... @@ -107,99 +107,83 @@
107 107  |(% colspan="1" rowspan="1" %)**Attribute name**|(% colspan="1" rowspan="1" %)**Description**|(% colspan="1" rowspan="1" %)**Unit**
108 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 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" %)
106 +|(% colspan="1" rowspan="1" %)MinimalDeliveryTime|(% colspan="1" rowspan="1" %)-not in use-|(% colspan="1" rowspan="1" %)string
107 +|(% colspan="1" rowspan="1" %)Observation|(% colspan="1" rowspan="1" %)-not in use-|(% colspan="1" rowspan="1" %)
112 112  
113 113  == Structure explanation Clients ==
114 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”.
111 +A customer can have multiple “clients”. There always needs to be one “client” so that a lab assignment can be send. 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 116  \\It will be shown in the interface of TerraIndex, and needs to be chosen before selecting analysis sets:
117 117  [[image:1712163957735-690.png]]
118 -\\[[image:1712163986350-364.png||height="409" width="544"]]
114 +\\[[image:1712163986350-364.png]]
119 119  
120 120  |(% colspan="1" rowspan="1" %)**Attribute name**|(% colspan="1" rowspan="1" %)**Description**|(% colspan="1" rowspan="1" %)**Unit**
121 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
118 +|(% colspan="1" rowspan="1" %)**Description**|(% colspan="1" rowspan="1" %)De name\description of the customer code, as shown in the interface and will be invoiced.|(% colspan="1" rowspan="1" %)string
123 123  
124 124  == Structure explanation LabSampleMatrices ==
125 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.
122 +The “LabSampleMatrices” is an important sections of the XML. The “matrix” defines the main type of sample for the lab, and can contain multiple or prefined additional pretreatments of preservations. Without a sample type in this table a customer will not be able to send in lab assignments to the laboratory.
127 127  
128 128  It needs to be chosen in the interface of TerraIndex, before any analysis set can be chosen:
129 129  \\[[image:1712164314258-543.png]]
130 130  
131 131  
132 -[[image:1712164255757-638.png||height="556" width="716"]]
128 +[[image:1712164255757-638.png]]
133 133  
134 134  (% class="table-hover" %)
135 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.
132 +|(% colspan="1" rowspan="1" %)**CompartimentId**|(% colspan="1" rowspan="1" %)An SIKB ID that determins to which matrix the analyses belongs.
137 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
134 +|(% colspan="1" rowspan="1" %)CompartimentCode|(% colspan="1" rowspan="1" %)-not in use-|(% colspan="1" rowspan="1" %)
135 +|(% colspan="1" rowspan="1" %)**LabSampleMatrixCode**|(% colspan="1" rowspan="1" %)The laboratory matrix- or compartment-code of the lab, that will be also be send in the Labassignment to the lab|(% colspan="1" %)string
136 +|(% colspan="1" rowspan="1" %)**Description**|(% colspan="1" rowspan="1" %)De name\description of the matrix or compartment of the lab, as shown in the interface.|(% colspan="1" rowspan="1" %)string
141 141  
142 142  == Structure explanation SpecialAppointment ==
143 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.
140 +The “SpecialAppointment" contains the names of the price catalogus, the default quote or the special project quote. This way extra discount options are possible.
145 145  
146 -It needs to be chosen in the interface of TerraIndex, before any analysis set can be chosen, and empty means 'default quote':
142 +It needs to be chosen in the interface of TerraIndex, before any analysis set can be chosen, and empty mw:
147 147  
148 148  [[image:1712164853683-202.png]]
149 149  
150 -[[image:1712165258813-987.png||height="619" width="697"]]
146 +[[image:1712165258813-987.png]]
151 151  
152 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 161  
150 +
151 +
152 +(% class="wikigeneratedid" %)
162 162  == Structure explanation Links ==
163 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.
155 +The “Links” is one of the most important sections of the XML. The “koppeltabel” defines the combination of Analysespackages, custeromcode, categories and sampletype. Without a combination in this table a customer will not be able to send in lab assignments to the laboratory.
165 165  [[image:1712158823685-514.png||height="563" width="531"]]
166 166  
167 167  
168 168  (% class="table-hover" %)
169 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" %)(((
161 +|(% colspan="1" rowspan="1" %)**Analysepakketcode**|(% colspan="1" rowspan="1" %)The analysepackagecode that corresponds to a code in the analysepakket|(% colspan="1" rowspan="1" %)string
162 +|(% colspan="1" rowspan="1" %)**klantcode**|(% colspan="1" rowspan="1" %)A code that corresponds to a code in debiteuren|(% colspan="1" rowspan="1" %)string
163 +|(% colspan="1" rowspan="1" %)**monstersoort**|(% colspan="1" rowspan="1" %)An SIKB code that determins to which matrix the analyses belongs. Sampletype
164 +Codegroup 51 in the Attachments for all possible codes|(% colspan="1" rowspan="1" %)(((
174 174  integer
175 175  
176 176  
177 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
169 +|(% colspan="1" rowspan="1" %)**categoriecode**|(% colspan="1" rowspan="1" %)A code that corresponds to a category code in “//categorie//”|(% colspan="1" rowspan="1" %)string
184 184  
185 -== Structure explanation Urgencies ==
171 +== Structure explanation urgentietabel ==
186 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.
173 +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 “urgentie code” is a code given by the lab.
188 188  
189 -[[image:1712324236054-772.png||height="372" width="511"]]
175 +(% style="text-align:center" %)
176 +[[image:1637579214994-369.png]]
190 190  
191 191  (% class="table-hover" %)
192 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
180 +|(% colspan="1" rowspan="1" %)**urgentiecode**|(% 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
181 +|(% colspan="1" rowspan="1" %)**omschrijving**|(% colspan="1" rowspan="1" %)The name/ description of the urgentie|(% colspan="1" rowspan="1" %)string
195 195  
196 -== Structure explanation StoragePeriods ==
183 +== ==
197 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
185 +== ==
1712324236054-772.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.RobinHuisman
Size
... ... @@ -1,1 +1,0 @@
1 -13.8 KB
Content
1712324393233-546.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.RobinHuisman
Size
... ... @@ -1,1 +1,0 @@
1 -14.1 KB
Content