Switch Sync Project

Switch Sync Project

Creating a Switch Sync Project allows administrators to compare the database residing within the switch to the database within CAIRS. For each switch sync type, an administrator creates a new project and for each switch, you will have up to six projects. Each project allows you to schedule and perform syncs, view sync logs, etc. In order for you to create a switch sync project, you must have created and established a connection with each switch from within CAIRS. To learn more about how to do this, please see the Switches section.

Adding a Switch Sync Project

  1. Click the System Admin
  2. In the Navigation pane, click the plus sign (+) next to Data Sync Center to expand the menu items.
  3. Click Switch Sync Project. There are two ways to add a project:
    • Within the tool bar directly above the Navigation pane, click the dropdown arrow next to New. From the list select Switch Sync Project.
    • Within the Actions pane, click the Add New Switch Sync Project
  1. With either option, the General-Import screen opens. Complete the following fields. Required fields are marked with as asterisk (*):
    • Project Name* – type-in the project name.
    • Switch Name* – click on the dropdown arrow to access a list and from the list select the switch you wish to sync with.
    • Script Name* – click the dropdown arrow to access a list and from the list, select the script needed to perform the sync.
    • Action* –  click the dropdown arrow to access a list and from the list, select one of the sync types: Port, Number Plan, Number Plan Listing, Feature Key Maps, Configured Sets, Hunt Group Members, Switch Speed Dial, Switch Hunt Group Members, Run Script Only or Call Pickup Group.
    • Auto Update – click the field to insert a checkmark in the box allowing auto-update. If this is checked, any discrepancies that are found from the switch data to your CAIRS data will be automatically updated to match the switch. If you select this, it is a good idea to change the comparison type to ‘Ignore Not In Switch’, this will leave any records that exist in CAIRS but not in the switch in place.  This is helpful if you have virtual numbers in your CAIRS database.
    • Single Record Sync – this allows you to perform a sync for a single record in your switch.
    • Description – type-in a project description.
    • Comparison Type – click the dropdown arrow to access a list and from the list, select one of the following options:
    • Compare All – compares everything in/out of the database.
    • Ignore Not In Switch – ignores records in CAIRS that are not in the switch.
    • Use Advanced Sync Options – this option is available to use with the direct supervision of a Unique Communications Representative.
  1. After completing the required information, within the Actions ribbon group, click Save (save and stay) button, Save & Close (save and return to the project list) or Save & New (save and refresh) to add a new project.

Association

The Association button is used to specify the data used to compile the Switch Sync Project. There are 2 panes in the section: Switch Fields and CAIRS fields. In each field used for the project, you must specify where you are getting the data. If the field information is coming from the switch database, use the dropdowns within the Switch Fields pane. If the field information is coming from your CAIRS database, use the dropdowns within the CAIRS pane. In the example below, you will see that a majority of the information for this port sync will be coming from the switch, CAIRS will populate the start option and service type for each record.  Please contact a Unique Communications Representative for assistance in making changes to this section.

Recurrence

Each sync project can be set to run automatically on a daily, weekly, or monthly basis. Within the Recurrence button you will be determining when your syncs will run.

  1. Click the System Admin
  2. In the Navigation pane, click the plus sign (+) next to Data Sync Center to expand the menu items.
  3. Click Switch Sync Project.
  4. The Switch Sync Project list opens to the right. Within the list double click the project to schedule.
  5. The General-Import screen opens. Within the Show ribbon group, click the Recurrence
  6. The Data Sync Recurrence pop-up opens.
  7. Within the Data Sync start time pane (top), click the dropdown arrow to select the sync start hour. The clock is on military time, so this will be a number between 0 and 23.
  8. Within the Recurrence pattern pane, select how often to perform the sync. There are three choices:
    • Daily – once you select the option button next to Daily, two additional selections become available. You can choose to run the sync every 1-7 days by selecting the first option and typing in the number of weekdays or run the sync every weekday, skipping Saturday and Sunday.
    • Weekly – once you select the option button next to Weekly, two additional selections become available allowing you to select the day of the week to perform the sync. Additionally, you are required to type in the number of weeks in-between syncs. For example, if you type in 2 and select Sunday, CAIRS performs a sync every other Sunday
    • Monthly – once you select the option button next to Monthly, an additional selection becomes available allowing you to choose what day of every month to perform the sync. To perform the sync on the 1st of every month, you would type-in a 1 in both fields
  1. Within the Range of recurrence pane, enter the switch sync Start date using the drop-down calendar. To change the date, click the field to access a dropdown calendar. To change the month and year click the right or left arrow, and once at the appropriate month and year, click the number to select the date. The date populates in the box.
  2. After you have selected your start date, decide if you want the sync to run continuously on this schedule or have an end date. To have CAIRS run this sync continuously on this schedule, click the radio button next to No end date otherwise click the radio button next to End by: and select the desired end date.
  3. Click the Ok button when finished or click Cancel to exit the pop-up without saving your changes.

Viewing Sync Schedules

You can view existing sync schedules.

  1. Click the System Admin
  2. In the Navigation pane, click the plus sign (+) next to Data Sync Center to expand the menu items.
  3. Click Switch Sync Project.
  4. The Switch Sync Project list opens to the right. Within the list, double click the project to schedule.
  5. The General-Import screen opens. Within the Show ribbon group, click the Recurrence
  6. The Data Sync Recurrence pop-up opens. At the top of the pop-up, CAIRS tells you the recurrence pattern.
  7. To exit, click the Ok button or the red X in the upper right hand corner of the pop-up window.

Switch Sync Logs

The Switch Sync Logs displays a list of the syncs that have occurred, the list included a few details for each sync such as date, time, status, parameters, etc.  There are two additional options within this button, you can ‘Cancel the last submitted Sync’ and ‘Clear the Sync Log’.

Viewing Switch Sync Project Log

  1. Click the System Admin
  2. In the Navigation pane, click the plus sign (+) next to Data Sync Center to expand the menu items.
  3. Click Switch Sync Project.
  4. The Switch Sync Project list opens to the right. Within the list, double click the project to schedule.
  5. The General-Import screen opens. Within the Show ribbon group, click on the upper portion of the Switch Sync Log button.
  6. The screen changes to displays a list of the syncs completed. The list displays the following read-only information:
    • Request ID – this is an internal code used by CAIRS to identify the sync request
    • Sync Status – displays the status of the sync, whether in progress, cancelled, etc.
    • Sync Details – displays any details for the sync
    • Date Time – displays the date and time the sync started
    • Sync Parameters – displays any unique parameters used for the sync
  1. Click the plus sign (+) next to the request id to view the complete sync log details.

Switch Sync Log – Cancel Last Submitted Sync

You can cancel the last submitted sync. This will only cancel syncs that have a status of not started or in progress.

  1. Click the System Admin
  2. In the Navigation pane, click the plus sign (+) next to Data Sync Center to expand the menu items.
  3. Click Switch Sync Project.
  4. The Switch Sync Project list opens to the right. Within the list, double click the name of the sync project.
  5. The General-Import screen opens. Within the Show ribbon group, click the lower portion of the Switch Sync Log button to access a drop-down menu and from the menu select, Cancel Last Submitted Sync.
  6. A message box appears verifying the last sync was cancelled successfully.

Clearing the Sync Log

Clearing the sync log removes all the information from the log.

  1. Click the System Admin
  2. In the Navigation pane, click the plus sign (+) next to Data Sync Center to expand the menu items.
  3. Click Switch Sync Project.
  4. The Switch Sync Project list opens to the right. Within the list, double click the name of the sync project.
  5. The General-Import screen opens. Within the Show ribbon group, click the lower portion of the Switch Sync Log button to access a drop-down menu and from the menu select, Clear Sync Log.
  6. A message box appears verifying that you really want to clear the log. Keep in mind that if a sync is in progress it clears that log as well and there will be no way to know if the sync was successfully.
  7. Within the box, click Yes to continue clearing the log or No to cancel.