Technical documentation of Open Datacheck Deep Search

Owned by Daniela Ludwig
Last updated: 17.09.2024
14 min read

Description

On this page you will find the part of the technical documentation for Open Datacheck Deep Search. Specifically, you will find the technical content for the example integration of Deep Search and the example integration of Deep Search with BauDocs. You can find an overview of the content below:

Contents

Integration via “xs-loader” widget

All widgets are integrated via the “xs-loader”.

Parameter “xs-deepsearch”

Input

Ab Version

Input

Ab Version

Parameter

Mandatory

Description

Example value

 

channelid

No

If a ChannelID is specified, the display of the DeepSearch is restricted to these requested channels. The ChannelIDs must always be transferred in an array.

The user must be assigned to the specified channel on the system.

[2, 5]

Vor 2.0.19

channelfocus

No

Specifies which channel should be focused after starting the widget. If not specified or the ChannelID is not available, the first channel is focused.

5

Vor 2.0.19

predefinedarchivedfiltervalue

No

Indicates whether the Archived filter is set to the desired value when called.

Possible values:

false = Shows all documents that are not archived

true = Shows all documents that are archived

true

Vor 2.0.19

prefermanufacturerlogoview

No

Specifies whether the manufacturer view should be used until:

Only documents from one manufacturer are available in the results area

One or more manufacturers have been explicitly selected

Selection of a manufacturer in the manufacturer overview

Selection of one or more manufacturers in the Manufacturer filter

If the Manufacturer overview parameter is not set, the default, i.e. the results list with the documents, is displayed

 

Possible values:

true = manufacturer view is preferred

false = default behavior

true

Vor 2.0.19

externalsearch

No

 

false

Vor 2.0.19

usebaudocs

No

Integration of the BauDocs widget within the article details

false

Vor 2.0.19

baudocsaccesstoken

Yes, when “usebaudocs” = true

OAuth2 access token for the BauDoc system. This token must first be requested from the integrating system on the BauDoc system.

-

Vor 2.0.19

baudocsrefreshtoken

Yes, when “usebaudocs” = true

OAuth2 refresh token for the BauDoc system. This token must first be requested from the integrating system on the BauDoc system.

-

Vor 2.0.19

manufactureridtype

Yes, when “usebaudocs” = true

The ID type that is sent with a BauDocs request for identification / mapping.

This functionality is only available if an IDHUB integration has been ordered.

odc

Vor 2.0.19

videodefaultposter

No

Image available on the web that is displayed when the video is started if no video poster is available.

https://url.png

Vor 2.0.19

removeroundbracketsinsuppliername

No

Removes texts that are enclosed in brackets in the supplier name. Example: “Supplier(abc)” is replaced by “Supplier” in the interface.

Default value is false.

true

Vor 2.0.19

removesquarebracketsinsuppliername

No

Removes texts that are enclosed in square brackets in the supplier name. Example: “Supplier[abc]” is replaced by “Supplier” in the interface.

Default value is false.

true

Vor 2.0.19

widgetstate

No

Initializes the widget after a return.

c2l0ZXMvZGVmYXVsdC9maWxlcy9pbmZvcGFja2FnZS8yLzEzMDEvMTYzNTE3MjczMi9wYWdlL3RodW1ibmFpbHMvMTAzMTkyNjRfOTA2LnBkZi5qcGVn

Vor 2.0.19

style

No

JSON object for defining the primary and secondary color of the widget. The object has two fields:

  • primarycolor: Primärfarbe. A hexadecimal string is expected as the value (Example: "#616161").

  • secondarycolor: Secondary color. A hexadecimal string is expected as the value (Example: "#D3D3D3").

"style":{ "primarycolor": "#616161", "secondarycolor": "#D3D3D3" }

Vor 2.0.19

predfefinedsearchterm

No

This parameter can be used to pre-assign the search term. The value passed is used in the initial search and appears in the search slot. If the parameter is not specified, the search is started without a search term.

"predfefinedsearchterm": "Waschtisch"

2.0.20

predifinedfilters

No

Filters that should be preselected when entering the DeepSearch widget. The filter setting can be made per channel.

Fields in the

  • channelid: The ID of the channel to which the filter is to be applied.

  • filters: A list of preselected filters.

There are the filter types “Selection” (a list of filter options) and “Range” (restriction by minimum and maximum value, e.g. for prices). Both types can be used in the filters field.

Fields for the “Selection” type:

  • name: The name of the filter

  • values: A list of filter options that should be preselected

  • disabled: This filter is preselected and can only be partially changed via the DeepSearch interface. The selected filters can be deselected until only one of the preselected filters is available. Resetting this filter resets the values to the initial state. This ensures that the maximum predefined result set cannot be exceeded.

  • hidden : Dieser Filter wird vorausgewählt und wird in der DeepSearch nicht angezeigt. Dieser kann über das Frontend nicht verändert werden.

Fields for the type “Range”:

  • name: The name of the filter

  • minvalue: Lower limit of the selection

  • maxvalue: Upper limit of the selection

"predifinedfilters":[ { "channelid": 1, "filters":[ { "name": "warengruppe", "values": ["Washlets", "WCs"] "disabled": false, "hidden": true }, { "name": "preis", "minvalue": 100, "maxvalue": 10000 } ] }, { "channelid": 2, "filters": [ { "name": "infoPackageName.name", "values": ["Preisliste", "Price List"] "disabled": true, } ] } ]

Vor 2.0.19

excludefilters

No

Filter exclude the values. The behavior is equivalent to a blacklist. The filter setting can be made per channel.

Fields in the

  • channelid: The ID of the channel to which the filter is to be applied.

  • filters: A list of preselected filters.

There are the filter types “Selection” (a list of filter options) and “Range” (restriction by minimum and maximum value, e.g. for prices). Both types can be used in the filters field.

Fields for the “Selection” type:

  • name: The name of the filter

  • values: A list of filter options that should be preselected

Vor 2.0.19

pdfviewer

No

The object serves as a configuration object for the PDF viewer

There is currently only one top category

  • position

    • top

    • right

    • bottom

    • left

All values are implemented as pixel values. A unit does not necessarily have to be specified.

Vor 2.0.19

downloadinnewtab

No

If the parameter is set to true, a new tab opens when the download button is clicked and the file is downloaded

 

Vor 2.0.19

downloadinnewtabtarget

No

To be used in conjunction with “downloadinnewtab”. Only used if “downloadinnewtab” is set to true

Specifies the target that the download URL should open

By default or if no value is set, “_blank” is used

 

Vor 2.0.19

externallinkid

No

The link ID of the uploaded file that is to be opened when the widget is called.

Must be set together with “externallinkchannelid”

Vor 2.0.19

externallinkchannelid

No

The channel in which the file referenced with “externallinkid” is stored.

Must be set together with “externallinkid”

Vor 2.0.19

widgetstate

No

All GET parameters of the deep search as a Base64 string.

This allows a specific view to be loaded immediately when the deep search is opened.

Vor 2.0.19

articleselectionmode

No

Displays an “Add” button in the article list which triggers the “selectedarticle” output event when pressed.

The default value is false.

true

Vor 2.0.19

usesubstitutes

No

Integration of the substitute widget (alternative article) within the article details. This feature can only be used if it has been activated on the system and for the channel. This parameter can be used to deactivate it during integration.

The default value is true.

false

Vor 2.0.19

usedocuments

No

Integration of the XS documents widget (library) within the article details. This feature can only be used if it has been activated on the system and for the channel. This parameter can be used to deactivate it during integration.

The default value is true.

false

Vor 2.0.19

usebimcad

No

Integration of the BIM / CAD widget within the article details. This feature can only be used if it has been activated on the system and for the channel. This parameter can be used to deactivate it during integration.

The default value is true.

false

Vor 2.0.19

usemultitree

No

Display of the tree as a filter in the article search. This feature can only be used if it has been activated on the system and for the channel. Furthermore, a definition of the tree must have been maintained on the channel. This parameter can be used to deactivate it during integration.

The default value is true.

false

Vor 2.0.19

disableMetaTag

No

The XS-DeepSearch widget includes a meta tag. This meta tag is defined as follows:

The tag is essential for displaying the widget on mobile devices. The tag can lead to problems when integrating the widget into apps.

This parameter can be used to control whether the meta tag is created. The meta tag can then be provided by the embedded website, for example.

Please note that if the tag is switched off, no guarantee can be given for correct display on mobile devices.

The default value is false.

true

Vor 2.0.19

suppliernamecursive

No

The parameter determines whether the manufacturer name is displayed in italics in the OpenBIB.

If true, the names would be displayed in italics:

If false, the names would not be displayed in italics:

 

false

Vor 2.0.19

Ausgang

 

shopsearch

No

This event is only output if this function has been switched on for the corresponding channel.

The event contains the following two pieces of information.

  • searchterm

    • String / Can be empty

  • manufacturerid

    • String / Can be empty

  • callback

    • thumbnailurl: String, URL to the thumbnail of the document. The OAuth2 token must be included in the header of the request.

    • uploaddescription: String, Upload description of the document

    • widgetstate: String, Status of the widget for return. Must be transferred to the widget in the parameters when returning in order to restore the status.

 

Vor 2.0.19

shopcart

No

This event is only output if this function has been switched on for the corresponding channel.

  • thumbnailurl: String, URL to the thumbnail of the document. The OAuth2 token must be included in the header of the request.

  • uploaddescription: String, upload description of the document

  • widgetstate: String, status of the widget for return. Must be transferred to the widget in the parameters when returning in order to restore the status.

 

 

Vor 2.0.19

status

Yes

This event is always output during initialization.

  • error

  • complete

 

Vor 2.0.19

dialogstatus

No

This event is output when a dialog is opened and closed. Values:

  • open

  • close

 

Vor 2.0.19

pdflink

No

This event is displayed in a PDF document when you click on an external link.

Output of the value specified in the PDF document for the external link as a string

Vor 2.0.19

pdflinkextended

No

This event is triggered in addition to the “pdflink” event and contains a callback attribute that can be used to return to the widget.

The attributes in the callback event are:

  • searchterm

  • manufacturerid

  • thumbnailurl

  • uploaddescription

  • widgetstate

Sample output of the event:

Vor 2.0.19

selectedarticle

No

This event is only output if the input parameter “articleselectionmode” is set to “true”. The event is then triggered when the “Add” button in the article list is clicked.

The attributes of the event:

  • productInstanceId

  • productInstanceIdBase64 (optional)

  • productId

  • productIdBase64 (optional)

  • supplierId

  • supplierPid (optional)

Sample output:

Vor 2.0.19

Eingangsevents

 

closeAlldialogs

 

This event can be emitted to the widget. The widget catches the event and then closes all dialog windows that are currently open.

Example call:

Vor 2.0.19

Example image

 

Example parameters

Example integration

Embed the following code snippet into the HTML DOM.

Widget-Loader V1.x.x

Widget-Loader V2.x.x

Example event “shopsearch”

The following code example waits for the return event “shopsearch” from DeepSearch.

Example event “shopcart”

The following code example waits for the return event “shopcart” from DeepSearch.

Example event “status”

The following code example waits for the return event “status” from DeepSearch.

Sample code (PHP)

Widget-Loader V1.x.x

Widget-Loader V2.x.x

Widget-Loader V1.x.x

Widget-Loader V2.x.x