Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

Supported Operations

Import/Export provides IMPORT, LIST, 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.

Usage
Import Multiple Files
ant data-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.

Import Single File
ant data-import -Dfile={path-to-file}

Where path-to-file is a file system path, absolute or relative, containing uPortal Import/Export XML file.

List

Lists the data types the portal knows how to import/export/delete and can list all of the data currently in the database for a specific type.

Usage
list types
ant data-list

Export

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

Usage
ant data-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

delete

notes

all

(error)

All portal entities

(error)

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

(error)

All user layouts

(error)

Normal users generate .layout files on export; fragment owners generate .fragment-layout

all-profiles

(error)

All user profiles

(error)

May generate more than one document per user

all-permissions

(error)

All permissions

(error)

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

(error)

All permission_sets

(error)

A permission_set entity is one owner, target, activity, and type, but zero or more principals

all-memberships

(error)

All local (RDBMS) memberships

(error)

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

(error)

All channels

(error)

 

all-channel-types

(error)

All channel types

(error)

 

all-groups

(error)

All local (RDBMS) groups

(error)

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

(error)

All local (RDBMS) group_memberships

(error)

A group_membership entity describes a group and refers to all of its children

all-users

(error)

All users

(error)

 

all-themes

(error)

All themes

(error)

 

all-structures

(error)

All structures

(error)

 

all-entity-types

(error)

All entity types

(error)

"Entity types" here refers to the UP_ENTITY_TYPES table; these are not the same as Import/Export entity types

all-fragment-definitions

(error)

All fragment definitions

(error)

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

 

 

 

(error) =not specified or not supported

  • No labels