Appboard/2.4/admin/provisioning/batch loading - Revision history

imported>Jason.nicholls: /* Overview */

2014-07-16T15:20:53Z

Overview

← Older revision		Revision as of 15:20, 16 July 2014
Line 7:		Line 7:

	This document covers the XML format and process to load the file. For a general overview and links to manage users via the AppBoard administration interface, refer to the main [[appboard/2.4/admin/provisioning\|Provisioning]] documentation.		This document covers the XML format and process to load the file. For a general overview and links to manage users via the AppBoard administration interface, refer to the main [[appboard/2.4/admin/provisioning\|Provisioning]] documentation.


	{{Warning\|Using batch loading via XML files is considered a customization of AppBoard and not directly supported under the standard product maintenance contract. It is recommended this type of solution be implemented as part of a		{{Warning\|Using batch loading via XML files is considered a customization of AppBoard and not directly supported under the standard product maintenance contract. It is recommended this type of solution be implemented as part of a

imported>Jason.nicholls: /* Overview */

2014-07-16T15:18:39Z

Overview

← Older revision		Revision as of 15:18, 16 July 2014
Line 7:		Line 7:

	This document covers the XML format and process to load the file. For a general overview and links to manage users via the AppBoard administration interface, refer to the main [[appboard/2.4/admin/provisioning\|Provisioning]] documentation.		This document covers the XML format and process to load the file. For a general overview and links to manage users via the AppBoard administration interface, refer to the main [[appboard/2.4/admin/provisioning\|Provisioning]] documentation.

	~~It's also possible, as a custom solution, to create a web interface using Java Server Pages (JSP) on the AppBoard server. For an example of how to do this also refer to the link above.~~

	{{Warning\|Using batch loading via XML files is considered a customization of AppBoard and not directly supported under the standard product maintenance contract. It is recommended this type of solution be implemented as part of a		{{Warning\|Using batch loading via XML files is considered a customization of AppBoard and not directly supported under the standard product maintenance contract. It is recommended this type of solution be implemented as part of a

imported>Jason.nicholls: /* Overview */

2014-07-16T09:31:58Z

Overview

← Older revision		Revision as of 09:31, 16 July 2014
Line 4:		Line 4:
	== Overview ==		== Overview ==

	Rather than managing users through the AppBoard administration interface, or via LDAP-based authentication integration, it's also possible to batch load domains, users, and role assignment via XML files.		Rather than managing users through the AppBoard administration interface, or via LDAP-based authentication integration, it's also possible to batch load domains, users, roles, and role assignment via XML files.

	This document covers the XML format and process to load the file. For a general overview and links to manage users via the AppBoard administration interface, refer to the main [[appboard/2.4/admin/provisioning\|Provisioning]] documentation.		This document covers the XML format and process to load the file. For a general overview and links to manage users via the AppBoard administration interface, refer to the main [[appboard/2.4/admin/provisioning\|Provisioning]] documentation.

imported>Jason.nicholls: /* Loading the XML */

2014-07-16T09:27:15Z

Loading the XML

← Older revision		Revision as of 09:27, 16 July 2014
Line 61:		Line 61:
	# Creating a load list:		# Creating a load list:
	## This is a simple text file with one line per XML file to be loaded.		## This is a simple text file with one line per XML file to be loaded.
	## The file path is relative to the server xmlroot, so for the example above it should contain a single line with the following: <tt>provisioning/''yourfile.xml'</tt>		## The file path is relative to the server xmlroot, so for the example above it should contain a single line with the following: <tt>provisioning/''yourfile.xml''</tt>
	## Save this file as <tt>load_provisoning.txt</tt> and place onto the AppBoard server into the following directory: <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/xmlroot/server</tt>		## Save this file as <tt>load_provisoning.txt</tt> and place onto the AppBoard server into the following directory: <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/xmlroot/server</tt>
	# Triggering a load:		# Triggering a load:

imported>Jason.nicholls at 09:26, 16 July 2014

2014-07-16T09:26:15Z

← Older revision		Revision as of 09:26, 16 July 2014
Line 53:		Line 53:
	** emustermann: ''training''		** emustermann: ''training''
	** jbloggs: ''testing''		** jbloggs: ''testing''


	== Loading the XML ==		== Loading the XML ==

imported>Jason.nicholls at 09:25, 16 July 2014

2014-07-16T09:25:52Z

← Older revision		Revision as of 09:25, 16 July 2014
Line 1:		Line 1:
	{{DISPLAYTITLE:Batch Loading via XML}}		{{DISPLAYTITLE:Batch Loading via XML}}
	[[Category:AppBoard 2.4]]		[[Category:AppBoard 2.4]]
			__TOC__
	== Overview ==		== Overview ==

imported>Jason.nicholls: /* Loading the XML */

2014-07-16T09:25:33Z

Loading the XML

← Older revision		Revision as of 09:25, 16 July 2014
Line 63:		Line 63:
	## The file path is relative to the server xmlroot, so for the example above it should contain a single line with the following: <tt>provisioning/''yourfile.xml'</tt>		## The file path is relative to the server xmlroot, so for the example above it should contain a single line with the following: <tt>provisioning/''yourfile.xml'</tt>
	## Save this file as <tt>load_provisoning.txt</tt> and place onto the AppBoard server into the following directory: <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/xmlroot/server</tt>		## Save this file as <tt>load_provisoning.txt</tt> and place onto the AppBoard server into the following directory: <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/xmlroot/server</tt>
	# Triggering a load		# Triggering a load:
	#* Either restart the AppBoard server or		#* Either restart the AppBoard server or
	#* Via the administration interface and manually triggering an XML Import:		#* Via the administration interface and manually triggering an XML Import:

imported>Jason.nicholls at 09:25, 16 July 2014

2014-07-16T09:25:03Z

@@ Line 8: / Line 8: @@
 It's also possible, as a custom solution, to create a web interface using Java Server Pages (JSP) on the AppBoard server. For an example of how to do this also refer to the link above.
 == XML Format ==
@@ Line 50: / Line 53: @@
 ** jbloggs: ''testing''
-# Save the code shown in the "XML Code" section below into a text file with the file name: batchLoad.xml
+== Loading the XML ==
-=== Applying Provisioning Updates ===
+# Create an XML file with the appropriate user, domain, and role definitions as outlined above. This file needs to be placed onto the AppBoard server into the following directory: <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/xmlroot/server/provisioning/''yourfile.xml''</tt> (''yourfile.xml'' can be anything as long as it ends with <tt>.xml</tt>).
-Perform the following steps to apply provisioning updates using the XML batch file:
+After a successful load the changes should be visible in the administration interface for users, domains, and roles. The <tt>load_provisioning.txt</tt> file on the AppBoard server will be renamed so that this operation is not performed again on restart.
-# Follow the steps above under <i>Installation and Configuration</i> to save the XML code into the application file system as <tt>${Application_Home}/server/webapps/enportal/WEB-INF/xmlroot/server/provisioning/batchLoad.xml</tt>.
+{{Note|Batch loading via XML is an additive operation. i.e. it can only be used to '''add''' users, domains, roles, and role assignments, not remove them.}}

imported>Jason.nicholls: /* XML Format */

2014-07-16T09:09:09Z

XML Format

← Older revision		Revision as of 09:09, 16 July 2014
Line 41:		Line 41:
	When loaded, the above example will:		When loaded, the above example will:

	* create 2 roles: testing, and training		* create 2 roles: ''testing'', and ''training''
	* create 2 domains: EdgeFairfax and ~~EdgeAustralia~~		* create 2 domains:
	* ~~create users within the above domains~~		** ''EdgeFairfax'' with users ''jsmith'' and ''emustermann''
	* assign roles to those users		** ''EdgeAustralia'' with user ''jbloggs''
			* assign roles to those users:
			** jsmith: ''testing'' and ''training''
			** emustermann: ''training''
			** jbloggs: ''testing''

	== XML Load Instructions ==		== XML Load Instructions ==

imported>Jason.nicholls: /* XML Format */

2014-07-16T09:06:59Z

XML Format

← Older revision		Revision as of 09:06, 16 July 2014
Line 37:		Line 37:
	</AccountDefinitions>		</AccountDefinitions>
	</code>		</code>


	When loaded, the above example will:		When loaded, the above example will: