exportUserVariableValues

Exports user variable values.

User variables serve as filters in forms. By setting user variables, you can restrict the members shown on a form, allowing users to focus on specific members, such as a particular department. Use this command to export the values assigned to a single user variable, all user variables set for a specific dimension member, or the variables set for a specific user. The resulting file can be used to import user variable values into another environment using the importUserVariableValues command or the related REST API.

Applies to

Planning, Planning Modules, FreeForm, Financial Consolidation and Close, Tax Reporting, Enterprise Profitability and Cost Management, Sales Planning, and Strategic Workforce Planning

Required Roles

Service Administrator

Usage

epmautomate exportUserVariableValues
                FILE_NAME.csv
                    [variable=VARIABLE][member=MEMBER][userName=USERNAME]

, where:

FILE_NAME identifies the name of a file for storing the exported user variable values. Any existing file with this name will be overwritten. The export process creates a .CSV formatted file.
variable, optionally, exports only the user variable values (user names, dimensions, and members) associated with the specified user variable.
member, optionally, exports only the user variable values (users, dimensions, and variables) associated with the specified dimension member.
userName, optionally, exports only the user variable values (dimensions, variables, and members) applicable to the specified user.

Note:

By default, if you do not specify a variable, member or user, this command exports the values of all user variables associated with all members and users.
You can export user variable values using a combination of variable, member, and userName values.

Examples

Export the user variables values associated with all members and users: epmautomate exportUserVariableValues myExportFile.csv
Exports only the user variable values associated with a specified user variable: epmautomate exportUserVariableValues myExportFile.csv variable="Account View"
Exports the user variable values associated with a specific user and dimension member: epmautomate exportUserVariableValues myExportFile.csv member=Account1 userName=example@example.com