Skip to content

Commit 979fd30

Browse files
committed
Update to push section based on Dan's excellent comments and suggestions.
1 parent 7a0c0db commit 979fd30

File tree

1 file changed

+74
-22
lines changed

1 file changed

+74
-22
lines changed

docs/en/user-manual/advanced_configuration.md

Lines changed: 74 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -513,53 +513,91 @@ as shown above. The effect of this is to treat all users contained directly in
513513

514514
## Using Push Techniques to Drive User Sync
515515

516-
Starting with User Sync version 2.2 it is easier to drive push notifications directly to
516+
Starting with User Sync version 2.2 it is possible to drive push notifications directly to
517517
Adobe's user management system without having to read all information from Adobe and
518518
your enterprise directory. Using push notifications has the advantage of minimizing
519519
processing time and communication traffic, but the disadvantage of not being self-correcting
520520
for changes made in other ways, or in case of some errors. More
521521
careful management of changes to be made is also required.
522522

523+
You should consider using a push strategy if:
524+
525+
- You have a very, very large population of Adobe users
526+
- You are making relatively few changes to existing users; that is, you are mostly adding new users and deleting ones who leave.
527+
- You have a process or tools that can identify new and departing users in an automated way.
528+
529+
The push strategy avoids all the overhead of reading large numbers of users from either side, and
530+
you can only do that if you can isolate the specific users that need to be updated (e.g., by
531+
putting them in a special group).
532+
523533
To use push notification, you will need to be able to gather updates to be made
524534
unconditionally into a separate file or directory group. User deletions also must
525535
be segregated from user additions and updates. Updates and deletions are then run
526536
in separate invocations of the User Sync tool.
527537

528-
### Using a special directory group to drive User Sync push
538+
Many approaches are possible using push techniques with User Sync. The next sections
539+
describe one recommended approach. To make it concrete, let us assume there are two
540+
Adobe products that have been purchased and are to be managed using User Sync: Creative Cloud,
541+
and Acrobat Pro. To grant access, assume you have created two product configurations named
542+
Creative_Cloud and Acrobat_Pro, and two directory groups named cc_users and acrobat_users.
543+
The map in the User Sync configuration file would look like this:
529544

530-
Create directory groups to collect users to be updated and deleted. For example,
531-
use a directory group Sync-CC-INCREMENTAL for new users that you want to sync in
532-
and provision for Creative Cloud. In this example, we will only consider one
533-
product; you would need additional directory and Adobe groups for other products.
545+
groups:
546+
- directory_group: acrobat_users
547+
adobe_groups:
548+
- "Acrobat_Pro"
549+
- directory_group: cc_users
550+
adobe_groups:
551+
- "Creative_Cloud"
534552

535-
In the main config file, Sync-CC-INCREMENTAL is mapped to the user group or product
536-
configuration representing Creative Cloud users.
537553

538-
Create another directory group, Sync-REVOKED, that you can move deleted users into
539-
if you want to remove their product access.
554+
555+
### Using a special directory group to drive User Sync push
556+
557+
An additional directory group is created to collect users to be updated. For example,
558+
use a directory group `updated_adobe_users` for new or updated users (those whose group membership
559+
has changed). Removing users from both of the mapped groups revokes any product access
560+
and frees licenses held by users.
540561

541562
The command-line to use to process the additions and updates is:
542563

543-
user-sync –t --strategy push --process-groups --users group Sync-CC-INCREMENTAL
564+
user-sync –t --strategy push --process-groups --users group updated_adobe_users
544565

545-
Notice the --strategy push on the command line: that’s what causes User Sync NOT
566+
Notice the `--strategy push` on the command line: that’s what causes User Sync NOT
546567
to try to read the Adobe-side directory first, and to instead just push the updates
547568
to Adobe.
548569

549570
Also notice the `-t` on the command line to run in "test mode". If the actions appear
550571
to be as you expect, remove the -t to have User Sync actually make the changes.
551572

552-
When `--strategy push` is specified, users are pushed over to Adobe with all of their mapped groups *added* and any mapped groups they are not supposed to be in *removed*. That way moving a user from one directory group to another, where they have different mappings, will cause that user to be switched on the Adobe side at the next push.
573+
When `--strategy push` is specified, users are pushed over to Adobe with all of their
574+
mapped groups *added* and any mapped groups they are not supposed to be in *removed*.
575+
That way moving a user from one directory group to another, where they have different
576+
mappings, will cause that user to be switched on the Adobe side at the next push.
577+
578+
This approach will not delete or remove accounts, but will revoke
579+
access to any products and free licenses. To delete accounts, a different approach is
580+
needed which is described in the next section.
581+
582+
The process to support this approach consists of the following steps:
553583

554-
The command-line you will want to use to process the deletions is:
584+
- Whenever you add a new user, or change a user’s groups in the directory (including
585+
removing from all groups, which essentially disables all product entitlements), you also
586+
add that user to the “updated_adobe_users” group.
587+
- Once a day (or at a frequency you choose), you run a sync job with the parameters
588+
shown above.
589+
- This job causes all the updated users to be created if necessary and to have their
590+
mapped groups updated on the Adobe side.
591+
- Once the job has run, you remove the users from the updated_adobe_users group (because
592+
their changes have been pushed).
555593

556-
user-sync –t --strategy push --process-groups --users group Sync-REVOKED
594+
At any time, you can also run a User Sync job in regular (non-push) mode to get the complete
595+
functionality of User Sync. This will pick up any changes that might have been missed,
596+
correct changes made not using User Sync, and/or perform actual account deletions.
597+
The command line would be something like:
557598

558-
The users to be removed will need to have been removed from any other mapped groups
559-
before this command is run. It will not delete or remove accounts, but will revoke
560-
access to any products and free licenses.
599+
user-sync --process-groups --users mapped --adobe-only-user-action remove
561600

562-
To delete accounts, a different approach is needed which is described in the next section.
563601

564602
### Using a file to drive User Sync push
565603

@@ -572,8 +610,8 @@ Create a file “users-file.csv” with information on users to add or update. A
572610
the file is:
573611

574612
firstname,lastname,email,country,groups,type,username,domain
575-
Jane 1,Doe,[email protected],US,Sync-CC-INCREMENTAL
576-
Jane 2,Doe,[email protected],US,Sync-CC-INCREMENTAL
613+
Jane 1,Doe,[email protected],US,acrobat_users
614+
Jane 2,Doe,[email protected],US,"cc_users,acrobat_users"
577615

578616
The command line to push updates from the file is:
579617

@@ -597,7 +635,21 @@ The command line to process deletions based on a file like this (say remove-list
597635
user-sync -t --adobe-only-user-list remove-list.csv --adobe-only-user-action remove
598636

599637
The action "remove" could be "remove-adobe-groups" or "delete" to keep the account in the organization
600-
or to delete it, respectively.
638+
or to delete it, respectively. Also note `-t` for test mode.
639+
640+
The process to support this approach consists of the following steps:
641+
642+
- Whenever you add a new user, or change a user’s groups in the directory (including
643+
removing from all groups, which essentially disables all product entitlements), you also
644+
add an entry to the "users-file.csv" that includes the groups the user should be in. This might
645+
be more or fewer groups than they are currently in.
646+
- Whenever a user is to be removed, add an entry to the "remove-list.csv" file.
647+
- Once a day (or at a frequency you choose), you run the two sync job with the parameters
648+
shown above (one for adds and updates and one for deletions).
649+
- These jobs causes all the updated users to have their mapped groups updated on the Adobe
650+
side, and removed users to be removed from the Adobe side.
651+
- Once the job has run, clear out the files (because their changes have been pushed) to prepare for
652+
the next batch.
601653

602654
---
603655

0 commit comments

Comments
 (0)