Graphical User Interface¶
Settings¶
Export¶
| Setting | Description | Example |
|---|---|---|
| CSV-File | Path and name where to save the CSV-file on local filesystem | C:\scripts\export.csv |
| SearchBase | Determine the source AD's Organization Unit or leave empty to select the whole AD | OU=source_tree,DC=AD,DC=COMPANY,DC=DE |
| Remoteusername | Remoteusername formatted like: Administrator@ad.company.de please do not use AD\Administrator here | Administrator@ad.company.de |
| Password | Remoteusernames password for AD/LDAP authentification | |
| Remoteserver | Source server FQDN | ad01.company.local |
| Include contact-objects | Include also contact objects into csv creation | Yes/No |
Warning
Because we use csvde for export, you have to provide the username in this format: username@ad.company.de! AD\Username is not supported by csvde!
CSV-Upload¶
| Setting | Description | Example |
|---|---|---|
| Enable CSV-upload | Enable or disable upload after csv-export, csv-file will be archived into zip-file before upload | Yes/No |
| Protocol | Protocol that is used for Uploading compressed csv-file | FTP/FTPs/sFTP |
| Server | Target server-address | 192.168.0.100 or ftp.company.local |
| Port | Servers upload-connection port | Usually 21 |
| Username | Upload-servers login username | jdoe |
| Password | Upload-servers login password | secret123! |
| Upload-Path (and Filename) | Full upload path and filename, where to save the zip-file on the sftp-server | /var/www/html/upload.zip |
Contact creation / update¶
| Setting | Description | Example |
|---|---|---|
| CSV-File | Local path to CSV-file to use for contact creation / update. If you want to run both steps at once (Export & Contact creation / update), select the same path used as export's CSV-file path. | C:\scripts\export.csv |
| SearchBase | Target tree where to create the new contact objects | OU=target_tree,DC=AD,DC=COMPANY,DC=COM |
| Remoteusername | Remoteusername for target-environment | DOMAIN\J.Doe or J.Doe@domain.local |
| Password | Remoteusers authentification password | |
| Remoteserver | Target remoteservers address | ad02.company.local |
| Exchange-Server | Target-Environments Exchange server address (Used by Remote PSSesion for mail-enabling) | ex01.company.local |
Other settings¶
| Setting | Description |
|---|---|
| Logging | Enable / Disable logging to textfiles (Logging files will be created in the same folder, where ADCEITool.exe is placed) |
Manual processing¶
Manual procesing-view is the main tab after the settings are determined. In the processing tab, you can start the CSV-export process, CSV-upload and contact creation / update process in the target environment.
Export¶
Above the control-buttons, your latency to source-environment is shown.
Right under the latency, you can see the amount of rows currently added to the CSV-file.
Via the export to CSV button, you start the export to the specified CSV file.
Above the control-buttons, you'll see the current ping to cmo(source environment)/fmo(target environment). Over "Write CSV"-Button, the current written CSV-Rows are displayed.
If "Enable CSV-upload" is checked, the created CSV-file will be automatically compressed and uploaded, after the csv-creation is done. In case you want to edit the CSV-file before uploading, you can use the "Manual upload CSV"-button, to compress and upload the csv-file again.
Contact creation / update¶
Above the Create / Update contacts-button, your latency to fmo is shown. Right under the latency, you can see the current creation/update status. An additional progress-bar is shown at the bottom of this view, wich displays the current creation/update progress. To manual start the contact creation and update process, click the "Create / Update contacts" button.
After all contact objects have been created or updated, a script will be executed that allows all created contacts to be mail-enabled. This part takes up most of the time.
The last step, ADCEITool will take in the contact creation / update process, is setting / updating the manager-attribute for each created object. This step must come last, to ensure that the object entered as manager exists. The progress for mail-enabling and setting manager attribute is not shown, wait until the programm said it's finished.
Settings.ini-Writer¶
Via the settings.ini writer you are able to create a settings.ini file, which will be automatically loaded by ADCEITool.
Export¶
| Setting | Description | Example |
|---|---|---|
| CSV-File | Path and name where to save the CSV-file on local filesystem | C:\scripts\export.csv |
| SearchBase | Determine the source AD's Organization Unit or leave empty to select the whole AD | OU=source_tree,DC=AD,DC=COMPANY,DC=DE |
| Remoteusername | Remoteusername formatted like: Administrator@ad.company.de please do not use AD\Administrator here | Administrator@ad.company.de |
| Password | Remoteusernames password for AD/LDAP authentification | |
| Remoteserver | Determine source-servers address | ad01.company.local |
| Include contact-objects | Also include contact objects into csv creation | Yes/No |
Warning
Because we use csvde for export, you have to determine the username in this format: username@ad.company.de! AD\Username is not supported by csvde!
CSV-Upload¶
| Setting | Description | Example |
|---|---|---|
| Enable CSV-upload | Enable or disable upload after csv-export, csv-file will be archived into zip-file before upload | Yes/No |
| Protocol | Protocol that is used for uploading the compressed csv-file | FTP/FTPs/sFTP |
| Server | Target server-address | 192.168.0.100 or ftp.company.local |
| Port | Servers upload-connection port | Usally 21 |
| Username | Upload-servers login username | jdoe |
| Password | Upload-servers login password | secret123! |
| Upload-Path (and Filename) | Full upload path and filename, where to save the zip-file on the sftp-server | /var/www/html/upload.zip |
Contact creation / update¶
| Setting | Description | Example |
|---|---|---|
| CSV-File | Local path to CSV-file to use for contact creation / update. If you want to run both steps at once (Export & Contact creation / update), select the same path used as export's CSV-file path. | C:\scripts\export.csv |
| SearchBase | Target tree where to create the new contact objects | OU=target_tree,DC=AD,DC=COMPANY,DC=COM |
| Remoteusername | Remoteusername for target-environment | DOMAIN\J.Doe or J.Doe@domain.local |
| Password | Remoteusers authentification password | |
| Remoteserver | Target remoteservers address | ad02.company.local |
| Exchange-Server | Target-Environments exchange server address (Used by Remote PSSesion for mail-enabling) | ex01.company.local |
Other settings¶
| Setting | Description |
|---|---|
| Logging | Enable / Disable logging to textfiles (Logging files will be created in the same folder, where ADCEITool.exe is placed) |
| Enable automatisation | Enable / Disable automatic mode. This should be enabled, if you want to run this tool as sheduled task. |
Note
If automatic mode is enabled, ADCEITool does not load its normal user interface to avoid problems with Windows Task-Sheduler.
Automatisation¶
| Switch | Description |
|---|---|
| Auto create CSV | Automatically create the csv on programms start. |
| Auto create / update contacts | Automatically run contact creation and update process (If Auto create CSV is also checked, CSV-creation process is running first). |
About¶
About view, contains informations like version number, link to this manual and some informations about us.