<fuego : directory>

Description

This task allows for exporting and importing the organizational information (roles, participants, OUs, etc).

Particular types of objects and their properties categories can be selected using the include nested elements. For each element type the categories selected to export can be selected using the property nested elements.

When the objects are imported to the directory, all categories contained in the file will be also imported and cannot be excluded.

When importing participants, a password file can be generated if desired. By default no password file is generated.

Export example:

 ...
  <!-- Open a session to the Fuego directory -->
    <fuego:session passportref="fuego.passport">

      <!-- Export participants and roles -->
      <fuego:directory file="${basedir}/export.xml"
                     action="export">

          <!-- include participants and export only the category "prefs"-->
          <include type="participants">
             <category name="prefs"/>
          </include>
          <!-- include roles and do not export categories -->
          <include type="roles"/>

      </fuego:directory>
  </fuego:session>
  ...
 

Import example:

 ...
  <!-- Open a session to the Fuego directory -->
    <fuego:session passportref="fuego.passport">

      <!-- Import participants (generating password file) and roles -->
      <fuego:directory file="${basedir}/export.xml"
                     action="import"
           generatePassFile="true">

          <!-- include participants -->
          <include type="participants"/>

          <!-- include roles-->
          <include type="roles"/>

      </fuego:directory>
  </fuego:session>
  ...
 

Parameters

Attribute Description Type Required?
file

File used to export data if an export action is selected, or file containing the organization data to import if an import action is selected.

File Yes
generatepassfile Whether to generate a password file after importing participants. boolean No Defaults to false
action Whether to execute an export or an import.

Possible values are [export,import]

String ["export", "import"] Yes
charset The charset name to use when the export file is written. String No Defaults to default VM charset
haltonerror Whether to stop the ant build process if an error occurs during the execution of this task. boolean No Defaults to false

Parameters accepted as nested elements

<include> ...

Attribute Description Type Required
type Type of object to include in the export/import. String ["views", "referrals", "groups", "ous", "holidayrules", "presentations", "roles", "businessparameters", "variables", "calendarrules", "participants"] Yes

<category>

Attribute Description Type Required
name Category name to include in export. String Yes