Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New article: Barcode/QRCode questions #282

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file not shown.
95 changes: 95 additions & 0 deletions source/barcode_qrcode_questions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
# Barcode/QR code question type

The Barcode/QR Code question type is used for scanning, decoding and capturing
barcodes and QR codes using the device camera. When a Barcode/QR code is scanned
with the camera, the value (whether numbers or text) that the pattern stands for
is captured. Please note that Barcode/QR code scanning only works when using
KoboCollect on mobile devices.

A wide range of Barcode and QR code formats are supported, including the
following:
joshuaberetta marked this conversation as resolved.
Show resolved Hide resolved

- UPC-A
- UPC-E
- EAN-8
- EAN-13
- Code 39
- Code 93
- Code 128
- Codabar
- ITF
- RSS-14
- RSS-Expanded
- QR Code
- Data Matrix
- Aztec
- PDF 417
- MaxiCode

Barcode/QR code questions can be used in different scenarios including asset
management or item distribution. For example, you can use the `pulldata()`
function to
[automatically populate fields from a csv attached to your project, or a different form project](https://community.kobotoolbox.org/t/trying-to-build-a-form-that-will-use-pulldata-function-to-verify-barcode-id/4724).
joshuaberetta marked this conversation as resolved.
Show resolved Hide resolved

## How to set up the “Barcode/QR code” question type

### Setting up in FormBuilder
joshuaberetta marked this conversation as resolved.
Show resolved Hide resolved

To add a barcode/QR code question:
joshuaberetta marked this conversation as resolved.
Show resolved Hide resolved

- In the KoboToolbox Formbuilder, click the <i class="k-icon k-icon-plus"></i>
joshuaberetta marked this conversation as resolved.
Show resolved Hide resolved
button to add a new question
- Type the question text, for example “Collect the beneficiary identification
code”, then click **ADD QUESTION** or press ENTER on your keyboard
- Choose the question type

![Adding Barcode/QRCode questions](images/barcode_qrcode_questions/adding_barcode_qrcode_questions.gif)

### Setting up in xlsform
joshuaberetta marked this conversation as resolved.
Show resolved Hide resolved

To add a barcode question in XLSform, add a question with type `barcode` as
joshuaberetta marked this conversation as resolved.
Show resolved Hide resolved
follows:

| type | name | label |
| :------ | :------------- | :------------------------------ |
| barcode | beneficiary_id | Capture the beneficiary ID code |
| survey |

## How barcode/qr code questions are displayed on web forms and KoboCollect
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

consistency

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed


## Default appearance

![Default appearance of Barcode/QRCode questions](images/barcode_qrcode_questions/barcode_qrcode_appearance.png)

## Advanced appearance

When adding the “Barcode/QR code” question type, you can change the appearance
settings to switch from using the default (back) camera of the device to using
the front camera.

### Changing advanced Appearance in FormBuilder
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

formbuilder


To do this, go to the question settings of the “Barcode/QR code” question, and
type “front” in the Appearance(Advanced) box
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Appearance(Advanced)" -> "Appearance (Advanced)"

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done


![Changing appearance of Barcode/QRCode questions](images/barcode_qrcode_questions/change_appearance_barcode_qrcode_questions.png)

### Changing advanced Appearance in XLSForm

In XLSForm, you can set the default camera for capturing the QR/Barcode to be
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

consistency

QR/Barcode

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorted

the front (selfie) camera by typing ‘front’ in the appearance column as follows:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No need to have "(selfie)" in there.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"appearance" -> "appearance"


| type | name | label | appearance |
| :------ | :--------------- | :------------------------------ | :--------- |
| barcode | beneficiary_id_2 | Capture the beneficiary ID code | front |
| survey |

<p class="note">
Download an XLSForm with examples from this article
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"You can download..."

<a
download
class="reference"
href="./_static/files/barcode_qrcode_questions/barcode_qrcode_questions.xlsx"
>here</a
>.
</p>
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ Search the knowledge base, browse our resources and visit our forum for more det
rating_ranking
select_one_and_select_many
calculate_questions
barcode_qrcode_questions
advanced_calculate
video_question_type
matrix_response
Expand Down