addUsers

Creates a batch of users in an identity domain using an ANSI or UTF-8 encoded Comma Separated Value (CSV) file that was uploaded to the environment. Also informs new users of their user name and temporary password.

You use the uploadFile command to upload files to an environment. The file format is as follows:

First Name,Last Name,Email,User Login
Jane,Doe,jane.doe@example.com,jdoe
John,Doe,john.doe@example.com,john.doe@example.com

See Importing a Batch of User Accounts in Getting Started with Oracle Cloud for a detailed description of the CSV file format.

If a user definition in the CSV file matches a user account that exists in the identity domain, no changes will be made to the existing user account. This command creates accounts only for new users whose account information is included in the file. Because user accounts are common to all environments that an identity domain supports, new users are available to all the environments that share the identity domain.

Note:

  • You need both Service Administrator and Identity Domain Administrator roles to run this command.
  • Oracle Enterprise Performance Management Cloud utilities require users to use their identity domain credentials. See " Ensuring that Users Can Run EPM Cloud Utilities After Configuring SSO " in Getting Started with Oracle Enterprise Performance Management Cloud for Administrators .

When the command execution finishes, EPM Automate prints information about each failed entry to the console. Review this information to understand why the command execution failed for some entries in the CSV file.

Applies to

Planning, Planning Modules, Financial Consolidation and Close, Tax Reporting, Account Reconciliation, Profitability and Cost Management, Oracle Enterprise Data Management Cloud, Narrative Reporting, Oracle Strategic Workforce Planning Cloud, and Oracle Sales Planning Cloud.

Usage

epmautomate addUsers FILE_NAME [userPassword=PASSWORD] [resetPassword=true|false] where:

  • FILE_NAME is the name of a CSV file containing user information. Input file containing multi-byte characters must use UTF-8 character encoding. Using ANSI encoding causes issues in how user information is displayed in My Services screens.
  • userPassword, optionally, indicates the default password for all the new users who are created in the identity domain. If specified, this password must meet the minimum identity domain password requirements. If the parameter is not specified, a unique temporary password is assigned to each user.

    If specified, the value of the userPassword parameter is used as the password for all users specified in the CSV file. Assigning the same password to all users may be desirable if you are creating users purely for testing purposes. If you are creating real EPM Cloud users and want to assign a specific password to each user, use this command without specifying a value for the userPassword optional parameter.

  • resetPassword, optionally, indicates whether new users must change password at the first log in. Default is true. Unless this parameter is set to false, new users will be forced to change the password at the first sign in.

    This command sends each new user an email with details about their accounts (user name and password) if resetPassword is set to true. If resetPassword is set to false, the email is not sent. If you set resetPassword to false, you must specify userPassword. Otherwise, a unique temporary password will be assigned to each user but because no email is sent, the passwords will not be known to the users and they will not be able to login.

Examples

  • Add test users in the identity domain with the same password and not require them to change password:

    epmautomate addUsers user_file.CSV userPassword=Example@Pwd12 resetPassword=false

  • Add users to identity domain using a temporary password and require them to change it:

    epmautomate addUsers user_file.CSV