User Guide

Updating Users With a Utility
The ProvisionUsers utility—run by administrators through a command line interface—
synchronizes users maintained in User Management Console with a Planning application.
➤ To use the utility, launch the ProvisionUsers.cmd file from the bin directory, using the
following syntax:
ProvisionUsers /ADMIN: adminName /PASS: password /A: appName [/U: user1
[;user2;user3]
] [/R: n ]
If you installed Planning in the default location, the bin directory is in this path:
< HYPERION_HOME> :/Planning/bin.
Table 31 ProvisionUsers Syntax
Parameter
Description Required?
/ADMIN:adminName The administrator's name for logging on to the Planning
application.
Yes
/PASS:password The administrator's password. Yes
/A: appName The Planning application to synchronize (must be on the server on
which the utility is run).
Yes
[/U: user1[;user2;user3] ] Specifies users to synchronize. For example, to synchronize users
Planner1 and Planner2, use
/U:Planner1;Planner2.
Omitting this argument synchronizes all users.
No
[/R :n ] Specifies an interval, in minutes, in which synchronization is run.
For example, to synchronize every 30 minutes, use
/R:30.
Omitting this argument performs the synchronization once.
No
/? Specified by itself, prints the syntax and options for
ProvisionUsers.
No
Example 1
Entering:
ProvisionUsers /ADMIN:admin /PASS:password /A:App1
Synchronizes all users in the App1 application.
Example 2
Entering:
ProvisionUsers /ADMIN:admin /PASS:password /A:App2 /U:Planner1 /R:60
Synchronizes user Planner1 in the App2 application every 60 minutes.
Updating Users and Groups in Planning
169