Skip to content

Commit efd7c7e

Browse files
authored
Merge pull request #156 from adobe-apiplatform/v2
merge 2.0rc2 to master
2 parents e15dd4f + 869e9f6 commit efd7c7e

24 files changed

+203
-146
lines changed

docs/success-guide/command_line_options.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Note that only the users returned by the directory query and filter are consider
5555

5656
`--test-mode`: causes User Sync to run through all processing including querying the directory and calling the Adobe User Management APIs to process the request, but no actual action is taken. No users are created, deleted, or altered.
5757

58-
`--update-user-info`: causes User Sync to check for changes in first name, last name, or email address of users and make updates to the Adobe information if it does not match the directory information. Specifying this option increases run time so you may not want to include it on each run.
58+
`--update-user-info`: causes User Sync to check for changes in first name, last name, or email address of users and make updates to the Adobe information if it does not match the directory information. Specifying this option may increase run time.
5959

6060

6161
## Examples
-18.5 KB
Loading
22 KB
Loading
55.5 KB
Loading
-42 KB
Loading
19.5 KB
Loading

docs/success-guide/install_sync.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,11 @@ Select “release”
3232

3333
![install2](images/install_release_screen.png)
3434

35-
☐ Download the examples.config.tar.gz, User Sync Guide, and build for your platform, osx, ubuntu, windows, or centos.
35+
☐ Download the example-configurations.tar.gz, User Sync Guide, and build for your platform, osx, ubuntu, windows, or centos.
3636

3737
☐ Extract the user-sync (or user-sync.pex) file from the archive and place the file for your OS in the folder. In our example, this would be /home/user_sync/user_sync_tool/user-sync or C:\Users\user_sync\user_sync_tool\user-sync.pex.
3838

39-
☐ In the examples.config.tar.gz file there is a directory **config files - basic**. From this folder extract the first 3 files and place in the user_sync_tool folder.
39+
☐ In the example-configurations.tar.gz file there is a directory **config files - basic**. From this folder extract the first 3 files and place in the user_sync_tool folder.
4040

4141
☐ Next, rename the 3 config example files by removing the leading "1 ", "2 ", and "3 " from the names. We will edit these files to create the real User Sync configuration files.
4242

docs/success-guide/layout_products.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,12 @@ You can use User Sync to manage PC membership and license allocation. This is o
2121

2222
User Sync helps you manage Adobe product licenses by allowing you to place users into directory groups using the directory system interface or other tools. Those groups are then mapped to Adobe user groups or PCs. The mapping is part of the User Sync configuration file. When User Sync detects that directory users are in one of these mapped groups, the user is added to the corresponding Adobe user group or PC. Similarly, users in the user group or PC but not in the corresponding directory group are removed from the user group or PC.
2323

24-
☐ Decide if you will manage license allocation using User Sync. If not, you can skip the remaining steps for now, but you will still need to do them and manually add users to the user groups or PCs later using the Adobe Admin Console.
24+
☐ Decide if you will manage license allocation using User Sync. If not, you can skip the remaining steps; however, before the users you create can access Adobe products, you will need to manually add them to product configurations using the Adobe Admin Console.
2525

26-
☐ Create the PCs in the Adobe Admin console for the configurations of products and groups of users you will be managing.
26+
☐ Create the PCs in the Adobe Admin console for the product configurations and groups of users you will be managing. Add the comment "Managed by User Sync - do not edit" to the description field of the PC.
27+
28+
☐ If you are going to use User Groups to manage product access, you will need to first create the user groups and the product configurations, then you can manage product access by adding each user group to the appropriate product configurations. Add the comment "Managed by User Sync - do not edit" to the description field of the user group.
2729

28-
☐ If you are going to use User Groups, create them and add them to the PC(s) representing product licenses to be issued to members of the user group.
2930

3031
☐ Draw a diagram of your Adobe organizations, and the products and PCs in each. Add the directory and directory groups to the picture and show the mapping. For example:
3132

docs/success-guide/scheduling.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ layout: default
1212
First, create a batch file with the invocation of user-sync piped to a scan to pull out relevant log entries for a summary. Create the file run_sync.bat for this with contents like:
1313

1414
cd user-sync-directory
15-
python user-sync.pex --users file example.users-file.csv --process-groups | findstr "==== ----- WARNING ERROR CRITICAL" > temp.file.txt
15+
python user-sync.pex --users file example.users-file.csv --process-groups | findstr /I "==== ----- WARNING ERROR CRITICAL Number" > temp.file.txt
1616
rem email the contents of temp.file.txt to the user sync administration
1717
your-mail-tool –send file temp.file.txt
1818

@@ -34,7 +34,8 @@ Note that often when setting up scheduled tasks, commands that work from the com
3434
First, create a shell script with the invocation of user-sync piped to a scan to pull out relevant log entries for a summary. Create the file run_sync.sh for this with contents like:
3535

3636
cd user-sync-directory
37-
./user-sync --users file example.users-file.csv --process-groups | grep "CRITICAL\\|WARNING\\|ERROR\\|=====\\|-----" | mail -s “Adobe User Sync Report for `date +%F-%a`” [email protected]
37+
./user-sync --users file example.users-file.csv --process-groups | grep "CRITICAL\\|WARNING\\|ERROR\\|=====\\|-----\\|number of\\|Number of" | mail -s “Adobe User Sync Report for `date +%F-%a`”
38+
3839

3940

4041
You need to fill in your specific User Sync command line options and the email address to which the report should be sent.

docs/success-guide/setup_adobeio.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Setup steps are documented. For complete information about the integration setu
1818
- Once setup, the Adobe.io console displays all needed values. You’ll copy these into the user sync configuration file.
1919
- You'll also need to add the private key file to the User Sync configuration.
2020

21-
☐ Obtain or create a digital signing certificate. See [insteuctions for certificate creation](https://www.adobe.io/apis/cloudplatform/usermanagement/docs/setup/createcert.html).
21+
☐ Obtain or create a digital signing certificate. See [instructions for certificate creation](https://www.adobe.io/apis/cloudplatform/usermanagement/docs/setup/createcert.html).
2222

2323
☐ Setup an adobe.io integration for each organization you need to access (usually only one). See Step 2 and 3 on this [page](https://www.adobe.io/apis/cloudplatform/usermanagement/docs/setup.html)
2424

0 commit comments

Comments
 (0)