Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
titleImport Multiple Files
ant data-import -Ddir={path-to-directory} [-Dpattern={regexant-pattern}]

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

Note
titleThe -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.

 

Code Block
titleImport Single File
ant data-import -Dfile={path-to-file}

...

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

 The data-list command with no arguments lists all supported portal data types and the operations (export, delete) supported for each. By adding the -Dtype= parameter all data that currently exists in the portal for that data type is listed

Usage
Code Block
titlelist types
ant data-list

Example output:

No Format
 [java] INFO Export and Delete Support by Data Type
 [java] INFO Data Type | Export | Delete 
 [java] INFO -----------------------+--------+--------
 [java] INFO entity-type | true | false 
 [java] INFO fragment-definition | true | false 
 [java] INFO fragment-layout | true | false 
 [java] INFO group-membership | true | false 
 [java] INFO layout | true | false 
 [java] INFO permission-owner | true | true 
 [java] INFO permission-set | true | false 
 [java] INFO portlet-definition | true | true 
 [java] INFO portlet-type | true | true 
 [java] INFO profile | true | false 
 [java] INFO stylesheet-descriptor | true | true 
 [java] INFO user | true | true 
Code Block
titleList data of a specific type
ant data-list -Dtype={entity-type}

Where entity-type is the name of a portal data type, these can be determined by the plain ant data-list command.

Example Output, note that the part before the " - " is the sysid to use with the data-export and data-delete commands.

No Format
 [java] INFO All portlet-definition data
 [java] INFO     fragment-audit - Audit DLM Fragments
 [java] INFO     forgot-password - Forgot Password
 [java] INFO     passwordmgr - Password Management
 [java] INFO     ImportExportPortlet - Import Export Portlet
 [java] INFO     cache-manager - Cache Manager
 [java] INFO     popular-portlets - Most Popular Apps

 

Export

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

...

Warning
titleWarning

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
Code Block
ant  >ant crndata-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