addUsersToGroup

Adds a batch of users to an existing group in Access Control using an ANSI or UTF-8 encoded CSV file that was uploaded to the environment.

You use the uploadFile command to upload files to an environment. User login value is not case-sensitive. The file format is as follows:

User Login
jdoe
john.doe@example.com

Note:

User is added to group only if both these conditions are met:

  • User Login value included in the file exists in the identity domain that services the environment. User Login values are not case-sensitive.
  • The user is assigned to a predefined role in the identity domain

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, FreeForm, Financial Consolidation and Close, Tax Reporting, Profitability and Cost Management, Oracle Enterprise Data Management Cloud, Enterprise Profitability and Cost Management, Narrative Reporting, Oracle Strategic Workforce Planning Cloud, and Oracle Sales Planning Cloud.

Required Roles

Service Administrator

Usage

epmautomate addUsersToGroup FILE_NAME GROUP_NAME where:
  • FILE_NAME is the name of a CSV file containing the login names of users you want to assign to a group in Access Control.
  • GROUP_NAME is the name of a group existing in Access Control. This value is not case-sensitive.

Example

epmautomate addUsersToGroup user_file.CSV example_group