Grouper Developers Forum

["GW Brown, Information Systems and Computing" <>]

--On 05 January 2010 21:04 -0600 Tom Barton 
<>
 wrote:

> 3. decide on new xml import/export args and options
For reference I've attached the current gsh commands and properties.

Gary

----------------------
GW Brown, Information Systems and Computing

Export the Groups Registry to XML

gsh -xmlexport
Usage:
args: -h,            Prints this message
args: subjectIdentifier
      [-userAuditFilename ] [-userAuditOnly]
      [(-id ] | [-name )] [-relative]
      [-includeParent] [-childrenOnly] fileName [properties]
e.g.  gsh -xmlexport -userAuditFilename f:/temp/prodAudit.xml GrouperSystem f:/temp/prod.xml

  subjectIdentifier, Identifies a Subject 'who' will create a
                     GrouperSession
  -userAuditFilename,The file name where user audits should go
  -id,               The UUID of a Group or Stem to export
  -name,             The name of a Group or Stem to export
  -relative,         If id or name specified do not export parent
                     Stems
  -includeParent,    If id or name identifies a Group and -relative
                     is selected, export the Group and its
                     parent Stem
  -childrenOnly,     If id or name identifies a Stem and -relative
                     is selected, export child Stems and Groups,
                     but not the stem itself
  filename,          The file where exported data will be written.
                     Will overwrite existing files
  properties,        The name of an optional Java properties file.
                     Values specified in this properties file will
                     override the default export behavior.
 

The export process is configured using the follow properties.

Key	Values	Default Value	Description
export.metadata	true/false	true	If true Group type and field information as well as Subject sources will be exported.
export.data	true/false	true	If true data will be exported.
export.privs.naming	true/false	true	If true naming privileges will be exported along with Stems.
export.privs.access	true/false	true	If true access privileges will be exported along with Groups.
export.privs.immediate-only	true/false	false	If true only directly granted privileges will be exported.
export.group.members	true/false	true	If true group memberships are exported.
export.group.members.immediate-only	true/false	true	If true only immediate group memberships will be exported.
export.group.lists	true/false	true	If true custom list attributes will be exported.
export.group.lists.immediate-only	true/false	true	If true only immediate list members will be exported.
export.uuids	true/false	true	If true group and stem uuids will be exported
export.group.internal-attributes	true/false	true	If true system-maintained Group attributes (eg. modifyDate) will be exported.
export.group.custom-attributes	true/false	true	If true custom attributes will be exported.
export.stem.internal-attributes	true/false	true	If true system-maintained Stem attributes (eg. modifyDate) will be exported.
export.privs.for-parents	true/false	false	If true and only exporting a partial hierarchy then privileges for parent stems will be exported.
export.data.fail-on-unresolvable-subject	true/false	false	If true and there is a problem resolving a subject attribute abort.
export.subject-attributes.source.<source name>.<subject type>	Space separated list of attribute names	?	Specifices any attributes that should be exported with a Subject given the specified Source and Subject Type.
export.subject-attributes.source.<source name>	Space separated list of attribute names	?	Specifies any attributes that should be exported with a Subject given the specified Source.
export.subject-attributes.type.<subject type>	Space separated list of attribute names	?	Specifies any attributes that should be exported with a Subject given the Subject Type.

Import the Groups Registry from XML

gsh -xmlimport
Usage:
args: -h,            Prints this message
args: subjectIdentifier
      [-userAuditFilename ] [-userAuditOnly]
      [(-id  | -name  | -list)]
      [-ignoreInternal] [-noprompt] filename [properties]
e.g.  gsh -xmlimport -userAuditFilename f:/temp/prodAudit.xml GrouperSystem f:/temp/prod.xml

  subjectIdentifier, Identifies a Subject 'who' will create a
                     GrouperSession
  -id,               The Uuid of a Stem, into which, data will be
                     imported
  -name,             The name of a Stem, into which, data will be
                     imported.  If no -id / -name is specified,
                     use=ROOT stem.
  -list,             File contains a flat list of Stems or Groups
                     which may be updated. Missing Stems and Groups
                     are not created
  -ignoreInternal,   Do not attempt to import internal attributes
                     including Group/Stem uuids. Overrides property:
                     import.data.ignore-internal-attributes-and-uuids
  -noprompt,         Do not prompt user to confirm the database that
                     will be updated
  filename,          The file to import
  properties,        The name of an optional Java properties file.
                     Values specified in this properties file will
                     override the default import behavior.

 

The import process is configured through the following properties.

Key	Values	Default	Description
import.metadata.group-types	true/false	true	If true create custom group types when importing.
import.metadata.group-type-attributes	true/false	true	If true create custom fields when importing.
import.data.ignore-internal-attributes-and-uuids=false	true/false	false	If true, do not attempt to set internal attributes or Group/Stem uuids
import.data.apply-new-group-types	true/false	true	If true custom group types are applied to pre-existing groups when importing.
import.data.update-attributes	true/false	true	If true overwrite attributes on pre-existing groups when importing.
import.data.fail-on-unresolvable-subject	true/false	false	If true, and the import file references a subject which cannot be resolved abort the import, otherwise, log the problem and continue.
import.data.lists	ignore/replace/add	replace	Determines whether membership lists are ignored, replaced or appended to pre-existing memberships when importing.
import.data.privileges	ignore/replace/add	add	Determines whether privileges are ignored, replaced or appended to pre-existing privileges when importing.