Skip to main content

Using content types in iCL Designer

How to add a content type to a workbook​

In order to be able to use content types in iCL Designer, they first have to be loaded into the workbook. This is done by right-clicking the 'Content Types' category and select the Import option.

Once imported, this file can be used as content type in the workbook. If the content of the JSON file is altered, it has to get imported again into the workbook to work with current data. You can just do the import procedure again, without deleting the existing one.

note

If the name of the content type changes, but the GUID stays the same, it is not possible to update the content type via a simple import overwrite. In this case you have to remove the existing content type, and all blockly- and mapping-references within the workbook will be lost.

Content Type Properties​

Is inspected​

A content type in a workbook with a set builtinTypeId of 0 can be marked as "is inspected". This means, that the user is requested to select an item of that content type at the start of a new inspection - e.g. the building he wants to make an inspection for.

note

In a workbook, only one content type with the "is inspected" property is supported.

Content Item Filter​

By default, a content field that is not read-only and set to be inspected, allows the user to select any of the content items in the system. This filter is applied at the start of the inspection, giving you the possibility to restrict the items to choose from.

caution

When the system is configured to only synchronize specific items to a user's device to avoid overloading it with unnecessary data ("filtered synchronization"), then the user will only see the content items that are currently on his device.

Find out more about the scripts in the according documentation here.

How to integrate content types into a checklist​

Creating a content item field​

After uploading a content type into the workbook, it can be integrated into the checklists.

To do so, you first create a field and set its control type to Content Item.

In the Content Type dropdown below you can now choose one of the available content types, which you integrated into your workbook.

After selecting the content type, you have access to its mappings, which you can address or interact with via blockly scripts to transport data and information.

You have some specific options here to set the function of the content type.

OptionDescription
Automatic creationWith this option, a new content item will be generated for this content type. Every mapping field will transmit their blockly values to the item. If a mapping is left empty, no data will be transmitted.
Automatic updatesWith this option, the selected content item will be updated with the new values. If a mapping is left empty, that data will not get updated.
AutofillIf this field is assigned to the inspected content item, it will be automatically set to the value which were selected at the start of the inspection.
in first checklist onlyThe preselected content type will only be assigned in the first checklist.

Mappings with a * require a value if you have automatic creation enabled.

See the blockly documentation to learn how to use scripts here.