Overview of bulk add

The Import Users (bulk upload) feature allows you as an enterprise administrator to create a file consisting of user identities and to submit this file to the enterprise customer admin user management page for processing. Each entry in the file represents a user and the result of processing is that each user has an account created. Since many thousands of accounts can be involved, the status and progress of processing is displayed to you, and you can cancel the processing of the file at any time.

Enterprise accounts are created as a result of a customer purchase of a license agreement with Adobe that entitles the customer to a specified number of licenses to various Adobe products. On the completion of the purchase transaction, an agent at Adobe creates an account for the organization and creates a user with administrative capabilities for that account. That administrator can create and manage the user accounts for members of their organization.

Note:

The Import Users feature does not support user nicknames having special characters, such as the comma (,) and the semicolon (;).

Function

When a file is selected for processing, the following pre-checks are made and error messages emitted in case checks fail.

  • File in CSV format
  • Header legal, if present
  • 1-5000 entries

For each entry:

  • The email address should be legal
  • Zero or more specified product configurations
  • Country, if present, is legal and a country where Adobe does business
  • Options, if present, are legal

A limit of 5000 entries per file is the maximum that can be processed for each import operation.

When a file is processed, each entry is processed individually as follows:

Email address domain is

Action

Exceptions

Claimed by organization and Adobe managed Adobe ID account is created with given email address. Welcome email is sent.

Already has an invitation in progress or account with given email exists.

Country, if present, is not open for Adobe business.

Product configurations illegal or quota exceeded.

Claimed by organization and Enterprise managed Person record is created with the specified user name. Add to specified product configurations. Email address not used except to determine domain. No email sent.

User name exists.

Country, if present, is not open for Adobe business.

Product configurations illegal or quota exceeded.

Not claimed by organization

Send invitation email to user email address. No account created. That invite is associated with the product configurations listed.

If account exists, add to product configurations.

Already has an invitation or account with given email.

Country, if present, is not open for Adobe business.

When processing of all file entries is completed, an email message is generated to the initiating user informing them of completion and results summary.

If the import operation is canceled, processing ceases when practical. Processing that has been completed is not rolled back.

User interface

In the List Users panel of the administrative console, there is an icon for uploading a user file. The file must be of type "csv" and have a .csv suffix. Its format is described below.

When import in selected, a dialog shows that displays instructions, has a link to download a sample file, and has a link to browse and select a file for upload and processing.

Once a file is selected for processing, it is prechecked for validity and any detectable errors reported. If there are none, the file is saved on the server and processing begins. Only a single import operation can be in progress for a given organization (regardless of domain) so subsequent initiation of import operations is disabled until the first one is completed.

When accepted for processing a line is displayed in Import Results tab of the List Users panel. The entry shows the following:

  • Filename
  • date/time of upload and start of processing
  • Status (Processing / Completed / Canceled) (updated periodically)
  • Number of accounts created (updated periodically)
  • Number of errors (updated periodically)
  • Processing rate (entries/second) (updated periodically)
  • Estimated time remaining (updated periodically)
  • A control to cancel the operation (only when processing is in-progress)
  • Link to report (when processing has finished)
  • A control to delete the entry (when processing has finished)

Clicking the filename gives a pop-up report with more details of the processing when status is Completed or canceled. Summary counts of successes and various kinds of failures are shown. Only nonzero values are displayed.

As processing occurs, any created users begin to show up in the Active User List if it is displayed (or the count updated if that is displayed).

As processing occurs, and user invitations generated show up in the Pending invites list if it is displayed (or the count updated if that is displayed)

The report is available when processing finishes and shows the results for each entry processed. In the report, there are three columns:

  • Line number
  • Email address
  • status and error message (if any)

The report is sorted by line number and the line numbers correspond to the original line number in the csv file.

Important: The Import Results page displays reports that are 90 days old or less. Reports that are more than 90 days old are automatically removed, without the interference of a System Admin.

File format

The file that lists the users must conform to RFC 4180 (CSV file specification).  If present, the header line must be as follows:

Type, Email, ProductConfigurations, user name, CountryCode, FirstName, LastName, Options

Note: these fields may change periodically. Make sure your header matches the latest sample from the Admin Console.

These fields are defined as follows:

Field

Syntax

Interpretation

Type One of the values Adobe ID, Enterprise ID, or Federated ID. These values control the ID type assigned to the user. Not case sensitive. The ID type must be valid for the domain.
Email

RFC 2822 sec 3.4.1

60 character max

A name and domain. For Enterprise administered domains, only the domain name is used. The user name determines the account name. For other account types, it is the email address used for the user and account name.
ProductConfigurations A comma-separated list of product configuration nicknames The product configuration nickname to which you want to assign the user. You can assign the user to multiple product configurations in one go; separate the configuration names with commas. For example, "Audience Management:Audience Manager - Default Access, Custom plan only - Custom plan - Design"
User name Any string. Restricted to ASCII. Only used in Enterprise administered domains. Account name to be used for this user. Restrictions to email address and same email address can be imposed by domain owner. Max length 255
CountryCode ISO 3166-1 alpha-2 Country Codes This is a two-letter country code (for example, United States = "US") If present, checked to insure that user is from a country where Adobe can legally do business. Must be present for Enterprise administered accounts.
FirstName String Max length 255
LastName String Max length 255
Options

Comma-separated list of names. This field is for future use

Expected future values:

NoEmail: suppress sending of welcome email for accounts.

ResetPassword: flag account for reset of password

Download

Troubleshoot bulk upload

This section helps you troubleshoot error conditions or other problems that could arise when using the bulk import functionality with the Adobe Admin Console.

"Invalid Configuration Names" error

If you are getting the error "Invalid Configuration Names" ("INVALID_CONFIGURATIONS") check the product configuration in the Admin Console:

  • If the product configuration is "Default configuration" this is a virtual configuration provided as an example. You must edit this configuration to convert it to a real, working product configuration.
  • If you create a new product configuration "Default configuration" will disappear.
  • After editing the product configuration or creating a new one, try the bulk import again.

Validate CSV format

Validate your CSV file by comparing it to the sample template in the dashboard. The important fields are first name, last name, user ID, email address, and country code.

If the user exists, the import doesn't fail. Instead, you see a message that the user exists in the bulk upload report.

The upload report lists other errors separately from existing user warnings.

Import Error

Required fields for the different types of User ID:

Type Email ProductConfigurations User name Country Code FirstName LastName Options
Adobe ID Required Optional Optional Optional Optional Optional Optional
Enterprise ID Required Required Optional Optional Optional Optional Optional
Federated ID Required Required Required Required Optional Optional Optional

Known issues

The import error message in the bulk import report is currently truncated on the right side. This will be corrected in a future build of the Admin Console.

Import error conditions, messages, and response codes

 

Situation

Message

Notes

CSV File Heading line invalid

 

Invalid header line in CSV file. Header line must be 

Type, Email, ProductConfigurations, user name, CountryCode, FirstName, LastName, Options

 

Import is rejected at upload time and batch import does not run.

CSV File Heading line is missing

 

Invalid header line in CSV file. Header line must be 

Type, Email, ProductConfigurations,user name, CountryCode, FirstName, LastName, Options

 

Import is rejected at upload time and batch import does not run.

Improper number of columns in heading line Invalid file format at line 2: For help, refer to sample. csv file line has wrong number of columns Import is rejected at upload time and batch import does not run.
Improper number of columns in data line

Invalid file format at line 2: For help, refer to sample. csv file line has wrong number of columns

Import is rejected at upload time and batch import does not run.
No data lines in CSV or 1 data line and missing heading line Invalid file. Add at least one user to file and try again. For help, refer to sample.  Import is rejected at upload time and batch import does not run.
Type value is invalid

Invalid file format at line 2: Identity type must be one of Adobe ID, Enterprise ID, or Federated ID. (Line number 2.)

Import is rejected at upload time and batch import does not run
Email address is invalid

Invalid file format at line 2: valid email address expected. (Line number 2.)

Import is rejected at upload time and batch import does not run
Email address belongs to another domain see below  
Country code invalid: is not two letters Invalid file format at line 2: Country code must conform to ISO 3166-1 alpha-2 (two character country code). (Line number 2.) Import is rejected at upload time and batch import does not run. Must be legal and a a country that Adobe does business with.
Country code is banned (for example, KP) Invalid Country code. Appears as message in report, and in summary.
Country code is two letters but not a valid code (for example, AB) Invalid Country code. Appears as message in report, and in summary.
Firstname or Lastname or user name or Options too long (> 255) Invalid file format at line 3: A string exceeds 255 characters. (Line number 3.) Import is rejected at upload time and batch import does not run.
User name not an email address Invalid user name.

This depends on whether the auth source requires this.

Also appears in summary.

User name and email address must match Invalid user name. The user name and email address must be the same for this organization

This depends on whether the auth source requires this.

Invalid user name. appears in summary

Email address not in proper domain Email domain is not owned. This user is managed by another organization or has a different type. Email domain is not owner. appears in the summary.
Options field has illegal value   No checking or messages at present
Internal error Internal error: <string>  
User already invited Already invited as Adobe ID user. An invitation has already been sent. First part appears in summary.
User already in organization Already associated with organization. The user xxx> is already associated with your organization. First part appears in summary.
Unsupported Encoding   Encoding is type not supported.

Some specific cases:

Org Domain & type

Preconditions

Action

Expectation

Message

d3 is Type3 claimed User u@d3 exists Type3 Add u@d3 as Type1 Error Already associated with organization. This user exists
  any Add u@d3 as Type2 Error Email domain is not owned. This user is managed by another organization or has a different type.
  User u@d3 exists Type3 Add u@d3 as Type3 Error Already associated with organization. The user u@d3 is already associated with your organization.
  User u@d3 exists Type1 in org Add u@d3 as Type1 Error Already associated with organization. The user u@d3 is already associated with your organization..
  User u@d3 exists Type1 in org Add u@d3 as Type3 Error Already associated with organization. The user u@d3 is already associated with your organization.
 

User u@d3 invited Type1

u@d3 does not exist

Add u@d3 as Type1 Error Already invited as Adobe ID user. An invitation has already been sent. 
 

User u@d3 invited Type1

u@d3 does not exist

Add u@d3 as Type3 Error Already invited as Adobe ID user. An invitation has already been sent. 
 

User u@d3 invited Type1

u@d3 created Type1 after invite

Add u@d3 as Type1 Error Already invited as Adobe ID user. An invitation has already been sent. 
 

User u@d3 invited Type1

u@d3 created Type1 after invite

Add u@d3 as Type3 Error

Already invited as Adobe ID user. An invitation has already been sent. 

 

 

User u@d3 invited Type1

u@d3 created Type1 before invite

Add u@d3 as Type1 Error Already invited as Adobe ID user. An invitation has already been sent. 
 

User u@d3 invited Type1

u@d3 created Type1 before invite

Add u@d3 as Type3 Error Already invited as Adobe ID user. An invitation has already been sent. 
  User u@d3 exists Type1 not in org Add u@d3 as Type3 Success  
  d2 not claimed by this org

Add u@d2 as Type3

Error Email domain is not owned. This user is managed by another organization or has a different user type.
         
d2 is type 2 claimed User x@y invited Type2 to d2 Add x@y as Type1 Error Already invited as Adobe ID user An invitation has already been sent.
  any Add u@d3 as Type2 Error Email domain is not owned. This user is managed by another organization or has a different type.
  any Add x@y as Type3 Error Email domain is not owned. This user is managed by another organization or has a different type.
         

Peformance details

To avoid overloading, a 66.6% duty cycle rule is part of processing.  If the time to process an entry differs from the rolling average by more than 10%, then the throttle is adjusted so that request processing consumes only 2/3 of real time.

In addition, an operations team managed throttling control also limits the processing rate.  If the throttling control is explicitly set, then the duty cycle control is disabled. There is an API call to switch back to duty cycle-based throttling.

The number of requests processed per second is displayed to you to provide feedback on performance.

The target rate for creation of 1000 accounts with each being added to 2 product configurations is 1 account/second, not counting the 66.6% duty cycle, so the apparent processing rate would be .66 account/second, or about 40 accounts/minute.  Creation of 1000 accounts at this rate would take 25 minutes.  Creation of 5000 accounts at this rate would take two hours and five minutes.

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy