--- title: Device Properties Wizard slug: solutions/device-properties-wizard docTags: createdAt: 2025-08-15T14:08:59.332Z --- To successfully read data from a device defined in DeviceHub, it is necessary to have the right Device Properties defined. These can include properties like: - Network Address - Port - Slot - User Name - Password To assist with the definition of the Device Properties and ensure that the JSON Object is correctly formatted and includes all required entries, the Device Management Tool provides a Device Properties Wizard. # Access the Device Properties Wizard :::hint{type="info"} **Notes**: To access the Device Properties Wizard it is required that: - The entry in Column **Device Properties **is not empty or an empty array **\[]**. -> The tool should automatically set the default Device Properties JSON Object in these cases. - A **Device Name** is defined - A **Driver Name** is selected - A **Driver Group Name** is selected ::: Select the respective cell in Column **Device Properties** for the Device you want to define Device Properties. If all conditions are met, the **Device Properties Wizard** button is shown in the Help section of the **LitmusConfiguration **ribbon. ![](https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/ZIoRX3T_7jP7dq_7WKkvt_image.png) Open the Device Properties Wizard by pressing the **Device Properties Wizard** button. ::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/y_oCX02TAklUG5dtPlrjI_image.png" size="60" width="334" height="173" position="center" showCaption="false"} The Device Properties wizard will show. ![](https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/-D2KzJs8rsocCLqAjPF5f_image.png) # Edit a Device Property Select the Device Property you want to edit to open its **Edit **screen. ::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/89JiVOqzxLzU4VevZ9Epy_image.png" size="80" width="1005" height="642" position="center" showCaption="false"} Edit the **Value **and press the **Modify **button. ::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/wVP7ZllGfE0JLa2uDpij1_image.png" size="80" width="1003" height="652" position="center" showCaption="false"} :::hint{type="info"} **Notes**: If not both Name and Value are provided, the **Modify **button will remain grayed out and the property can not be saved. The wizard also performs a verification for each entry and will show any violation in red. In this case the **Modify** button will also be grayed out to prevent the saving of any invalid Device Property. ::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/g1HEYDh-AOF5JR8_ObJES_image.png" size="80" width="995" height="621" position="center" showCaption="false"} ::: :::hint{type="info"} **Notes**: Some Drivers can reqire additional Properties based on what is select. Example: The users changes the **advanced** Properties to Show. ::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/j4tIJbBwfER64UzpBNJZ1_image.png" size="80" width="990" height="585" position="center" showCaption="false"} Which adds additional Properties which the user can set. ::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/KqKH7_h1NgwdU2XVu5QrJ_image.png" size="80" width="996" height="440" position="center" showCaption="false"} ::: ## Device Properties with a list of Parameters as value Some properties require a list of Paramter Sets which are shown as an array of JSON Objects of Parameter Key-Value Pairs. To assist with the correct formatting of this Array a Parameter Sets Wizard is available. To open the Parameter Sets Wizard press the **Wizard** button. ::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/rliMnk63NPxUSCKY8gXmQ_image.png" size="80" width="998" height="639" position="center" showCaption="false"} :::hint{type="info"} **Notes**: If the the Device Property has already Parameter Sets defined, they will be shown in the List. ::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/UbjSNE4D1CTkSMOvZ0I90_image.png" size="80" width="1007" height="637" position="center" showCaption="false"} ::: ### Add a set of Parameter Key-Value Pair(s) To add a new Parameter Key-Value pair, press the **Add **option from the left panel. ::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/kQkiQLl-Qzx1gg-B0B_IU_image.png" size="80" width="997" height="638" position="center" showCaption="false"} This will add a Set of Parameter Key-Value pairs with an empty value, based on the drivers definition. It also shows an Index which is added to help keep track of each sets definition. ::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/Y83gNQj6Bs2tLhy4lySxr_image.png" size="80" width="1005" height="647" position="center" showCaption="false"} :::hint{type="info"} **Notes**: You can add as many sets of Parameter Key-Value Pairs as you need. Simply press the **Add **Option again. ::: ### Edit a Parameter Key-Value Pair Select the Parameter Key-Value pair you want to edit to open its **Edit **screen. ::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/BWNIqBGs_jW-CMpA1eM6j_image.png" size="80" width="999" height="639" position="center" showCaption="false"} Edit the **Value **and press the **Modify **button. ::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/G4pzZGeiJR6Wj9ssUr1Aa_image.png" size="80" width="998" height="632" position="center" showCaption="false"} :::hint{type="info"} **Notes**: If not both Name and Value are provided, the **Modify **button will remain grayed out and the Key-Value pair can not be saved. The wizard also performs a verification for each entry and will show any violation in red. In this case the **Modify** button will also be grayed out to prevent the saving of any invalid Parameter Key-Value pair. ::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/SotrwdBTuvcJD-lmy2Zrt_image.png" size="80" width="997" height="641" position="center" showCaption="false"} ::: ### Delete a set of Parameter Key-Value Pair(s) Select any Parameter Key-Value pair of a specific Parameter Set you want to delete, to open its **Edit **screen. ::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/sCUUDVKxqn6hWsGzbls7J_image.png" size="80" width="1004" height="642" position="center" showCaption="false"} To delete the entire set of Parameter Key-Value Pair(s) press the **Delete **button. ::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/-P5BnzHMxCXF9Ic-qYruD_image.png" size="80" width="1006" height="642" position="center" showCaption="false"} :::hint{type="info"} **Notes**: It is not possible to delete individual Parameter Key-Value pairs from a Set. As the entire Set is required by the driver to funtion. ::: ### Save all Parameter Sets To save the array of Sets of Paramater Key-Value pairs, press the **Save **button. ::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/ZOZVw7TDNZh7plja2xJOp_image.png" size="80" width="996" height="631" position="center" showCaption="false"} This will add the correcly formatted Array of JSON Objects as value to the Status Register Property. ::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/ew6WywPnsjvED5YrxbF_H_image.png" size="80" width="1002" height="641" position="center" showCaption="false"} :::hint{type="warning"} **Important: ** This will overwrite the current value of the Device property in the value field. **But it does not save the change.** ::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/SHYOClAKcTXGwfjYti1_J_image.png" size="80" width="1002" height="641" position="center" showCaption="false"} ::: ### Cancel the Parameter Sets Wizard If a user decides to not save the current Sets of Parameter Key-Value Pairs, they can press the **Cancel **button. ::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/Tdv2fkWxdCCLSHF3c0zbY_image.png" size="80" width="996" height="631" position="center" showCaption="false"} :::hint{type="info"} **Notes**: This will not overwrite the value in the Value field for the Status Register Property. ::: # Save the Device Properties To save all the Device Properties as a new Device Properties JSON Object, press the **Save **button. ::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/NtZ8Dufvu6I98scgrDc6S_image.png" size="80" width="1004" height="617" position="center" showCaption="false"} This will create the correctly formatted Device Properties JSON Object and store it in column **Device Properties** for the device. ![](https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/imsMHpg__G0NEJInx_3Ju_image.png) :::hint{type="warning"} **Important: **This will overwrite the current value in column **Device Properties**. ::: # Cancel the Device Properties Wizard If a user decides to not save the current Device Properties Wizard configuration, they can press the **Cancel **button. ::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/s72a-fc0fVVp7J-o-XHfo_image.png" size="80" width="1223" height="649" position="center" showCaption="false"} :::hint{type="info"} **Notes**: This will not overwrite the current value in column **Device Properties**. :::