What Custom Field Permissions Does the API Support?

What are Custom Field Permissions?

vWorkApp has four different permissions for custom fields; optional, read only, hidden and required.

Any custom field can be set to any one of these permissions. The permission controls how the mobile worker is allowed to interact with the custom field.

Why should I use Custom Field Permissions?

Setting different permissions ensure you have control over what information your workers have access to and what they can edit.

Custom fields can also be hidden from workers, allowing you to include additional confidential information on a job file.

How do I use Custom Field Permissions?

Here are some examples of the XML you need to supply when creating your jobs. These examples are all based on a free text custom field for readability, but these permissions can be applied to almost any custom field type.

OPTIONAL FREE TEXT

To create a custom field that allows free text entry, include the following XML in your job:

<custom_field>

<name>What you want to name the field</name>

<value>What text you want to appear in the field</value>

<permission>optional</permission>

</custom_field>

 

READ ONLY FREE TEXT

To create a custom field that can be modified by the dispatcher, but only read by a mobile worker, include the following XML in your job:

<custom_field>

<name>What you want to name the field</name>

<value>What text you want to appear in the field</value>

<permission>read_only</permission>

</custom_field>

 

HIDDEN FREE TEXT

To create a custom field that can be modified by the dispatcher, but not seen by the mobile worker, include the following XML in your job:

<custom_field>

<name>What you want to name the field</name>

<value>What text you want to appear in the field</value>

<permission>hidden</permission>

</custom_field>

 

REQUIRED FREE TEXT

To create a custom field that can be modified by the dispatcher, and must be completed by the mobile worker before they can complete the job, then include the following XML in your job:

<custom_field>

<name>What you want to name the field</name>

<value>What text you want to appear in the field</value>

<permission>required</permission>

</custom_field>

 



Need more information? ask us hereHave more questions? Submit a request