Make a Test Run To Check Configuration #

To invoke user sync:

Windows: .\user-sync.exe [command options]

Linux: ./user-sync [command options]

Running the command with -h/--help or -v/--version will ensure the tool works in your envionment.

./user-sync –v    # Report version
./user-sync –h    # Get command help

These commands ought to produce an output similar to the following:

>  .\user-sync.exe -v
user-sync.exe 2.9.1

>  .\user-sync.exe -h
Usage: user-sync.exe [OPTIONS] COMMAND [ARGS]...

  User Sync from Adobe

  Full documentation:

  https://adobe-apiplatform.github.io/user-sync.py/en/user-manual/

  NOTE: The defaults documented here can be overridden in
  `invocation_defaults` in `user-sync-config.yml`.  However, any options
  explicitly set on the command line will override any options set in
  `invocation_defaults`.

  COMMAND HELP:

  user-sync [COMMAND] -h/--help

Options:
  -h, --help     Show this message and exit.
  -v, --version  Show the version and exit.

Commands:
  sync*           Run User Sync [default command]
  docs            Open user manual in browser
  example-config  Generate example configuration files

Try a sync limited to a single user and run in test mode. You need to know the name of some user in your directory. For example, if the user is bart@example.com, try:

./user-sync -t --users all --user-filter bart@example.com --adobe-only-user-action exclude
./user-sync -t --users all --user-filter bart@example.com --process-groups --adobe-only-user-action exclude

The first command above will sync only the one user (because of the user filter) which should result in an attempt to create the user. Because of running in test mode (-t), the run of user-sync will only attempt to create the user and not actually do it. The --adobe-only-user-action exclude option will prevent updates to any user accounts that already exist in the Adobe organization.

The second command above (with the –process-groups option) will attempt to create the user and add them to any groups that are mapped from the their directory groups. Again, this is in test mode so no actual action will be taken. If there are already existing users and the groups have users already added to them, user-sync may attempt to remove them. If this is the case, skip the next test. Also, if you are not using directory groups to manage product access, skip the tests that involve –process-groups.

Try a sync limited to a single user and don’t run in test mode. This should actually create the user and add to groups (if mapped).

./user-sync --users all --user-filter bart@example.com --process-groups --adobe-only-user-action exclude
./user-sync --users all --user-filter bart@example.com --process-groups --adobe-only-user-action exclude

Next, go check on the Adobe Admin Console if the user has appeared and the group memberships have been added.

Now try re-running the same command. User sync should not attempt to recreate and re-add the user to groups. It should detect that the user already exists and is a member of the user group or PC and do nothing.

If these are all working as expected, you are ready to make a full run (without the user filter). If you don’t have too many users in your directory, you can try it now. If you have more than a few hundred, it could take a long time so don’t do the execution until you are ready to have a command running for many hours. Also, go over the next few section before doing this in case there are other relevant command line options.