Organization Units Data Format

Last updated
Save as PDF
Share
1. Share
2. Tweet
3. Share

The following fields are defined for the Organization Units XML. An example of an XML file is below the chart.

After preparing the XML file(s), you can import them using the Import Organizations job in the Administrative menu. See Importing_Research_Organization_Units for more information.

Data Element	Occurs	Description
Code <organizationCode>	1	The code of the unit. The same code should be used as in the loader for researcher information. The code must be unique.
Name <organizationName>	1	Required. The name of the unit
Name Translation Value + Language <translatedOrganizationName>	1	Optional. Translation to the unit name to one of the supported language (must be defined in the institution). The language in 3 letters language code
Alternative names <alternativeNameList>	0-n	Optional. Alternative names may be supplied to the unit name
Acronyms <acronyms>	0-n	Optional. The unit Acronyms
Unit type (unitType)	1	The type of unit. Below are the OTB codes. Customers can customize the code table in Esploro. university faculty school college department institute research_center library administration service other
Description <description>	0-1	Free text This would display in an “organization profile” in the public facing portal.
<translatedDescription>	0-1	Free text. Translation to the unit description to one of the supported language (must be defined in the institution). The language in 3 letters language code
Unit status <status>	0-1	Possible values: ACTIVE DEACTIVATED DELETED
Address Data <city> <counry> <line1>...<line5> <note> <postalCode> <stateProvince>	0-n	This would display in an “organization profile” in the public facing portal.
Webpages <url>	0-n	This would display in an “organization profile” in the public facing portal.
Email Data <email>	0-n	Email address of the organization. This would display in the public facing portal.
Phone Data <phone> <phoneTypeList>	0-1	Phone Types: Office Fax Other This would display in the public facing portal.
Display status <displayStatus>	1	Whether the unit is displayed in the public facing portal. PUBLIC PRIVATE

Data Element

Occurs

Description

Code

The code of the unit. The same code should be used as in the loader for researcher information.

The code must be unique.

Name

Required. The name of the unit

Name Translation

Value + Language

Optional.

Translation to the unit name to one of the supported language (must be defined in the institution).

The language in 3 letters language code

Alternative names

0-n

Optional. Alternative names may be supplied to the unit name

Acronyms

0-n

Optional. The unit Acronyms

Unit type

(unitType)

The type of unit. Below are the OTB codes. Customers can customize the code table in Esploro.

university
faculty
school
college
department
institute
research_center
library
administration
service
other

Description

0-1

Free text

This would display in an “organization profile” in the public facing portal.

0-1

Free text.

Translation to the unit description to one of the supported language (must be defined in the institution).

The language in 3 letters language code

Unit status

0-1

Possible values:

ACTIVE
DEACTIVATED
DELETED

Address Data

<city>

<note>

0-n

This would display in an “organization profile” in the public facing portal.

Webpages

<url>

0-n

This would display in an “organization profile” in the public facing portal.

Email Data

<email>

0-n

Email address of the organization.

This would display in the public facing portal.

Phone Data

<phone>

0-1

Phone Types:

Office
Fax
Other

This would display in the public facing portal.

Display status

Whether the unit is displayed in the public facing portal.

PUBLIC
PRIVATE

organization_units sample XML

The schema is XML and is nested. Note that the top level – the university – should not be included as this level will be created automatically by the system based on the Esploro instance. Any unit/sub-unit should appear only once. If it has a number of sub-units, they should all be listed under the one unit.

Here is an example of an org unit XML file with subunits.

<?xml version="1.0"?>
<organization_units>
   <unit>
       <unitData>
           <organizationCode>Unit1</organizationCode>
           <organizationName>Faculty of Social Work</organizationName>
           <unitType>esploro.organization.unit.types.faculty</unitType>
           <translatedOrganizationNames>
               <translatedOrganizationName>
                   <value>Facultad de Trabajo Social</value>
                   <language>spa</language>
               </translatedOrganizationName>
           </translatedOrganizationNames>
       </unitData>
       <subUnits>
           <unit>
               <unitData>
                   <organizationCode>Unit3</organizationCode>
                   <organizationName>Institute for Strategy</organizationName>
                   <unitType>esploro.organization.unit.types.department</unitType>
                   <translatedOrganizationNames>
                       <translatedOrganizationName>
                           <value>Instituto de Estrategia</value>
                           <language>spa</language>
                       </translatedOrganizationName>
                   </translatedOrganizationNames>
               </unitData>
           </unit>
       </subUnits>
   </unit>
   <unit>
       <unitData>
           <organizationCode>Unit2</organizationCode>
           <organizationName>Faculty of Electrical Engineering</organizationName>
           <unitType>esploro.organization.unit.types.faculty</unitType>
           <data>
               <addressDataList>
                   <line1>Barrio de San Roque</line1>
                   <line2>Canicosa de la Sierra</line2>
                   <line3>Apartado postal 2521</line3>
                   <postalCode>09692</postalCode>
                   <city>Burgos</city>
                   <country>ESP</country>
               </addressDataList>
               <emailDataList>
                   <email>noshuchmail@nosuchmail.com</email>
               </emailDataList>
               <phoneDataList>
                   <phone>123456</phone>
               </phoneDataList>
           </data>
           <translatedOrganizationNames>
               <translatedOrganizationName>
                   <value>Facultad de Ingeniería Eléctrica</value>
                   <language>spa</language>
               </translatedOrganizationName>
           </translatedOrganizationNames>
       </unitData>
   </unit>
</organization_units>