Import Export Data Migration Tools

Supported Operations

Import/Export provides IMPORT, EXPORT and DELETE operations for supported portal entities.

Import

Adds the entities defined in the specified XML file(s) to the portal database. If the specified entities are already present – determined by Id, Name, or other primary key, as appropriate – this operation will update the existing entity to match the information provided in the XML. Importing the same file several times has the same effect as importing it once – you are free to re-import files without negative consequence (though see Warning below).

Usage

  >ant crn-import -Ddir={path-to-directory} [-Dpattern={regex}]

Where path-to-directory is a file system directory, absolute or relative, containing uPortal Import/Export XML files; and regex is an (optional) Java Regular Expression specifying a file name pattern that candidate files must match or be ignored by the importer.

The -Dpattern Argument

Regex special characters overlap heavily with OS/Shell special characters. It's often better to avoid the -Dpattern argument altogether. You can always place desired files into a new directory for import.

Warning

Never re-import an outdated .fragment-layout file against a portal database with existing users. There is a risk that the folder and channel nodes on the fragment will receive new IDs that don't match up with the existing IDs, and (therefore) users' customizations to that fragment will become corrupted. Always export a .fragment-layout first, apply your changes, then re-import. The fresh export will contain the proper IDs, which will be restored on import.

NOTE: It's a good idea to test this process and verify that it's working correctly before attempting it on production.

Deployments that do not allow user customizations to DLM fragments are exempt from this warning.

Export

Creates XML files representing the requested entities and writes them to the specified file system location.

Usage

  >ant crn-export [-Ddir={path-to-directory}] -Dtype={entity-type} [-Dsysid={entity-identifier}]

Where path-to-directory is a file system directory, absolute or relative, wherein XML will be written; and entity-type is any supported entity type (see table below); and entity-identifier is the Id or Name of a single entity of the specified type. The -Dsysid argument is not required for entity types that begin with "all-."

Named Sub-directories

On export, XML documents will be organized into sub-directories by entity type: e.g. channel, layout, user, etc.

Delete

Removes the specified entities as well as dependent (orphaned) entities from the portal database.

Warning

The DELETE feature should be used with extreme caution and is more appropriate for DEV and TEST portals than for PROD. It is possible to make your portal unusable by deleting the wrong thing.

Usage

  >ant crn-delete -Dtype={entity-type} [-Dsysid={entity-identifier}]

Where entity-type is any supported entity type (see table below); and entity-identifier is the Id or Name of a single entity of the specified type.

Table of Entity Types

entity-type	sysid	export	notes
all		All portal entities	Combines the following sub-types: all-layouts all-profiles all-permission_sets all-channels all-channel-types all-users all-themes all-structures all-entity-types all-group_memberships all-fragment-definitions
all-layouts		All user layouts	Normal users generate `.layout` files on export; fragment owners generate `.fragment-layout`
all-profiles		All user profiles	May generate more than one document per user
all-permissions		All permissions	A `permission` entity is one owner, target, activity, type, and principal; not exported on `-Dtype=all` since the data is covered by the permission_sets type
all-permission_sets		All permission_sets	A `permission_set` entity is one owner, target, activity, and type, but zero or more principals
all-memberships		All local (RDBMS) memberships	A `membership` entity refers to one parent and one child; not exported on `-Dtype=all` since the data is covered by the group_memberships type
all-channels		All channels
all-channel-types		All channel types
all-groups		All local (RDBMS) groups	A `group` entity simply describes a group (not its children); not exported on `-Dtype=all` since the data is covered by the group_memberships type
all-group_memberships		All local (RDBMS) group_memberships	A `group_membership` entity describes a group and refers to all of its children
all-users		All users
all-themes		All themes
all-structures		All structures
all-entity-types		All entity types	"Entity types" here refers to the `UP_ENTITY_TYPES` table; these are not the same as Import/Export entity types
all-fragment-definitions		All fragment definitions	Requires the `RDBMConfigurationLoader`
layout	`username`
profile	`username`		May generate more than one document per user
channel	`fname`
channel-type	`name`
group	`name`		A `group` entity simply describes a group (not its children)
group_membership	`name`		A `group_membership` entity describes a group and refers to all of its children
user	`username`
theme	`name`
structure	`name`
entity-type	`name`
fragment-definition	`name`

=not specified or not supported