<directory>

This task exports and imports the organizational information (roles, participants, OUs, etc).

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

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

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

Example 1: Export organizational data.

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

      <!-- Export participants and roles -->
      <fuego:directory file="${basedir}/organization.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>
  ...

Example 2: Import organizational data:

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

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

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

Example organization.xml file:

 <FDIObject Organization="company">

   <DirOrganizationalRole>
     <name>TestRole1</name>
     <isParametric>false</isParametric>
   </DirOrganizationalRole>

   <DirOrganizationalRole>
     <name>TestRole2</name>
     <isParametric>false</isParametric>
   </DirOrganizationalRole>

   <DirHumanParticipant>
     <id>test1</id>
     <password>p</password>
     <firstName>Test</firstName>
     <lastName>One</lastName>
     <displayName>Test One</displayName>
     <receivesMail>false</receivesMail>
     <status>A</status>
     <rolesAssignment>
       <roleAssignment>
      <roleId>TestRole1</roleId>
      <permissions>95</permissions>
      <category>5</category>
       </roleAssignment>
     </rolesAssignment>
   </DirHumanParticipant>

   <DirHumanParticipant>
     <id>test2</id>
     <password>p</password>
     <firstName>Test</firstName>
     <lastName>Two</lastName>
     <displayName>Test Two</displayName>
     <receivesMail>false</receivesMail>
     <status>A</status>
     <rolesAssignment>
       <roleAssignment>
      <roleId>TestRole2</roleId>
      <permissions>95</permissions>
      <category>5</category>
       </roleAssignment>
     </rolesAssignment>
   </DirHumanParticipant>

 </FDIObject>

Attribute	Description	Type	Required?
file	The file to export/import. To obtain an example configuration file, export organizational information manually using Process Administrator.	File	Yes
passoutputdir	If generatePassFile is true, `passoutputdir` attribute specifies the directory for the password file.	File	No
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 JVM charset
haltonerror	Whether to stop the ant build process if an error occurs during the execution of this task.	boolean	No Defaults to false

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

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

<fuego : directory>

Description

Parameters

Parameters accepted as nested elements

<include> ...

<category>