Difference between revisions of "Google Workspace User Import"
Jump to navigation
Jump to search
| (5 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
| + | This document can now be found at its new location in the [https://docs.hornbill.com/data-imports-guide/users/google/overview Hornbill Document Library]. | ||
| + | |||
| + | [[file:hornbill-document-library.png|Data Imports Guide|link=https://docs.hornbill.com/data-imports-guide/users/google/overview]] | ||
| + | |||
| + | <!-- | ||
| + | |||
<div style="border:1px solid #90C0FF; background:#D0E0FF; width:99%; padding:4px; margin-bottom:10px;"> | <div style="border:1px solid #90C0FF; background:#D0E0FF; width:99%; padding:4px; margin-bottom:10px;"> | ||
{| style="width:100%" | {| style="width:100%" | ||
| Line 11: | Line 17: | ||
== About the Google Workspace User Import Utility == | == About the Google Workspace User Import Utility == | ||
The utility provides a simple, safe and secure way to create user accounts on the Hornbill platform by synchronizing with accounts held in your Google Workspace domains. The tool is designed to run behind your corporate firewall, safely and securely connect to Google via your Hornbill instance, query the required account information, transform and load into the Hornbill instance. The tool connects to the Hornbill in the cloud over HTTPS/SSL so as long as you have standard internet access then you should be able to use tool without the need to make any firewall configuration changes. The tool supports both the initial bulk import as well as incremental adds and updates. You can schedule the tool to run periodically to perform the import/update tasks as required. | The utility provides a simple, safe and secure way to create user accounts on the Hornbill platform by synchronizing with accounts held in your Google Workspace domains. The tool is designed to run behind your corporate firewall, safely and securely connect to Google via your Hornbill instance, query the required account information, transform and load into the Hornbill instance. The tool connects to the Hornbill in the cloud over HTTPS/SSL so as long as you have standard internet access then you should be able to use tool without the need to make any firewall configuration changes. The tool supports both the initial bulk import as well as incremental adds and updates. You can schedule the tool to run periodically to perform the import/update tasks as required. | ||
| − | |||
| − | |||
| − | |||
| − | |||
|style="width:5%"| | |style="width:5%"| | ||
| Line 32: | Line 34: | ||
=== Windows Installation === | === Windows Installation === | ||
| − | * Download the architecture specific [https://github.com/hornbill/ | + | * Download the architecture specific [https://github.com/hornbill/user-import-google/releases/latest latest package] from GitHub |
* Extract zip into a folder you would like the application to run from e.g. '''C:\Hornbill_Import\''' | * Extract zip into a folder you would like the application to run from e.g. '''C:\Hornbill_Import\''' | ||
* Open '''conf.json''' and add in the necessary configuration | * Open '''conf.json''' and add in the necessary configuration | ||
| − | * Open Command Line Prompt | + | * Open Command Line Prompt |
| − | * Change Directory to the folder with | + | * Change Directory to the folder with user_import_google.exe '''C:\Hornbill_Import\''' |
| − | * Run the command | + | * Run the command user_import_google.exe -file=conf.json -dryrun=true |
== HTTP Proxies == | == HTTP Proxies == | ||
| Line 283: | Line 285: | ||
== Preparing to Run the Import == | == Preparing to Run the Import == | ||
Ultimately, the executable will be scheduled in Windows task scheduler (see later) but to test, gain confidence, and perform the initial upload of users the utility can be executed from a command prompt window on an ad-hoc basis. The command used to execute the import can contain a number of command line parameters. | Ultimately, the executable will be scheduled in Windows task scheduler (see later) but to test, gain confidence, and perform the initial upload of users the utility can be executed from a command prompt window on an ad-hoc basis. The command used to execute the import can contain a number of command line parameters. | ||
| − | + | ||
| − | + | === Command Line Parameters === | |
| + | |||
* file - Defaults to '''''conf.json''''' - Name of the Configuration file to load | * file - Defaults to '''''conf.json''''' - Name of the Configuration file to load | ||
| − | * dryrun - Defaults to '''''false''''' - Set to True and the XMLMC for Create and Update users will not be called and instead the XML will be dumped to the log file, this is to aid in debugging the initial connection information | + | * dryrun - Defaults to '''''false''''' - Set to True and the XMLMC for Create and Update users will not be called and instead the XML will be dumped to the log file, this is to aid in debugging the initial connection information. |
| − | * workers - Defaults to | + | * workers - Defaults to `3` - Allows you to change the number of worker threads used to process the import, this can improve performance on slow import but using too many workers have a detriment to performance of your Hornbill instance. |
| − | * | + | * forcerun - This should '''only''' be used in the event of the error''' ''Unable to run import, a previous import is still running'' ''' to force the import to ignore the "running" status. |
| − | * | + | * creds - Defaults to `false` - Set to `true` to decrypt and output the API key that is stored locally. NOTE - the tool will prompt you for your instance ID, and this can only be decrypted by the user who originally performed the encryption, and only on the same machine that it was encrypted on. |
| + | |||
| + | === First Run === | ||
| + | |||
| + | From version '''2.0.0''' of the User Import - Google utility, when you first run the utility it will prompt you for the ID of your Hornbill instance (case-sensitive), and the API key (also case-sensitive) that will be used to authenticate the API calls back into Hornbill. This information will be encrypted, and stored locally on the client PC that will be running the tool. For each subsequent import run, the utility will decrypt your instance ID and API key, and will use those to make the API calls back into Hornbill. | ||
| + | |||
| + | NOTE - the encrypted instance ID and API key can only be decrypted on the computer, and by the user, that performed the encryption, so please keep this in mind when scheduling your imports. | ||
| + | |||
| + | Should you wish to use a different API key to what has been previously encrypted, just delete the '''import.cfg''' file from the folder where the import binary resides, and re-run your import from the command line inputting the Instance ID and new API Key as you would have on its first run. | ||
== Testing Overview == | == Testing Overview == | ||
| Line 368: | Line 379: | ||
=== Windows === | === Windows === | ||
| − | You can schedule .exe to run with any optional command line argument from Windows Task Scheduler. | + | You can schedule goHornbillGoogleUserImport.exe to run with any optional command line argument from Windows Task Scheduler. |
| − | * Ensure the user account running the task has rights to | + | * Ensure the user account running the task has rights to goHornbillGoogleUserImport.exe and the containing folder. |
* Make sure the Start In parameter contains the folder where the executable resides in, otherwise it will not be able to pick up the correct path. eg: | * Make sure the Start In parameter contains the folder where the executable resides in, otherwise it will not be able to pick up the correct path. eg: | ||
| + | --> | ||
| + | [[Category:HDOC]] | ||
Latest revision as of 18:49, 11 April 2024
This document can now be found at its new location in the Hornbill Document Library.
