The Application Summary method returns a list of the
available Configuration Vectors. Some or all of the returned configuration vectors
may be marked as
The Configuration Drilldown method can then be used on
a single drillable configuration vector, returning a list of the entries in the vector,
along with a
columns Array of column description objects.
Some configuration vectors support run-time changes. The following conditions must be met:
- The client must have administator access (admin user/password, or
- The row must be marked with the
_deleteflag, or the vector with the
- For an update or insert, only the columns marked as
editablecan be specified by the client.
_insert flag in indicates that new configuration vector entries may be submitted.
On each vectory entry in the
list, the flags
_delete indicate that individual
vector entries in the list may be modified or removed.
Not all columns in the configuration vector support editing. The per-column
flag indicates which columns may have insert/update values submitted. Changes submited to
non-editable columns will be ignored.
The configuration vector entry will be updated in the running config, but the value will be lost on restart of the application.
To make this value permanent on restart, the value must be separately updated in
n2svcd.xml file, database, or wherever the official value of that
configuration vector list is stored.
ManageApp sends a
!MANAGEMENT-CONFIGURATION-VECTOR-REQUEST message to
the application and wait for the corresponding
- Content: JSON Object
Special characters in the
must be URI percent-encoded.
The JSON Object has the following structure:
[Required] The type if change which is requested.
delete] The value of the first column (the index column) in the row to modify/remove.
update] The new values to insert or update.
In the case of successful update, the following HTTP Response is returned:
- Content: JSON Object
The attributes of the JSON Object are as follows:
[Required] Indicates successful update.
[Required] The name of the Application which whose configuration was set.
[Required] The name of the configuration key which was set.
[Required] The value of the first column (the index column) in the changed row.
This is present for all cases,
[Required] Confirmation of the action which was performed.
update] The full map of new values after insert/update.
This is the complete list of columns that would be returned by a drilldown. It will include even those columns that were not updated. The values for the columns may be different from the requested new values. When performing an
insert, these new values includes the new
value from the first column, which is the special index column.
In the case of a soft error performing the configuration update (e.g. value is out of range, user does not have admin authority, etc.) the response is also JSON, with the following structure:
[Required] Indicates update was not successful.
[Required] Human readable explaination of the error cause.
In the case of a more serious internal processing error (e.g. Invalid URI, Invalid request
body, etc.) the response may be a non-200 HTTP Status, with an optional
describing the reason for failure.
- Status: non-
- Content: Internal Processing Error Message