# Scheduling IDS Synchronization

After IDS has been programmed for your cluster or network, you can use the following procedures to schedule data synchronization events.

Two synchronization options are available, "full" and "incremental."

### Full IDS Synchronization

Schedule a full IDS synchronization in order to query the directory server for new, modified and deleted user records.

Because a full synchronization searches for the full range of updates—deletions as well as new and modified records—it has intensive processing requirements and should be performed less frequently than an incremental synchronization.

### Incremental IDS Synchronization

Schedule an incremental IDS synchronization to query the directory server for new and modified user records.

Because incremental synchronizations do not search for deleted user records, they are less processing intensive and can be performed more frequently than full synchronizations.

## Conditions

- The MiVoice Business contact point can perform queries in one domain or multiple domains, or it can query the Global Catalog (GC) for all domains.

- If configured to query the Global Catalog, MiVoice Business connects to the first GC server it finds and then downloads the Partial Attribute Set (PAS). Where possible, the PAS should include the LDAP attributes listed on the User Service Data to LDAP Attributes Mapping form. If necessary, amend the schema to include attributes for important (i.e. frequently changed) data.

- Full synchronization generates two comparison reports in LDAP Data Interchange (LDIF) format:

- IncomingDSChanges_<date_timestamp>.ldf — This report contains instructions to modify existing records, insert new records, and delete records that are no longer hosted by the queried domain. Records that are not IDS-manageable are ignored.

- IDSManagedUsersWithNoDomain_<date_timestamp>.ldf — This report lists records that are IDS-manageable but do not have a domain because they exist on MiVoice Business only. The administrator can edit this file, adding distinguished names to the affected records, and import it to the directory server.

- Incremental synchronization generates one comparison report in LDAP Data Interchange (LDIF) format:

- IncomingDSChanges_<date_timestamp>.ldf — This report contains instructions to modify existing records and insert new records. Records that are not IDS-manageable are ignored.

- The comparison reports are maintained in the /db /IDS/LDIF_query_results directory on MiVoice Business, with the reports for each synchronization result saved in a separate sub-folder with a unique date and time. Administrators can access the directory using FTP.

- By default, the system saves the five most recent comparison reports. To change this setting, update the Maximum sets of IDS sync results field in the System Options form.

## Operation

To schedule IDS synchronization events, refer to the following procedures:

- Add a Full IDS Synchronization Event

- Add an Incremental IDS Synchronization Event

- Edit an Event

- Delete an Event

- Copy an Event

- Execute an Event Immediately

### Add a Full IDS Synchronization Event

To create a full IDS synchronization event:

1. Go to the Scheduler form.

2. Use the screen tools (arrows and mini-calendar) to locate the day you wish to update.

3. Select the day and click Add Event.

4. Click the Event Parameters tab and complete the following fields:

5. Title: Type a title for the event. The title can contain up to 255 alphanumeric characters.

6. Start Date: Use the dialog box to select the Month, Day, and Year that the event is scheduled to start.

7. Time: Use the dialog box to select the Hour, AM/PM, and Minute that the event is scheduled to occur. Click Set to save your changes.

8. Repeats: Specify how often you want the event to repeat - Once, Daily, Weekly, Monthly, Yearly, or Repeats Interval. If you select Daily, Weekly, Monthly, or Yearly, the dialog expands, enabling you to customize the repetition interval. If you select Repeats Interval, you can specify the number up minutes between repeat events (up to 1440 minutes, or 24 hours), and whether you would like the event to be repeated continuously or a fixed number of times.

5. Click the Activity Parameters tab and complete the following fields:

6. Select Activity: Select Full IDS Synchronization.

7. Use Global Catalog If Configured: Select this check box to search for a Global Catalog server for all domains. MiVoice Business connects to the first GC server it finds and downloads the partial attribute set (PAS) of LDAP updates from it. If MiVoice Business cannot find a GC server, it searches for directory servers in all domains. Clear this check box to search for directory servers in specific domains (see next setting).

   NOTE: If the Use Global Catalog check box is selected, you cannot enter a list of domains to query. All available will be queried.

8. Domain Set: Enter the names of the domains you want to query for LDAP updates. Use semicolons to separate the entries (e.g. <domain_1>; <domain_2>). Enter "All" or leave this field blank to query all domains for directory servers connected to the MiVoice Business contact point.

9. Sync Type: Select a synchronization type:

   - Apply Updates—Updates received from the directory server are immediately applied to MiVoice Business. To enable the administrator to track which records have been updated, added and deleted, a set of comparison reports is generated in LDIF format.

   - Detain Updates—Updates received from the directory server are detained on MiVoice Business, where they can then be processed (applied, rejected, etc.) by the administrator. A set of comparison reports is generated in LDIF format.

   - Compare Only—Updates are not applied to MiVoice Business, but a set of comparison reports is generated in LDIF format.

- Allow Delete Operation: Select this check box to allow records to be deleted from MiVoice Business. If the Sync Type is "Apply Updates," the system immediately deletes the records. If the Sync Type is "Detain Updates," the records are detained on the IDS Data Management form, where they may then be deleted by the administrator. If the Sync Type is "Compare Only," no updates are applied to MiVoice Business, but the administrator may refer to the LDIF comparison reports to determine which records have been deleted from the directory server.

6. Click Submit and then OK to save the new event.
   The new event is added to the event list.

7. Following completion of the scheduled synchronization event, check the IDS Data Management form to resolve detained and failed updates. Check the Maintenance and Software Logs to resolve problems with the synchronization process.

### Add an Incremental IDS Synchronization Event

To create an incremental IDS synchronization event:

1. Go to the Scheduler form.

2. Use the screen tools (arrows and mini-calendar) to locate the day you wish to update.

3. Select the day and click Add Event.

4. Click the Event Parameters tab and complete the following fields:

- Title: Type a title for the event. The title can contain up to 255 alphanumeric characters.

- Start Date: Use the dialog box to select the Month, Day, and Year that the event is scheduled to start.

- Time: Use the dialog box to select the Hour, AM/PM, and Minute that the event is scheduled to occur. Click Set to save your changes.

- Repeats: Specify how often you want the event to repeat - Once, Daily, Weekly, Monthly, Yearly, or Repeats Interval. If you select Daily, Weekly, Monthly, or Yearly, the dialog expands, enabling you to customize the repetition interval. If you select Repeats Interval, you can specify the number up minutes between repeat events (up to 1440 minutes, or 24 hours), and whether you would like the event to be repeated continuously or a fixed number of times.

5. Click the Activity Parameters tab and complete the following fields:

6. Select Activity: Select Incremental IDS Synchronization.

7. Use Global Catalog If Configured: Select this check box to search for a Global Catalog server for all domains. MiVoice Business connects to the first GC server it finds and downloads the partial attribute set (PAS) of LDAP updates from it. If MiVoice Business cannot find a GC server, it searches for directory servers in all domains. Clear this check box to search for directory servers in specific domains (see next setting).

8. Domain Set: Enter the names of the domains you want to query for LDAP updates. Use semicolons to separate the entries (e.g. <domain_1>; <domain_2>). Enter "All" or leave this field blank to query all domains for directory servers connected to the MiVoice Business contact point.

9. Sync Type: Select a synchronization type:

   - Apply Updates—Updates received from the directory server are immediately applied to MiVoice Business. To enable the administrator to track which records have been updated and added, a comparison report is generated in LDIF format.

   - Detain Updates—Updates received from the directory server are detained on MiVoice Business, where they can then be processed (applied, rejected, etc.) by the administrator. A comparison report is generated in LDIF format.

   - Compare Only—Updates are not applied to MiVoice Business, but a comparison report is generated in LDIF format.

- Sync Records Modified Since Last Successful Sync: Select this check box to query for all updates made since the last synchronization event. Clear this check box to query for updates made since a particular date and time (see next setting).

- Sync Records Modified Since Date/Time: Use these settings to query for all updates made from a particular date and time. The dialog boxes facilitate selection of the Month, Day and Year, and the Hour, Minute and AM/PM. This date and time must be earlier than the scheduled synchronization date and time.

- Use Default Query String: Select this check box to search for LDAP updates using the Default Query String programmed on the IDS Connection form. The default value is objectClass=user, which causes all user records to be queried. Clear this check box to search for LDAP updates using a particular, non-default query string (see next setting).

- Query String: Enter a non-default query string to search for LDAP updates. For example, to search for all users in a research and development department, you may enter "department = R and D". There is no restriction on the type of query string that you enter, provided that it follows syntax rules outlined in RFC 2254. However, bear in mind that only user objects are queried, not invalid objects such as printers.

NOTE: Full synchronizations do not support Query Strings and ignore the Default Query String configured in the IDS Connection form.

6. Click Submit and then OK to save the new event.
   The new event is added to the event list.

7. Following completion of the scheduled synchronization event, check the IDS Data Management form to resolve detained and failed updates. Check the Maintenance and Software Logs to resolve problems with the synchronization process.

NOTE: To run the event outside the normal schedule, see Execute an Event Immediately.

Related Topics

- IDS Synchronization Overview

- Managing Scheduled IDS Events

- Scheduling IDS Synchronization

- Scheduler

- Scheduler Overview

- Scheduling Backups

- Scheduling CSV File Import/Export

- Scheduling Database Audits

- Scheduling File Transfers

- Scheduling Hot Desk User Logouts