Difference between revisions of "HowTo:Make an Object be found by Optical Codes"
(→See also) |
|||
| Line 19: | Line 19: | ||
# Add this new query to the list of [[SYSREL INFRASTRUCTURE|Infrastructure objects]] | # Add this new query to the list of [[SYSREL INFRASTRUCTURE|Infrastructure objects]] | ||
# Prepare and add a [[QUERYSCOPE]] to the [[ACM]] | # Prepare and add a [[QUERYSCOPE]] to the [[ACM]] | ||
| − | # Prepare and add a [[VIEWITEMS|View Item]] to the view set in the [[Context]] of the ACM<br/>[[File:UI_Marker_scaning02.png| | + | # Prepare and add a [[VIEWITEMS|View Item]] to the view set in the [[Context]] of the ACM<br/>[[File:UI_Marker_scaning02.png|800 px|border|alt=infrastructure|infrastructure]] |
| Line 26: | Line 26: | ||
=== Preparing the object with multiple codes === | === Preparing the object with multiple codes === | ||
Ensuring the object can be found by the clients offline search we need to classify the object's MetaClass as [[SYSCLS_OBJECTWITHIDMARKERS]] <br/> | Ensuring the object can be found by the clients offline search we need to classify the object's MetaClass as [[SYSCLS_OBJECTWITHIDMARKERS]] <br/> | ||
| − | As this classification is an autonomous classification there is no need to maintain any properties. The properties and the corresponding values (all MARKERS | + | As this classification is an autonomous classification there is no need to maintain any properties. The properties and the corresponding values (all MARKERS referring to one object) will be managed by the system and sent to the client automatically. <br/> |
| − | [[File:UI_Marker_scaning10.PNG| | + | [[File:UI_Marker_scaning10.PNG|600 px|border|alt=Classify object with multiple codes|Classify object with multiple codes]] |
| + | |||
| + | |||
| + | |||
| + | |||
| + | == OCR Online Search== | ||
| + | Optical Character Recognition, abbreviated as [[OCR]], is the automatic text recognition using a respective algorithm on an image (originating from a live camera feed, for example). {{Version/ServerSince|4.7}} since 4.7! | ||
| + | |||
| + | The OCR Text must be entered in the property "OCRTEXT". | ||
| + | |||
| + | If later a Text is scanned and found in the OCRTEXT, the referenced object will be added to the result collection | ||
| + | |||
| + | === Preparing an OCR Scan-Query === | ||
| + | We provide a MetaClass "OCRSCANQUERY OCR Text scan queries" deriving from System.Query.QUERY. There is already one instance QRY_OCRSCANQUERY available in it but, we want to set up a new one so we will leave this one as it is. | ||
| + | # Create a new instance of OCRSCANQUERY | ||
| + | # Set the according filter object ('''FILTEROBJECT''') similar as for other queries | ||
| + | # Add this new query to the list of [[SYSREL INFRASTRUCTURE|Infrastructure objects]] | ||
| + | # Prepare and add a [[QUERYSCOPE]] to the [[ACM]] | ||
| + | # Prepare and add a [[VIEWITEMS|View Item]] to the view set in the [[Context]] of the ACM<br/>[[File:OCR_WIKI_SCANQUERY.png|800 px|alt=infrastructure|infrastructure]] | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | === Preparing the object === | ||
| + | # Ensuring the object can be found by the clients offline search we need to classify the object's MetaClass as [[SYSCLS OBJECTWITHOCRTEXT]] and implement the necessary properties<br/>[[File:OCR_WIKI_OBJECTWITHOCRTEXT.png|600 px|alt=Create a new Query|Create a new Query]] | ||
| + | # Enter the value of the OCRText in the property | ||
| Line 36: | Line 63: | ||
=== Preparing a Scan-Query === | === Preparing a Scan-Query === | ||
# [[HowTo:Create a new Query]] classified as [[SYSCLS_IDMARKERSCANQUERY]] | # [[HowTo:Create a new Query]] classified as [[SYSCLS_IDMARKERSCANQUERY]] | ||
| − | # Set the according filter object ('''FILTEROBJECT''') similar as for other queries (e.g. [[HowTo:Create_a_new_Query]])<br/>[[File:UI_Marker_scaning01.png| | + | # Set the according filter object ('''FILTEROBJECT''') similar as for other queries (e.g. [[HowTo:Create_a_new_Query]])<br/>[[File:UI_Marker_scaning01.png|1200 px|border|alt=Create a new Query|Create a new Query]] |
# Add this new query to the list of [[SYSREL INFRASTRUCTURE|Infrastructure objects]] | # Add this new query to the list of [[SYSREL INFRASTRUCTURE|Infrastructure objects]] | ||
# Prepare and add a [[QUERYSCOPE]] to the [[ACM]] | # Prepare and add a [[QUERYSCOPE]] to the [[ACM]] | ||
| − | # Prepare and add a [[VIEWITEMS|View Item]] to the view set in the [[Context]] of the ACM<br/>[[File:UI_Marker_scaning02.png| | + | # Prepare and add a [[VIEWITEMS|View Item]] to the view set in the [[Context]] of the ACM<br/>[[File:UI_Marker_scaning02.png|800 px|border|alt=infrastructure|infrastructure]] |
=== Preparing the object === | === Preparing the object === | ||
| − | # Ensuring the object can be found by the clients offline search we need to classify the object's MetaClass as [[SYSCLS_OBJECTWITHIDMARKER]] and implement the necessary properties<br/>[[File:UI_Marker_scaning03.png| | + | # Ensuring the object can be found by the clients offline search we need to classify the object's MetaClass as [[SYSCLS_OBJECTWITHIDMARKER]] and implement the necessary properties<br/>[[File:UI_Marker_scaning03.png|600px|border|alt=Create a new Query|Create a new Query]] |
# Enter the value of the Barcode, QR-Code or the Marker ID in the property | # Enter the value of the Barcode, QR-Code or the Marker ID in the property | ||
Revision as of 09:18, 14 March 2024
Loading and identifying objects via a Barcode or QR-Code on the UBIK® Client implies that the objects and the search mechanisms are configured and used accordingly. This guide describes how to prepare objects using UBIK® Studio.
Please be aware that since Version 4.4.0 we support defining multiple (optical) codes for one object. Even if we support (for downward compatibility) both approaches (one code per object and multiple codes per object) we recommend to use the new technique even if there is only one code per object. If you are using an older version please navigate to Find object with single Code.
Contents
ID Marker
UBIK provides a new Entity called ID Marker since 4.4.0! ID Markers are used to define the scannable Codes on a central location. We differ 3 types of Codes: RFID, BarCode and QR-Code.
The Code must be entered in the property "MARKER", the type is specified using the property "MAKER_TYPE" and the property OWNER refers to the object/ubiqule which is presented by the code. You can specify as many codes for one object as you like.
If later a code is scanned and found in the ID Markers, the referenced object will be added to the result collection.
Preparing an ID Marker Scan-Query
We provide a new MetaClass "IDMARKERSCANQUERY ID marker scan queries" deriving from System.Query.QUERY. There is already one instance QRY_IDMARKERSCANQUERY available in it. As this query is used to support the single Code search we recommend to create a new Query instance.
- Create a new instance of IDMARKERSCANQUERY
- Set the property "SUPPORT_MULTI_MARKERS" to true to enable the new technique.
- Set the according filter object (FILTEROBJECT) similar as for other queries
- Add this new query to the list of Infrastructure objects
- Prepare and add a QUERYSCOPE to the ACM
- Prepare and add a View Item to the view set in the Context of the ACM
Preparing the object with multiple codes
Ensuring the object can be found by the clients offline search we need to classify the object's MetaClass as SYSCLS OBJECTWITHIDMARKERS
As this classification is an autonomous classification there is no need to maintain any properties. The properties and the corresponding values (all MARKERS referring to one object) will be managed by the system and sent to the client automatically.
OCR Online Search
Optical Character Recognition, abbreviated as OCR, is the automatic text recognition using a respective algorithm on an image (originating from a live camera feed, for example). since 4.7!
The OCR Text must be entered in the property "OCRTEXT".
If later a Text is scanned and found in the OCRTEXT, the referenced object will be added to the result collection
Preparing an OCR Scan-Query
We provide a MetaClass "OCRSCANQUERY OCR Text scan queries" deriving from System.Query.QUERY. There is already one instance QRY_OCRSCANQUERY available in it but, we want to set up a new one so we will leave this one as it is.
- Create a new instance of OCRSCANQUERY
- Set the according filter object (FILTEROBJECT) similar as for other queries
- Add this new query to the list of Infrastructure objects
- Prepare and add a QUERYSCOPE to the ACM
- Prepare and add a View Item to the view set in the Context of the ACM
Preparing the object
- Ensuring the object can be found by the clients offline search we need to classify the object's MetaClass as SYSCLS OBJECTWITHOCRTEXT and implement the necessary properties
- Enter the value of the OCRText in the property
Single Code
Preparing a Scan-Query
- Create a new Query classified as SYSCLS IDMARKERSCANQUERY
- Set the according filter object (FILTEROBJECT) similar as for other queries (e.g. Create a new Query)
- Add this new query to the list of Infrastructure objects
- Prepare and add a QUERYSCOPE to the ACM
- Prepare and add a View Item to the view set in the Context of the ACM
Preparing the object
- Ensuring the object can be found by the clients offline search we need to classify the object's MetaClass as SYSCLS OBJECTWITHIDMARKER and implement the necessary properties
- Enter the value of the Barcode, QR-Code or the Marker ID in the property
