The rules for Creating an XML file of User Data
The structure, and permissible elements, are as shown in the following code example:
<?xml version="1.0" ?>
<EXTRACT>
<USERS ACTION="UPDATE">
<USER ACTION="UPDATE" UUSERPROFILE="FRED">
<USEQUENCE TYPE="N" VALUE="1" />
<UCAPTION LANG="ENG" VALUE="USER FRED" />
<UHINT LANG="ENG" VALUE="" />
<UICONNAME VALUE="VF_IC496" />
<UUSEROBJECTTYPE VALUE="FRED_OBJ" />
<UPASSWORD VALUE="FREDSPSWD" />
<UEMAILADDRESS VALUE="[email protected]" />
<UTEMPDIRECTORY VALUE="C:\DOCUME~1\user\LOCALS~1\Fred\" />
<UDISABLED VALUE="FALSE" />
<UADMIN VALUE="FALSE" />
<UGROUPUSER VALUE="FALSE" />
<USIGNOFFTIMEOUT TYPE="N" VALUE="0" />
<USIGNONTIMEOUT TYPE="N" VALUE="0" />
<GROUPS ACTION="REPLACE">
<GROUP VALUE="GROUP_1" />
</GROUPS>
<AUTHORITIES ACTION="REPLACE">
<AUTHORITY TYPE="FRAMEWORK" OBJECT="SHIPPED_FRAMEWORK" VALUE="ALLOW" />
</AUTHORITIES>
</USER>
</USERS>
</EXTRACT>
General rules
Other element types will be ignored.
Property elements (e.g. uSequence, uCaption) have a VALUE attribute.
Numeric property elements should also have a TYPE = "N" attribute.
Boolean properties such as <UADMIN>, <UDISABLED>, <UGROUPUSER> are specified using VALUE="TRUE" or VALUE="FALSE"
The ACTION attribute can only be specified for USERS USER GROUPS or AUTHORITIES.
ACTION="UPDATE" means change/add what is specified in the XML, but leave everthing else as it is. If it doesn't exist already, it will be created.
ACTION="REPLACE" means change/add what is specified in the XML and remove anything that is not specified in the XML.
ACTION="DELETE" means remove the object/s.
Rules for Specific Elements/Attributes| Element | Attribute | Description | Value/s | Mandatory |
|
<USERS> |
ACTION |
Replace all users or add to/change existing |
REPLACE, UPDATE |
Yes |
|
<USER> |
ACTION |
How to handle properties not specified in the XML, or To delete the user |
REPLACE, UPDATE, DELETE |
Yes |
|
|
UUSERPROFILE |
The User Profile of the User |
|
Yes |
|
<GROUPS> |
ACTION |
|
REPLACE, UPDATE, DELETE |
Yes |
|
<GROUP> |
VALUE |
The User profile of the Group. The Group should exist in the Framework already. If not, the Group should be defined as a <USER> prior to other users, in the XML. |
|
Yes |
|
<AUTHORITIES> |
ACTION |
Replace all authorities, Add to/change existing authorities, or delete the specified authorities |
REPLACE, UPDATE, DELETE |
Yes |
|
<AUTHORITY> |
TYPE |
The type of object that the user will not be authorised to use. |
FRAMEWORK, APPLICATION, BUSINESS_OBJECT, COMMAND_REFERENCE, APPLICATION_VIEW, SERVER |
Yes |
|
|
OBJECT |
The "User Object Name / Type" of the object the user will not be able to use. |
|
Yes (if not command_ reference) |
|
|
VALUE |
Allow the user to use this object (only used with the FRAMEWORK object) or Disallow the user to use this object (all other kinds of objects) |
ALLOW, DISALLOW |
Yes |
|
|
COMMAND |
(This only applies to Authority to COMMAND_REFERENCE objects)
|
|
Yes (if command_ reference) |
|
|
OWNER |
(This only applies to Authority to COMMAND_REFERENCE objects) This is the "User Object Name / Type" of the object (Framework, application or business object) to which the command is applied |
|
Yes (if command_ reference) |
|
|
OWNTYP |
The type of object the command applies to |
FRAMEWORK, APPLICATION, or BUSINESS_OBJECT |
Yes (if command_ reference) |