Changes for page Lab delivery file - SIKB version 14

Last modified by Robin Huisman on 2024/12/18 14:57

From 41.1 to 42.1 From 43.4 to 44.1

From version 42.1

edited by Robin Huisman
on 2024/04/05 15:41

Change comment: There is no comment for this version

To version 43.4

edited by Luca de Laat
on 2024/04/10 13:47

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (2 modified, 0 added, 0 removed)

Details

Page properties

Author

@@ -1,1 +1,1 @@
--XWiki.RobinHuisman
++XWiki.LucadeLaat

Content

@@ -1,14 +1,14 @@
  = Creating a Delivery file and binding them to a customer =
--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.
++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.
  {{warning}}
  Latest version can be found here: [[https:~~/~~/www.sikb.nl/datastandaarden/sikb0101-bodembeheer>>url:https://www.sikb.nl/datastandaarden/sikb0101-bodembeheer]]
  {{/warning}}
--== What is a lab delivery file ==
++== What is a lab delivery file? ==
--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
++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.
  **Example files**:   [[attach:Labdeliveryfile.xml||rel="noopener noreferrer" target="_blank"]]
@@ -20,9 +20,13 @@
  {{toc/}}
++~==> nle Add field Certification (screen 1 of labassignment)
++
  == File structure ==
  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.
++
++~==> nle Dutch text in screenshot
  [[image:1712158795900-531.png||height="604" width="391"]]
  (% class="table-hover" %)
@@ -73,7 +73,7 @@
  “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”.
--In TerraIndex it will be showed as Header/Group:
++In TerraIndex, it will be shown as Header/Group:
  [[image:1712162927138-349.png]]
@@ -88,14 +88,14 @@
  == Structure explanation AnalysisLink and Analysis ==
--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.
++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.
  \\[[image:1712163145392-331.png]]
  \\[[image:1712163459761-326.png||height="488" width="799"]]
  (% class="table-hover" %)
  |(% colspan="1" rowspan="1" %)**Attribute name**|(% colspan="1" rowspan="1" %)**Description**|(% colspan="1" rowspan="1" %)**Unit**
--|(% 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
--|(% 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" %)-
++|(% 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
++|(% 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" %)-
  === __Analysis__ ===
@@ -108,7 +108,7 @@
  == Structure explanation Clients ==
--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”.
++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”.
  \\It will be shown in the interface of TerraIndex, and needs to be chosen before selecting analysis sets:
  [[image:1712163957735-690.png]]
  \\[[image:1712163986350-364.png||height="409" width="544"]]
@@ -115,11 +115,11 @@
  |(% colspan="1" rowspan="1" %)**Attribute name**|(% colspan="1" rowspan="1" %)**Description**|(% colspan="1" rowspan="1" %)**Unit**
  |(% colspan="1" rowspan="1" %)**ClientId**|(% colspan="1" rowspan="1" %)The customer identification code(s) for the company or office|(% colspan="1" rowspan="1" %)string
--|(% 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
++|(% 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
  == Structure explanation LabSampleMatrices ==
--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.
++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.
  It needs to be chosen in the interface of TerraIndex, before any analysis set can be chosen:
  \\[[image:1712164314258-543.png]]
@@ -129,15 +129,15 @@
  (% class="table-hover" %)
  |(% colspan="1" rowspan="1" %)**Attribute name**|(% colspan="1" rowspan="1" %)**Description**|(% colspan="1" rowspan="1" %)**unit**
--|(% colspan="1" rowspan="1" %)**CompartimentId**|(% colspan="1" rowspan="1" %)An SIKB ID that determins to which matrix the analyses belongs.
++|(% colspan="1" rowspan="1" %)**CompartimentId**|(% colspan="1" rowspan="1" %)An SIKB ID that determines to which matrix the analyses belongs.
  Domaintable: [[Compartment/Matrix>>https://codes.sikb.nl/tablet/domain-table-details/6134f3bb-6048-431d-a130-01290d84172c]]|(% colspan="1" rowspan="1" %)int
  |(% colspan="1" rowspan="1" %)//CompartimentCode//|(% colspan="1" rowspan="1" %)-not in use-|(% colspan="1" rowspan="1" %)
--|(% 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
++|(% 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
  |(% 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
  == Structure explanation SpecialAppointment ==
--The “SpecialAppointment" contains the names of the price catalogus, the default quote or the special project quote. This way extra discount options are possible. It will be send in the labassignment to the lab.
++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.
  It needs to be chosen in the interface of TerraIndex, before any analysis set can be chosen, and empty means 'default quote':
@@ -148,16 +148,16 @@
  (% class="table-hover" %)
  |(% colspan="1" rowspan="1" %)**Attribute name**|(% colspan="1" rowspan="1" %)**Description**|(% colspan="1" rowspan="1" %)**unit**
--|(% 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
++|(% colspan="1" rowspan="1" %)**SpecialAppointmentId**|(% colspan="1" rowspan="1" %)An identification code from the lab that will be sent in the Labassignment to the lab.|(% colspan="1" rowspan="1" %)string
  |(% 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
  |(% colspan="1" rowspan="1" %)//startdate//|(% colspan="1" rowspan="1" %)-not in use-|(% colspan="1" rowspan="1" %)
  |(% colspan="1" rowspan="1" %)//finaldate//|(% colspan="1" rowspan="1" %)-not in use-|(% colspan="1" rowspan="1" %)
--|(% colspan="1" rowspan="1" %)**AppointmentTypeCode**|(% colspan="1" rowspan="1" %)The  type of appointment, like: total pricelist, default quotation or special project agreement.
++|(% colspan="1" rowspan="1" %)**AppointmentTypeCode**|(% colspan="1" rowspan="1" %)The type of appointment, like: total pricelist, default quotation or special project agreement.
  Domaintable: [[PriceAgreement Type>>https://codes.sikb.nl/tablet/domain-table-details/60028a8a-f386-47bf-bf2e-f46af49b7b56]]|(% colspan="1" rowspan="1" %)int
  == Structure explanation Links ==
--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.
++The “Links” is one of the most important sections of the XML. The “Link” defines the combination of Analysespackages, customer/clientcode, categories and sampletype. Without a combination in this table, a customer will not be able to send in lab assignments to the laboratory.
  [[image:1712158823685-514.png||height="563" width="531"]]
@@ -173,7 +173,7 @@
  )))
  |(% colspan="1" %)Price|(% colspan="1" %)The optional Price indication for this combination of the Analysis|(% colspan="1" %)decimal
  |(% colspan="1" %)CertificationId|(% colspan="1" %)The optional code that corresponds to the way of Sample and analysis handling as described in a certification.
--Some other labs have this arragened by the LabSampleMatrix types.
++Some other labs have this arranged by the LabSampleMatrix types.
  Domaintable: [[CertificeringsCode >>https://codes.sikb.nl/tablet/domain-table-details/df7ffd7c-192c-44f7-ae9f-0461d9266b30]]|(% colspan="1" %)int
  |(% 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
  |(% colspan="1" rowspan="1" %)//Accredited//|(% colspan="1" rowspan="1" %)-not in use-|(% colspan="1" rowspan="1" %)bool
@@ -180,7 +180,7 @@
  == Structure explanation Urgencies ==
--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.
++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.
  [[image:1712324236054-772.png||height="372" width="511"]]
@@ -191,7 +191,7 @@
  == Structure explanation StoragePeriods ==
--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.
++This table contains a list with different storage periods for the storage of the delivered Samples and its containers. For example, '1 month', '5 weeks', 'customer agreement' and so on. The “StoragePeriodId” is a code given by the lab.
  [[image:1712324393233-546.png||height="359" width="519"]]