[Index]

Model: data/DatasyncBuilderTemplate

This model stores templates for building datasyncs and MIFs

Model Details: data/DatasyncBuilderTemplate

Title Description Details
Template Group Assigned by FDP
  • Field Name: Template
  • Type: Object
Name * Name of this template
  • Field Name: Template.name
  • Type: String
  • MaxLength: 1024
Description Description of the functionality of datasyncs built by this template
  • Field Name: Template.description
  • Type: String
  • MaxLength: 1024
Datasync Prefix * Name datasync will be the prefix - customername
  • Field Name: Template.datasync_prefix
  • Type: String
  • MaxLength: 1024
Solution Group Assigned by FDP
  • Field Name: Solution
  • Type: Object
UC Automation UC Automation feature toggle
  • Field Name: Solution.uc_automation
  • Type: Boolean
UC Monitoring UC Monitoring feature toggle
  • Field Name: Solution.uc_assurance
  • Type: Boolean
UC Analytics UC Analytics feature toggle
  • Field Name: Solution.uc_analytics
  • Type: Boolean
Security Security feature toggle
  • Field Name: Solution.security
  • Type: Boolean
Email Email feature toggle
  • Field Name: Solution.email
  • Type: Boolean
License Management License Management feature toggle
  • Field Name: Solution.license_management
  • Type: Boolean
Meeting Rooms Meeting Rooms feature toggle
  • Field Name: Solution.meeting_rooms
  • Type: Boolean
CUCM CUCM feature toggle
  • Field Name: Solution.cucm
  • Type: Boolean
CUC CUC feature toggle
  • Field Name: Solution.cuc
  • Type: Boolean
Webex App Webex App feature toggle
  • Field Name: Solution.webex_app
  • Type: Boolean
Webex Contact Centre Webex Contact Centre feature toggle
  • Field Name: Solution.webex_contact_centre
  • Type: Boolean
LDAP LDAP feature toggle
  • Field Name: Solution.ldap
  • Type: Boolean
Other Other feature toggle
  • Field Name: Solution.other
  • Type: Boolean
Datasync Group Assigned by FDP
  • Field Name: Datasync
  • Type: Object
Model Parent * The parent type of the model types to be filtered.
  • Field Name: Datasync.model_parent
  • Type: String
  • MaxLength: 1024
Device Type * The type of devices to be synchronized. Choices are based on connection parameter data models of the devices supported by the current system.
  • Field Name: Datasync.device_type
  • Type: String
  • MaxLength: 1024
Sync Type The selected Sync Type. The Type can be Pull from Device, Push to Device, Merge with Device, or Purge Local. For Push, the system data state is the master state and the model types of the connection parameter are synchronized with it. For Pull, the model type states of the connection parameter is the master and the system model data is synchronized with these. For Merge, data synchronization takes place in both directions without overwrite of either data. For Purge Local, resources all resources that exist in the system will be deleted, although the entities in the device are not deleted - this is useful when cleaning up the system.
  • Field Name: Datasync.sync_type
  • Type: String
  • MaxLength: 1024
  • Choices: ["Pull from Device", "Push to Device", "Merge with Device", "Purge Local Resources", "Change Notification Sync"]
Dependency Resolution The strategy for handling failures due to missing dependencies. Only 'Best Effort' resolution is supported. 'Best Effort' resolution attempts to brute force the synchronization as much as possible by re-iterating over failed imports until there are no errors.
  • Field Name: Datasync.dependency_resolution
  • Type: String
  • MaxLength: 1024
  • Choices: ["Best Effort", "Default"]
Quick Import (Warning: Summary Data Only) Enable with caution: Indicates whether import operations will fetch full data for all instances or just use the summary data. Only use with Model types where all of the required data is in the summary data eg: device/cuc/ImportUser model.
  • Field Name: Datasync.quick_import
  • Type: Boolean
Import Schema Only Indicates whether import operations will fetch schema only and no data.
  • Field Name: Datasync.schema_only
  • Type: Boolean
Import Data Only Indicates whether import operations will fetch data only and no schema.
  • Field Name: Datasync.no_schema
  • Type: Boolean
Execute Asynchronously Indicates whether the Data Sync must be executed Asynchronously or Synchronously. Default: True
  • Field Name: Datasync.asynchronous
  • Type: Boolean
  • Default: True
Refresh Existing (Changed) Data Indicates whether the Data Sync refreshes existing data that has changed on the device.
  • Field Name: Datasync.refresh_existing_data
  • Type: Boolean
Force Refresh Of Data Indicates whether a update action is executed regardless of whether the device has changed or not
  • Field Name: Datasync.force_update_flag
  • Type: Boolean
Purge Unmatched Records(Warning: Existing data not matching Filter will be removed) Purge all cache records which do not match the filters. Warning: Existing data not matching Filter will be removed
  • Field Name: Datasync.purge_unmatched
  • Type: Boolean
Number of Changes To Process Specifies how many changes to process during a device notification.
  • Field Name: Datasync.num_changes_to_process
  • Type: Integer
Device Filters A refinement on devices that the data sync applies to. These filters are optional. If they are not specified, data sync will be applied to all instances of the device type supported by this Data Sync instance. If specified, only the devices that match the given filters will be synchronized.
  • Field Name: device_filters.[n]
  • Type: Array
Attribute Name * The model attribute name to which the condition applies.
  • Field Name: Datasync.device_filters.[n].attr_name
  • Type: String
  • MaxLength: 1024
  • Choices: [""]
Condition * If the Condition is Equals or Not Equals, then the Value to test the condition against. If the Condition is In or Not In, then Value is a list of values to test against.
  • Field Name: Datasync.device_filters.[n].condition
  • Type: String
  • MaxLength: 1024
  • Choices: ["Equals", "Not Equals", "In", "Not In"]
Value The selected Attribute Name is tested against the Value that can also be a list of values, such as a list of host names. The Condition tests against the Value or list of values.
  • Field Name: Datasync.device_filters.[n].value
  • Type: String
  • MaxLength: 1024
  • Choices: [""]
Values If the Condition is In or Not In, then the Values list the items to test the condition against.
  • Field Name: value_list.[n]
  • Type: Array
Workflows A list of workflows that is to be executed as part of data sync actions eg. when a resource is added, modified, or deleted
  • Field Name: workflows.[n]
  • Type: Array
Model Type The model type for which the workflow is to be executed.
  • Field Name: Datasync.workflows.[n].model_type
  • Type: String
  • MaxLength: 1024
  • Format: uri
Operation * The operation for which the workflow is to be executed.
  • Field Name: Datasync.workflows.[n].operation
  • Type: String
  • MaxLength: 1024
  • Choices: ["Add", "Update", "Delete"]
Phase * The operation phase at which the workflow is to be executed eg. Pre-Execution (before the operation is performed) or Post-Execution (after the operation is performed)
  • Field Name: Datasync.workflows.[n].phase
  • Type: String
  • MaxLength: 1024
  • Choices: ["Pre Execution", "Post Execution"]
Workflow * The workflow instance that will be executed.
  • Field Name: Datasync.workflows.[n].workflow
  • Type: String
  • Target: data/ProvisioningWorkflow
  • Target attr: name
  • MaxLength: 1024
  • Format: uri
Synchronous If selected the workflow will be executed synchronously, otherwise asynchronously (default).
  • Field Name: Datasync.workflows.[n].synchronous
  • Type: Boolean
Repeat after (x) Days *
  • Field Name: Datasync.repeat_day
  • Type: Integer
Repeat after (x) Hours *
  • Field Name: Datasync.repeat_hour
  • Type: Integer
Transaction Log Level The transaction log level to be used for this Data Sync and its immediate sub-transactions. Default is Warning when this field is not set. Default: 30
  • Field Name: Datasync.transaction_log_level
  • Type: Integer
  • Default: 30
  • Choices: ["Use System Settings", "Debug", "Verbose", "Info", "Warning", "Error", "Disabled"]
Disabled Operations Group Assigned by FDP
  • Field Name: Disabled Operations
  • Type: Object
Disabled Operations Indicates which operations should be disabled for this Data Sync.
  • Field Name: disabled_operations
  • Type: Object
Disable Add Operation Disable the "add" operation.
  • Field Name: Disabled Operations.disabled_operations.add
  • Type: Boolean
Disable Update Operation Disable the "update" operation.
  • Field Name: Disabled Operations.disabled_operations.update
  • Type: Boolean
Disable Remove Operation Disable the "remove" operation.
  • Field Name: Disabled Operations.disabled_operations.remove
  • Type: Boolean
Models to Sync Group Assigned by FDP
  • Field Name: Models to Sync
  • Type: Object
mtl_data
  • Field Name: mtl_data
  • Type: Object
Model Type List The selected 'exclusion/inclusion' model type list that was created as a model instance of the Model Type List. See: Model Type List.
  • Field Name: Models to Sync.mtl_data.model_type_list
  • Type: String
  • Target: data/ModelTypeList
  • Target attr: name
  • MaxLength: 1024
  • Format: uri
List Type The selection type of the list of model instances - either by inclusion or by exclusion.
  • Field Name: Models to Sync.mtl_data.list_type
  • Type: String
  • MaxLength: 1024
  • Choices: ["Include Selected Model Types", "Exclude Selected Model Types", "Ordered List"]
Model Types When List Type is "Include Selected Model Types" or "Exclude Selected Model Types", this is a list of model types to be excluded or included.
  • Field Name: model_types.[n]
  • Type: Array
Sequence When List Type is "Ordered List", this is an order-specific list of model types.
  • Field Name: sequence.[n]
  • Type: Array
Synchronization Order Model Type List The selected 'ordered' model type list that was created as a model instance of the Model Type List. This list dictates the order in which models will be synchronized. See: Model Type List.
  • Field Name: Models to Sync.mtl_data.sync_order_mtl
  • Type: String
  • Target: data/ModelTypeList
  • Target attr: name
  • MaxLength: 1024
  • Format: uri
Synchronization Order Sequence When List Type is "Ordered List", this is an order-specific list of model types.
  • Field Name: sync_order_sequence.[n]
  • Type: Array
Sync Filters Group Assigned by FDP
  • Field Name: Sync Filters
  • Type: Object
Sync All Instances
  • Field Name: Sync Filters.sync_all_instances
  • Type: Boolean
Model Instance Filter
  • Field Name: Sync Filters.model_instance_filter
  • Type: String
  • Target: data/ModelInstanceFilter
  • Target attr: name
  • MaxLength: 1024
  • Format: uri
Filter Type The nature of filtering of model instances - either by inclusion or by exclusion.
  • Field Name: Sync Filters.filter_type
  • Type: String
  • MaxLength: 1024
  • Choices: ["Include Matching Instances", "Exclude Matching Instances"]
User Filters
  • Field Name: mif_filters.[n]
  • Type: Array
Custom Filter Specify Custom filter parameters or use predefined filters
  • Field Name: Sync Filters.mif_filters.[n].use_custom_filter
  • Type: Boolean
Filter Name
  • Field Name: Sync Filters.mif_filters.[n].filter_name
  • Type: String
  • MaxLength: 1024
Custom Filter Parameters
  • Field Name: custom_filter_parameters
  • Type: Object
Model Type * The type of the model that this filter applies to.
  • Field Name: Sync Filters.mif_filters.[n].custom_filter_parameters.model_type
  • Type: String
  • MaxLength: 1024
  • Choices: [""]
Attribute Filters
  • Field Name: attr_filters.[n]
  • Type: Array
Attribute Name The model attribute name for which the filter applies.
  • Field Name: Sync Filters.mif_filters.[n].custom_filter_parameters.attr_filters.[n].attr_name
  • Type: String
  • MaxLength: 1024
Condition The nature of comparison to be made for the filter. Condition can be 'Equals', 'Not Equals', 'Greater Than', 'Less Than', 'In', 'Not In' or 'Like'
  • Field Name: Sync Filters.mif_filters.[n].custom_filter_parameters.attr_filters.[n].condition
  • Type: String
  • MaxLength: 1024
  • Choices: ["Equals", "Not Equals", "Greater Than", "Less Than", "In", "Not In", "Like"]
Value A single value to which the condition is applied. Value is used when the condition is one of 'Equals', 'Not Equals', 'Greater Than', or 'Less Than'
  • Field Name: Sync Filters.mif_filters.[n].custom_filter_parameters.attr_filters.[n].value
  • Type: String
  • MaxLength: 1024
Values A list of multiple values to which the condition is applied. Values are used when the condition is either 'In' or 'Not In'
  • Field Name: value_list.[n]
  • Type: Array