Export or import organization structure and product allocations
Applies to: Enterprise
Learn how global administrators can streamline organization and product management with export and import features in the Global Admin Console.
Access the Organizations tab in the Global Admin Console to export or import the organization structure. Go to the Product Allocation tab to view allocation data. Select the More Options (⋮) icon, and then choose Export or Import. Go here to sign in to the Global Admin Console.
Export the organization structure
As a global administrator, you can export the organization hierarchy. You can download a JSON, CSV, or XLSX representation of the entire organization hierarchy or a subset of it. You can then use this data for analysis or modification.
The export format chosen impacts the structure of the exported data:
- CSV format — Allows exporting only one kind of data at a time. When exporting product profiles in CSV format, the profiles and resources are combined into one table. There are multiple entries for the product profile, one for each resource.
- XLSX format — Results in each organization detail displaying in a separate sheet. Records are connected between the different object types by a reference id. In some cases, there may be multiple rows for a particular object (e.g., Resource objects when there are a set of values associated with a given resource).
- JSON format — The most flexible. It can take advantage of structural relationships between exported objects (e.g., products in an organization appear directly in the organization element). The same fields are exported in all three formats but some values are redundant in the JSON format.
Steps to export
-
Sign in to the Global Admin Console. In the Organizations tab, use the organization picker to select the organization hierarchy where you want to export. Data for all organizations in the hierarchy is exported.
-
Select the More Options ⋮ icon and choose Export.
-
In the Export dialog box, select what to export and a format to export the data in.
-
Select Export. The export file can take several minutes to generate. Once complete, to download the report, navigate to Global Admin Console > Insights > Export Reports.
After downloading the file, you can manipulate the data and then import it back. The updates imported appear in the Global Admin Console as though you have manually edited the data.
Import the organization structure
As a global administrator, you can import potentially modified data. When uploaded, the new data is compared with the current data and any changes are applied to the organization hierarchy. All import operations are performed on the updated copy of the organization hierarchy. If you have any pending changes, imported changes are added on top of the existing pending changes in the hierarchy.
Steps to import
- Sign in to the Global Admin Console. In the Organizations tab, use the organization picker to select the organization hierarchy where you want to perform the import.
- Select the More Options ⋮ icon and select Import. Depending on the size and complexity of the import file, processing can take from a few seconds to several minutes.
- Select Select a file, and choose a JSON, CSV, or XLSX file to be uploaded. For CSV, only one organization detail can be imported at a time and it does not support importing Products. The imported changes appear as though you have manually edited the data.
- Select Close.
- Select Review Pending Changes. Then, select Submit Changes to execute them. Before executing the changes, the pending actions are displayed in the same manner as when edits are made manually in the Global Admin Console.
Export and import schemas
While importing data using a CSV file, the fields can appear in any order but must always match their header row.
While importing data, you must specify an operation for each element. The operation can be any one of the following:
- Update: indicates an edit.
- Create: indicates creating a new object (for example, organization, user group, or administrator).
- Delete: indicates deletion of an object (for example, organization, user group, or administrator).
Input records with no or blank operation field are ignored.
Organizations
Import requirements:
- For update or delete, orgId must refer to an existing organization in your hierarchy.
- If you are creating a new organization, you can leave the orgId field blank or set it to a unique id that you can make up (such as new-1 or new-2). This provides an id that can be used to refer to the to-be-created organization.
- Country code should be valid.
- orgId for Update and Delete operation should already be present in the organization hierarchy.
- orgId marked as Delete should not be selected as a parentOrgId for organizations with Update or Create operation.
- Child organizations at the same level and of the same parent should not have the same orgNames.
- For creating an organization or updating an organization name, the organization’s name must not match the name of an existing child of the same parent.
Admins
Import requirements:
- orgId, email, adminType and userType must contain valid values.
- countryCode must be valid.
- If the user already exists and is being updated, the userType must match the user.
- Check for duplicate email addresses in the organization.
Product profiles
Exports and imports of product profiles consist of two parts: the product profile details, and a set of resources associated with the product profile. These resources identify services which can be configured, usually just to enable or disable them.
- The resource objects are nested within the product profile in JSON format.
- When using CSV or XLSX with product profiles, the profiles and resources are combined into one table. There will be multiple entries for the product profile, one for each resource.
- The selected field in the resource controls whether the service is enabled.
- When importing product profiles, there must be a Create or Update operation on the product profile itself and on any resource objects that are to be updated or created.
Import requirements:
-
productProfileId, licenseId and orgId must have valid values.
-
When creating a product profile, the productProfileName must be a valid name and must not duplicate another product profile name or user group name in the same organization.
-
The quota field must have a valid value for the unit type. This is numeric or unlimited when resourceType=QUOTA or blank otherwise.
-
The notification field must be true or false.
-
For CSV and XLSX imports, validate productProfileId; all its entries must have the same orgId, licenseId, and productProfileName.
-
Validate duplicate productProfileName in the input file and the organization.
-
Profiles to be updated and deleted must be present in the organization.
-
Resources to be updated and deleted (deactivated) must be present in the profile.
-
For profiles to be created, ensure the following:
- The orgId should be a new organization or an existing organization.
- The licenseId should be a new product or an existing product.
- Validate the resources for the profile.
Resources in product profiles
Import requirements:
- Operation field on resources is ignored when the product profile to which they belong has operations set as Delete or Create.
- No resource should be marked for deletion; it is an invalid operation.
- For product profiles to be created, the number of resources should match the source product profile’s number of resources.
- For resources with Update operation, the resource must be present in the product profile.
User groups
Import requirements:
-
orgId must refer to an existing organization or an organization being created in the same import.
-
userGroupId must refer to an existing group for update or delete, and can be an id you define for new user groups.
-
For update or create, userGroupName must not be blank and must not duplicate another user group or product profile name in the same organization.
-
Ensure userGroupName is not duplicate in the input file and the organization.
-
userGroups to be updated and deleted must be present in the organization.
-
Profile to be removed from user group must be present in the user group. Update operations cannot be performed on the profile of a user group.
-
For user groups to be created, ensure the following:
- The orgId should be a new organization or an existing organization.
- The licenseId, if applicable, should be a new product or an existing product.
- The productProfileId should be a new product profile or an existing product profile.
Domains
The domain information provides read-only information about domains available in each organization. This data is not editable.
Products and resources products-and-resources
In XLSX files, there are two sheets—one for products and one for the resources. In JSON, resource objects are nested in the product object.
Products
Import requirements:
- For create, licenseId must be a unique id that you create.
- For update, licenseId must be the id of an existing product in the organization specified.
- orgId must refer to an existing organization or one that is being created in the same import operation.
- For create, sourceLicenseId must refer to an existing product or the id you defined for a product being created in the same import operation.
- licenseId and sourceLicenseId should not be same for products with Create operation.
- Validate organizations of products; the organization should be a new one or should already be present in the organization hierarchy.
- For Update and Delete operation, product should already be present in the organization hierarchy.
- licenseId marked as Delete should not be used as a sourceLicenseId of products with Create and Update operation.
- For products with Create operation, validate that the sourceLicenseId should be present in the parent organization.
Resources for products
Resource objects can appear in products and in product profiles.
Import requirements:
Operation field on resources is ignored when the product to which they belong has operations set as Delete or Create.
- No resource should be marked for deletion; it is an invalid operation.
- For products to be created, the number of resources should match the source product’s number of resources.
- For resources with Update operation, the resource must be present in the product.
Import and export product allocation data
As a Global Administrator, you can export the product allocation data as a JSON or CSV file. You can then modify this data and upload it to import the changes. When the potentially modified data is uploaded, the new data is compared with current data and any changes are applied to the product allocation data. You can then review and submit the pending changes for them to take effect.
Export the product allocation model
To export the product allocation model, do the following:
- Sign in to the Global Admin Console and navigate to the Product Allocation tab.
- Select the More Options ⋮ icon, and then select Export CSV or Export JSON. Your file is downloaded. Learn more about the export formats.
Import the product allocation model
You can export data, modify it, and then import the modified file. To import the product allocation model, do the following:
- Sign in to the Global Admin Console and navigate to the Product Allocation tab.
- Select the More Options ⋮ icon and select Import.
- Select a JSON or CSV file to upload.
- Select Review Pending Changes. After reviewing the changes, select Submit Changes to execute them.
Export and import formats for product allocation
The export and import formats are the same. While importing in CSV format, the fields can appear in any order, but they must match the header row. While importing in JSON format, the fields can appear in any order.
You must specify the operation while importing product allocation data. The operation can be one of the following:
- Update: indicates an edit (change to grantedQuantity, allowOverAllocation values).
- Create: indicates to add a product resource to the specified organization.
- Delete: indicates deletion of product.
If no operation is given, then no changes occur when data is imported for that row in CSV or object in JSON.
In the exported file, there is one row or record for each product resource. Some products have more than one resource.
If a product has more than one resource, Update operations can apply to independent resources, a Delete operation deletes the product including all resources from an organization, and a Create operation needs a record for each of the resources in the import file so that the proper quantity of each of them can be specified. The allowOverAllocation field is product-wide and it does not matter which resource an update to this field is in.
Description of headers
Import requirements
Data validation
-
The operation field must have a valid operation.
-
The product import data must have properties and values for required fields.
-
The product import data properties must be of the correct type.
-
The product policy field (overAllocation) must not be provided for different resources.
-
The grantedQuantity field:
- Can’t be changed to unlimited if it is not already unlimited.
- Must be a non-negative integer or the string value unlimited.
Permission/accessible validation
- The organization associated with the import data must exist. If you are updating, ensure that the product and resource associated with the import data actually exist.
Add product validation
- SourceLicenseId must exist.
- Organization associated with the new product must exist.
- The product being created must not exist (product with same licenseId).
- The resources associated with a product being created must have a corresponding productId that matches that product.