QR Code

Command Description

This command can convert a text (a static text or an iProperty value) to a QR code image (a machine-readable black-and-white matrix). To convert values to QR codes, the ThoughtWorks.QRCode.dll library is used. To display the QR code in a drawing, a sketched symbol with a graphic representation of the QR code is used.

Example of manually created QR code

Command Location

• Drawing environment (Be.Smart T4I -> Annotations)

• Drawing environment (Annotate -> Symbols)

• QR code iProperties can be defined in all document types.

Command Settings

Be.Smart T4I -> Be.Smart T4I -> Edit settings -> QR code tools (the basic settings window)

Be.Smart T4I -> Be.Smart T4I -> Advanced settings -> QR code tools (the advanced settings window)

QR code basic settings window

QR code advanced settings windows

QR Code conversion (the basic settings window)

This section is valid for automatic iProperty to QR code conversion.

Auto update QR on save

QR code value can be automatically updated when saving the document. That does not apply to QR codes with static text.

QR Source property name / QR Target property name

QR Source property name defines the name of the iProperty that will contain the value (mostly of some iProperty) that is to be translated into a QR code.

QR Target property name defines the name of the iProperty that will contain the QR code's textual representation of the value converted from the source QR code property.

Create missing target property

If checked, the target property containing the converted source property value can be created automatically after saving the document. On the other hand, the source property has to be created manually beforehand, because it is not known in advance what value it will contain.

QR Code settings (the basic settings window)

This section is valid for automatic or manual QR code conversion.

Level

In the QR code command window in a drawing, this can be named Version (Size).

Level values can range from 1 to 10. The higher the level is, the larger the amount of information that can be stored inside the QR code. If the amount of information exceeds the QR code's capacity, the warning message is displayed.

Encoding

ALPHA_NUMERIC type can contain letters, digits and some special characters (0-9, A-Z, $%*+-./:)

NUMERIC type can contain numeric characters 0-9.

BYTE type stores an array of bytes. Can contain, e.g., a Unicode text including accents.

Error correction

The different levels determine what percentage of the QR code can be corrupted (e.g. dirty or damaged) and still remain readable. $L = 7\ \% , M=15\ \%, Q = 25\ \%, H=30\ \%$

For clean environments, level $L$ is recommended, whereas for dirty environments $Q$ and $H$ levels may be used to reduce the chance that the QR code becomes unreadable.

Sketched symbols (the basic settings window)

This section is valid for manual QR code conversion.

QR Code symbol name

QR Code symbol name contains the name of the QR code sketched symbol in a drawing environment.

Font settings

To ensure QR codes from automatically converted iProperties are correctly visible and readable, the correct font settings must be used. The default font settings are carefully selected so the QR code is displayed correctly.

Generally, the QR code font settings must be changed cautiously. Therefore, in the basic Holixa T4I settings window, the font settings values are set to read-only. If necessary, the font settings can be changed in the advanced settings window.

Other font settings for good QR code visibility in the drawing may be as follows:

• $Size =0.5$
• $Line\ spacing=1$
• $Width\ scale=1.8$

An example of incorrect font settings resulting in an unreadable QR code can be seen in the image below.

Incorrect font settings of the QR code

Workflow Overview And Examples

The manual QR code insertion is done using the command in the drawing environment. On the other hand, the automatic iProperty conversion is prepared using the ordinary iProperty manipulation workflows.

Static text conversion (manual conversion to QR code)

1. Run the command.

2. Enter the text to be converted.

3. Select the Size, Encoding, and Error correction.

4. Confirm with OK.

5. Move the QR code from the initial position (bottom left corner of the drawing) to the final position.

Static text conversion to QRcode

iProperty value conversion

1. Create the custom source iProperty QRCodeSourceData (or use any other suitable name).

2. Assign the iProperty to the source property using the syntax =<iProperty Name> or enter a static value.

3. Save the file. If allowed in settings, the target iProperty (e.g. QRCodeAsText) should be created. Otherwise, create the target iProperty manually first.

4. In a drawing, create a text annotation mapped to the model target iProperty. Don't forget to apply proper font formatting.

You can have your drawing template adjusted beforehand so the QR code can be displayed, e.g., in a drawing title block.

If the target iProperty value is empty, check the value assignment in the source iProperty or check the QR code's encoding.

iProperty conversion to QR code