Administrators use properties to configure the application according to their organization's needs. Properties govern a variety of application behaviors, such as workflow settings or enabling certain features. While editing properties, keep in mind:
- Property value types: Some properties use boolean (i.e. true/false) values, others may require a number or plain text string. Before attempting to modify a property, check the value types it will accept.
- Restarting the application: Some properties require a restart of the application before any change will take effect – including adding, editing, and removing the property. When modifying any property, check to see whether or not it requires a restart.
There are two ways to edit an application's properties:
- Using the NetX user interface.
- Editing the exogen-config.xml file (this option is available for on-premise customers only). Note that any property change made from the user interface will apply to the exogen-config.xml file and vice versa.
Configuring properties in the user interface
Adding a property
- Click the Systems button found along the left navigation sidebar to access the systems area.
- Click the Properties tab.
- Click Add property to add a new property.
- In the Name field, type the name of the property. The property name must be an exact match including case.
- In the Value field, add the desired property value. Make sure you have the right value type and value for the property you are adding.
- Click Save. If the property does not require a restart, refresh the application in your browser window.
Editing a property
Note: only the property's value may be edited.
- Click the Systems button found along the left navigation sidebar to access the systems area.
- Navigate to the Properties tab.
- Click the actions button to the right of the property you would like to edit.
- Choose Edit property from the action menu.
- Change the property's Value.
- Click Save.
Removing a property
Once deleted, properties will stop affecting the application in any way. Note: the removal of a property may still require a restart to take effect.
- Click the Systems button found along the left navigation sidebar to access the systems area.
- Click the Properties tab.
- Click the actions button to the right of the property you would like to delete.
- Click Delete from the action menu.
- To complete the deletion, confirm the action on the subsequent warning by clicking Delete.
Editing properties in the exogen-config.xml file
This option is available for on-premise administrators only and requires access to application files stored on the server. If you are editing property values via the exogen-config.xml file, proceed with caution if you are not very familiar with the process and XML syntax in general. Regardless of the property being edited, using the exogen-config.xml file to manage an application's properties always requires a restart.
Locating the file
The exogen-config.xml file is stored in the NetX application directory. Here are their default paths:
Linux/UNIX:
/opt/netx/netx/config
Windows:
C:\Program Files\NetXposure\netx\config
Working with exogen-config.xml
As shown in the example below, each property added or edited in the XML file must:
- Begin with an included document type definition block. This is included so the file is more portable on your server.
- Must be included within the properties node.
- Must be bookended by property tags.
- Be wrapped in property tags, and must contain a name and value tag.
- Have properly escaped tags.
<exogen-config> <properties> <property> <name>Property name</name> <value>Property value</value> </property> <properties> </exogen-config>
User level numeric equivalents
Certain properties require a user level to be specified as a numeric value. In that case, the table below provides a conversion chart for such values:
User level | Numeric value |
---|---|
Importer | 3 |
Producer | 4 |
Manager | 7 |
Director | 8 |
Administrator | 9 |
No access | 0 |
Browser | 1 |
Consumer | 2 |