[Index]

Model: device/webex/User

Webex

Full HTML Help

User details can be added if a valid server is available.

When adding Conferencing from this input form, the mandatory fields are entered on the Conferencing server.

Conferencing details can also be added as part of Subscriber Management.

Modify Conferencing details on the selected item, or also add and delete details from the Subscriber Management form.

Deleting a Conference item will remove the details from the Conferencing tab of Subscriber Management if the user is a Subscriber.

Webex User

Full HTML Help

CISCO

From the Overbuild's Device Models menu, you can view details about the devices, by model, in the selected hierarchy. Like the Overview Tool, this can be useful to indicate where devices have moved as a result of an overbuild.

When choosing a device model type from this menu, the list view displays data about the devices of that model type in the hierarchy, such as:

In a device model you can select individual devices to modify, delete, and export them. You can also bulk change settings for all the devices in a device model by selecting the Select All checkbox at the top of the table in the list view, then choose Action > Bulk Modify.

Caution!

It is strongly recommended that you do NOT directly edit the device models via this menu. Instead, use other menus in Automate, such as the Subscriber Day 2 menus. The Device Models menu items should be used for manually moving device models that the Overbuild Tool can't move or that need additional manual moves after Run Overbuild is executed.

For CUC models, two system users (operator and undeliverablemessagesmailbox) remain at the Customer level. All associated CUC device models for the two system users will remain at the Customer hierarchy and will show in the device model counts and device model lists at the Customer hierarchy.

For call handler device models, there are 5 default instances that remain at the Customer hierarchy:

These 5 call handlers remain at the Customer hierarchy and appear in the device model count and device model lists for call handlers at the Customer hierarchy.

These device models also allow you to add device instances. However, it is not recommended to add device instances in the Overbuild menu.

Overbuild for Cisco

Full HTML Help

CISCO

Overview

VOSS Automate's overbuild feature allows Provider and Reseller administrators to integrate an existing, deployed Cisco Unified Communications Manager (CUCM) system into VOSS Automate without re-provisioning, unless required.

This option is available for single-cluster dedicated deployments only.

Overbuild tools allow an administrator manage data synced from existing configurations in CUCM and Cisco Unity Connection (CUC).

Important

It is recommended that VOSS Automate training and/or VOSS Services are engaged during the initial use of the overbuild feature to help ensure optimized processes and guidance.

Although a deployed CUCM system does not contain VOSS Automate components such as hierarchies or subscribers, the relationship between CUCM components makes it possible to, for example, create a VOSS Automate subscriber at a site hierarchy during the overbuild process. The necessary workflows, macros and brownfield move processes are available for this purpose. You will not need to access these tools directly; they are part of the Run Overbuild user interface.

The table summarizes the overbuild logic:

Component Description
Phones This is based on the device pool of the phone. It will be moved to a site based on the device pool matching one of the device pools set up under the site defaults for a site.
Dual Mode Remote Destinations This will move the remote destination to the site of the dual mode device.
Phone Remote Destinations (Provider deployment). This will move the remote destinations to the site of the associated phone.
Users If the user has an associated phone, that user is moved to the same site as the phone. A user without an associated phone must be manually moved to the relevant site, using the Move Users menu (under either User Management or Overbuild). It is recommended that you do this prior to the overbuild, so that all their related services are moved during overbuild, or you will need to run the overbuild again, after moving the user, to handle their related services.
Device Profiles This will move the device profile to the same site as the user associated to the device profile.
Remote Destination Profiles This logic is the same as phones, based on the device pool of the RDP. It will be moved to a site based on the device pool matching one of the device pools setup under the site defaults for a site.
Remote Destinations This will move the remote destination to the same site as the associated remote destination profile.
Lines This will move the line to the same site as the phone/device profile/RDP it is associated to.
CUC Users This will move the voicemail user to the same site as the base user.
Webex App Users This will move existing Webex App users that are synced into VOSS Automate to the same site as the base user (if it finds a matching email address).
Contact Center Agents This will move contact center agents to the same site as the base user (if it finds a matching CUCM user ID).

Overbuild Workflow

The table describes the general steps for overbuild:

Component Description
  1. Initial setup

Step 1 involves the initial setup and configuration on VOSS Automate; the provisioning of the business hierarchy.

Identify the business information of the existing, deployed system, and add these details to VOSS Automate. This can be done manually, or via bulk load.

  • Create the hierarchy, with customers, sites, and site codes to generate the initial configuration data, such as site dial plan (Provider deployment only), and site defaults data.

  • Modify the data, if required, according to CUCM data, so that overbuild processing can move the data to required sites.

    For example, the default, generated VOSS Automate Site Defaults for a site have the site name as the device pool name. Since the Site Defaults are used in the overbuild, this name should be modified to match the device pool name on the imported phones before the overbuild is run.

    VOSS Automate allows Provider and Reseller Administrators to modify Site Defaults update the configuration of an overbuild.

    While customers and sites have access to the Site Defaults under the Site Management menu, the Overbuild Defaults tab in Site Defaults is only visible to Provider and Reseller Administrators.

  1. Create shell dial plan schema

Provider deployment only.

Associate a shell schema group with the customer, then add a custom dial plan under Advanced Configuration (Optional at the site hierarchy).

In this step, you will need to create a shell dial plan schema group at the Customer hierarchy. The shell schema group enables Partners, Resellers, and Provider Administrators to access customers that have existing or deployed dial plans without having to use the pre-packaged type 1-4 dial plans.

The shell schema groups only contain two default values:

  • Device Pool
  • CUCM Group

The rest of the fields are blank for customization. This enables administrators to "over-build" VOSS Automate operations on top of customers' existing dial plans. See "Provider HCS Dial Plan Management Support Guide".

  1. Configure network device connections

Identify and create network device connections, associate these with a Network Device List (NDL) and import. This includes CUCM and CUCX clusters.

This step involves provisioning Cisco UC applications, NDLs, and NDL references. Once the UC applications are configured, the sync from CUCM is scheduled and executed.

Caution: Whenever this data is synced in, it becomes managed by VOSS Automate and, as a result, would be deleted by any hierarchy delete.

One CUCM typically belongs to a customer and resides in a cluster, so this device import takes place at the created customer hierarchy. The device can also be associated with a NDL on VOSS Automate that is mapped to a created hierarchy.

Component Description
  1. Choose device pools and devices
Choose the device pool and devices for the site on both the General tab and on the Overbuild Default tabs in the Site Defaults.
  1. Run overbuild

Run the overbuild to move the imported UC applications data into the site hierarchy that corresponds with the existing deployed site.

  • Select User on Run Overbuild to move users exposed in User Management to the site of their associated phones (as specified in the Site Defaults Doc Device Pools). Users without phones are not moved and can be moved separately. Note that the user's role is not changed when moving to the site.

    The following model instances are moved from customer level to the site level:

    • data/User
    • device/cucm/User
  • If the Lines checkbox is selected on Run Overbuild, lines are moved to the relevant site, and marked as in use in the Directory Number (DN) inventory. If a matching DN inventory entry does not exist then one is created. DN entries are created at site by default unless the Create Internal Number Inventory at Customer option is selected (in Site Defaults > Overbuild Defaults tab).

    Note: Adding Directory Number inventory at Customer level is only possible if the dial plan is non-SLC, if no dial plan is in use.

The Run Overbuild tool selects which data to move based on device pool configurations. You can run the tool for all sites, or a particular site.

The existing system's provisioned phones that have been imported should have their device pools matched with Site Default data values on each specific site.

Imported elements are moved according to overbuild Move workflows, which are triggered by the Run Overbuild tool. These workflows identify imported network device data and move it to the site hierarchy that corresponds to the existing deployed site.

Component Description
  1. Verify data

Use Overbuild > Overview Tool to verify the number of UC elements at the selected hierarchy and below.

You can manually validate and modify the overbuild run by reviewing the moved items, using the Overview Tool. Use Device Models and/or Relations to move, update, delete, and in a few limited cases, add instances of device types for the selected hierarchy.

Optionally, review the device model types listed with hierarchy in the Device Models or Subscriber Management menu.

  1. Post-move
  • Move any users who were not moved during the overbuild
  • Add your E.164 inventory (optional). See Add an Inventory of E164 Numbers in the Core Feature Guide.
  • Filter calling search spaces and assign a class of service (optional). See Filter Calling Search Spaces and Assign a Class of Service in the Core Feature Guide.
  • Perform Self-service authentication provisioning steps for non-LDAP, LDAP, and SSO-enabled scenarios. See User Authentication in the Core Feature Guide.
  • Add additional internal number inventory for future lines. See Number Management.

Related Topics

Add an Inventory of E164 Numbers in the Core Feature Guide

Filter Calling Search Spaces and Assign a Class of Service in the Core Feature Guide

Model Details: device/webex/User

Title Description Details
Time Zone With DST
  • Field Name: timeZoneWithDST
  • Type: String
  • Cardinality: [0..1]
Remote Support
  • Field Name: remoteSupport
  • Type: Object
  • Cardinality: [0..1]
Recording
  • Field Name: recording
  • Type: Object
  • Cardinality: [0..1]
Type
  • Field Name: remoteSupport.recording.type
  • Type: String
  • Cardinality: [0..1]
  • Choices: ["NBR", "LOCAL"]
Enforce *
  • Field Name: remoteSupport.recording.enforce
  • Type: Boolean
  • Cardinality: [1..1]
Location
  • Field Name: remoteSupport.recording.location
  • Type: String
  • Cardinality: [0..1]
Auto Request
  • Field Name: autoRequest
  • Type: Object
  • Cardinality: [0..1]
Enable *
  • Field Name: remoteSupport.autoRequest.enable
  • Type: Boolean
  • Cardinality: [1..1]
Request
  • Field Name: remoteSupport.autoRequest.request
  • Type: String
  • Cardinality: [0..1]
  • Choices: ["DESK_VIEW", "DESK_CTRL", "APP_VIEW", "APP_CTRL"]
Sharing View
  • Field Name: remoteSupport.sharingView
  • Type: String
  • Cardinality: [0..1]
  • Choices: ["FS_SCALE", "FS", "WIN_SCALE", "WIN"]
Sharing Color
  • Field Name: remoteSupport.sharingColor
  • Type: String
  • Cardinality: [0..1]
  • Choices: ["256", "16BIT"]
Default Client
  • Field Name: defaultClient
  • Type: Object
  • Cardinality: [0..1]
Type *
  • Field Name: remoteSupport.defaultClient.type
  • Type: String
  • Cardinality: [1..1]
  • Choices: ["MULTI_SESS", "SINGLE_SESS"]
Single Sess Client
  • Field Name: remoteSupport.defaultClient.singleSessClient
  • Type: String
  • Cardinality: [0..1]
  • Choices: ["NEW_CONSL", "OLD_CONSL"]
Language ID
  • Field Name: languageID
  • Type: Integer
  • Cardinality: [0..1]
Locale
  • Field Name: locale
  • Type: String
  • Cardinality: [0..1]
Phones
  • Field Name: phones
  • Type: Object
  • Cardinality: [0..1]
Phone2
  • Field Name: phones.phone2
  • Type: String
  • Cardinality: [0..1]
Pager
  • Field Name: phones.pager
  • Type: String
  • Cardinality: [0..1]
Mobile Phone2
  • Field Name: phones.mobilePhone2
  • Type: String
  • Cardinality: [0..1]
PIN
  • Field Name: phones.PIN
  • Type: String
  • Cardinality: [0..1]
User Id Default: -1
  • Field Name: userId
  • Type: Integer
  • Cardinality: [0..1]
  • Default: -1
Web Ex Id *
  • Field Name: webExId
  • Type: String
  • Cardinality: [1..1]
Personal Teleconf
  • Field Name: personalTeleconf
  • Type: Object
  • Cardinality: [0..1]
Join Before Host
  • Field Name: personalTeleconf.joinBeforeHost
  • Type: Boolean
  • Cardinality: [0..1]
Account
  • Field Name: account.[n]
  • Type: Array
  • Cardinality: [0..3]
Account Index *
  • Field Name: personalTeleconf.account.[n].accountIndex
  • Type: Integer
  • Cardinality: [1..1]
Subscriber Access Code
  • Field Name: personalTeleconf.account.[n].subscriberAccessCode
  • Type: String
  • Cardinality: [0..1]
Auto Generate
  • Field Name: personalTeleconf.account.[n].autoGenerate
  • Type: Boolean
  • Cardinality: [0..1]
Participant Limited Access Code
  • Field Name: personalTeleconf.account.[n].participantLimitedAccessCode
  • Type: String
  • Cardinality: [0..1]
Participant Full Access Code
  • Field Name: personalTeleconf.account.[n].participantFullAccessCode
  • Type: String
  • Cardinality: [0..1]
Join Before Host
  • Field Name: personalTeleconf.account.[n].joinBeforeHost
  • Type: Boolean
  • Cardinality: [0..1]
Default Flag
  • Field Name: personalTeleconf.account.[n].defaultFlag
  • Type: Boolean
  • Cardinality: [0..1]
Delete
  • Field Name: personalTeleconf.account.[n].delete
  • Type: Boolean
  • Cardinality: [0..1]
Expiration Date
  • Field Name: expirationDate
  • Type: String
  • Cardinality: [0..1]
Email2
  • Field Name: email2
  • Type: String
  • Cardinality: [0..1]
Personal Url
  • Field Name: personalUrl
  • Type: String
  • Cardinality: [0..1]
Comm Options
  • Field Name: commOptions
  • Type: Object
  • Cardinality: [0..1]
Electronic Info
  • Field Name: commOptions.electronicInfo
  • Type: Boolean
  • Cardinality: [0..1]
Fax
  • Field Name: commOptions.fax
  • Type: Boolean
  • Cardinality: [0..1]
Phone
  • Field Name: commOptions.phone
  • Type: Boolean
  • Cardinality: [0..1]
Promos
  • Field Name: commOptions.promos
  • Type: Boolean
  • Cardinality: [0..1]
Training Info
  • Field Name: commOptions.trainingInfo
  • Type: Boolean
  • Cardinality: [0..1]
Press
  • Field Name: commOptions.press
  • Type: Boolean
  • Cardinality: [0..1]
Mail
  • Field Name: commOptions.mail
  • Type: Boolean
  • Cardinality: [0..1]
Prod Announce
  • Field Name: commOptions.prodAnnounce
  • Type: Boolean
  • Cardinality: [0..1]
Email
  • Field Name: commOptions.email
  • Type: Boolean
  • Cardinality: [0..1]
Meeting Types
  • Field Name: meetingTypes
  • Type: Object
  • Cardinality: [0..1]
Meeting Type
  • Field Name: meetingType.[n]
  • Type: Array
Title
  • Field Name: title
  • Type: String
  • Cardinality: [0..1]
Session Options
  • Field Name: sessionOptions
  • Type: Object
  • Cardinality: [0..1]
Auto Delete After Meeting End
  • Field Name: sessionOptions.autoDeleteAfterMeetingEnd
  • Type: Boolean
  • Cardinality: [0..1]
Display Quick Start Host
  • Field Name: sessionOptions.displayQuickStartHost
  • Type: Boolean
  • Cardinality: [0..1]
Display Quick Start Attendees
  • Field Name: sessionOptions.displayQuickStartAttendees
  • Type: Boolean
  • Cardinality: [0..1]
Default Service Type
  • Field Name: sessionOptions.defaultServiceType
  • Type: String
  • Cardinality: [0..1]
  • Choices: ["MeetingCenter", "EventCenter", "TrainingCenter", "SupportCenter", "SalesCenter"]
Default Session Type
  • Field Name: sessionOptions.defaultSessionType
  • Type: Integer
  • Cardinality: [0..1]
Supported Services
  • Field Name: supportedServices
  • Type: Object
  • Cardinality: [0..1]
Event Center
  • Field Name: supportedServices.eventCenter
  • Type: Boolean
  • Cardinality: [0..1]
Sales Center
  • Field Name: supportedServices.salesCenter
  • Type: Boolean
  • Cardinality: [0..1]
Support Center
  • Field Name: supportedServices.supportCenter
  • Type: Boolean
  • Cardinality: [0..1]
Meeting Center
  • Field Name: supportedServices.meetingCenter
  • Type: Boolean
  • Cardinality: [0..1]
Training Center
  • Field Name: supportedServices.trainingCenter
  • Type: Boolean
  • Cardinality: [0..1]
Privilege
  • Field Name: privilege
  • Type: Object
  • Cardinality: [0..1]
Is Enable CET
  • Field Name: privilege.isEnableCET
  • Type: Boolean
  • Cardinality: [0..1]
Is Enable PMR
  • Field Name: privilege.isEnablePMR
  • Type: Boolean
  • Cardinality: [0..1]
Attendee Only
  • Field Name: privilege.attendeeOnly
  • Type: Boolean
  • Cardinality: [0..1]
Tele Conf Call Out
  • Field Name: privilege.teleConfCallOut
  • Type: Boolean
  • Cardinality: [0..1]
Ro Site Admin
  • Field Name: privilege.roSiteAdmin
  • Type: Boolean
  • Cardinality: [0..1]
Voice Over Ip
  • Field Name: privilege.voiceOverIp
  • Type: Boolean
  • Cardinality: [0..1]
Allow Ext Attendees
  • Field Name: privilege.allowExtAttendees
  • Type: Boolean
  • Cardinality: [0..1]
Tele Conf Call Out International
  • Field Name: privilege.teleConfCallOutInternational
  • Type: Boolean
  • Cardinality: [0..1]
Meeting Assist
  • Field Name: privilege.meetingAssist
  • Type: Boolean
  • Cardinality: [0..1]
Tele Conf Toll Free Call In
  • Field Name: privilege.teleConfTollFreeCallIn
  • Type: Boolean
  • Cardinality: [0..1]
H Dvideo
  • Field Name: privilege.HDvideo
  • Type: Boolean
  • Cardinality: [0..1]
Host
  • Field Name: privilege.host
  • Type: Boolean
  • Cardinality: [0..1]
Recording Editor
  • Field Name: privilege.recordingEditor
  • Type: Boolean
  • Cardinality: [0..1]
Site Admin
  • Field Name: privilege.siteAdmin
  • Type: Boolean
  • Cardinality: [0..1]
Tele Conf Call In
  • Field Name: privilege.teleConfCallIn
  • Type: Boolean
  • Cardinality: [0..1]
Tele Conf Call In International
  • Field Name: privilege.teleConfCallInInternational
  • Type: Boolean
  • Cardinality: [0..1]
Other Telephony Default: True
  • Field Name: privilege.otherTelephony
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Lab Admin
  • Field Name: privilege.labAdmin
  • Type: Boolean
  • Cardinality: [0..1]
H Qvideo
  • Field Name: privilege.HQvideo
  • Type: Boolean
  • Cardinality: [0..1]
Email *
  • Field Name: email
  • Type: String
  • Cardinality: [0..1]
Web ACD Prefs
  • Field Name: webACDPrefs
  • Type: Object
  • Cardinality: [0..1]
Manager Monitor All RS Queues
  • Field Name: webACDPrefs.managerMonitorAllRSQueues
  • Type: Boolean
  • Cardinality: [0..1]
Monitor All RS Agents
  • Field Name: webACDPrefs.monitorAllRSAgents
  • Type: Boolean
  • Cardinality: [0..1]
Agent Monitor All RS Queues
  • Field Name: webACDPrefs.agentMonitorAllRSQueues
  • Type: Boolean
  • Cardinality: [0..1]
Num Agent Sessions
  • Field Name: webACDPrefs.numAgentSessions
  • Type: Integer
  • Cardinality: [0..1]
Is Agent
  • Field Name: webACDPrefs.isAgent
  • Type: Boolean
  • Cardinality: [0..1]
Is Mgr
  • Field Name: webACDPrefs.isMgr
  • Type: Boolean
  • Cardinality: [0..1]
Time Zone ID Default: -1
  • Field Name: timeZoneID
  • Type: Integer
  • Cardinality: [0..1]
  • Default: -1
Description
  • Field Name: description
  • Type: String
  • Cardinality: [0..1]
Personal Meeting Room
  • Field Name: personalMeetingRoom
  • Type: Object
  • Cardinality: [0..1]
Photo URL
  • Field Name: personalMeetingRoom.photoURL
  • Type: String
  • Cardinality: [0..1]
Sip URL
  • Field Name: personalMeetingRoom.sipURL
  • Type: String
  • Cardinality: [0..1]
Welcome Message
  • Field Name: personalMeetingRoom.welcomeMessage
  • Type: String
  • Cardinality: [0..1]
Pilot Number
  • Field Name: personalMeetingRoom.pilotNumber
  • Type: String
  • Cardinality: [0..1]
Personal Meeting Room URL
  • Field Name: personalMeetingRoom.personalMeetingRoomURL
  • Type: String
  • Cardinality: [0..1]
Host PIN
  • Field Name: personalMeetingRoom.hostPIN
  • Type: String
  • Cardinality: [0..1]
Header Image Branding
  • Field Name: personalMeetingRoom.headerImageBranding
  • Type: Boolean
  • Cardinality: [0..1]
Apply PMR For Instant Meeting
  • Field Name: personalMeetingRoom.applyPMRForInstantMeeting
  • Type: Boolean
  • Cardinality: [0..1]
Access Code
  • Field Name: personalMeetingRoom.accessCode
  • Type: String
  • Cardinality: [0..1]
Header Image URL
  • Field Name: personalMeetingRoom.headerImageURL
  • Type: String
  • Cardinality: [0..1]
Company
  • Field Name: company
  • Type: String
  • Cardinality: [0..1]
Office Greeting
  • Field Name: officeGreeting
  • Type: String
  • Cardinality: [0..1]
Tsp Account
  • Field Name: tspAccount
  • Type: Object
  • Cardinality: [0..1]
Tsp Account
  • Field Name: tspAccount.[n]
  • Type: Array
  • Cardinality: [0..3]
Toll Free Call In Number
  • Field Name: tspAccount.tspAccount.[n].tollFreeCallInNumber
  • Type: String
  • Cardinality: [0..1]
Participant Access Code
  • Field Name: tspAccount.tspAccount.[n].participantAccessCode
  • Type: String
  • Cardinality: [0..1]
Nbr Dial Out
  • Field Name: tspAccount.tspAccount.[n].nbrDialOut
  • Type: String
  • Cardinality: [0..1]
  • Choices: ["TOLL_FREE", "TOLL"]
Create On Bridge
  • Field Name: tspAccount.tspAccount.[n].createOnBridge
  • Type: Boolean
  • Cardinality: [0..1]
Subscriber Access Code
  • Field Name: tspAccount.tspAccount.[n].subscriberAccessCode
  • Type: String
  • Cardinality: [0..1]
Toll Call In Data
  • Field Name: tspAccount.tspAccount.[n].tollCallInData
  • Type: String
  • Cardinality: [0..1]
Custom1
  • Field Name: tspAccount.tspAccount.[n].custom1
  • Type: String
  • Cardinality: [0..1]
Custom2
  • Field Name: tspAccount.tspAccount.[n].custom2
  • Type: String
  • Cardinality: [0..1]
Custom3
  • Field Name: tspAccount.tspAccount.[n].custom3
  • Type: String
  • Cardinality: [0..1]
Toll Call In Number
  • Field Name: tspAccount.tspAccount.[n].tollCallInNumber
  • Type: String
  • Cardinality: [0..1]
Toll Free Call In Data
  • Field Name: tspAccount.tspAccount.[n].tollFreeCallInData
  • Type: String
  • Cardinality: [0..1]
Account Index
  • Field Name: tspAccount.tspAccount.[n].accountIndex
  • Type: Integer
  • Cardinality: [0..1]
Default Flag
  • Field Name: tspAccount.tspAccount.[n].defaultFlag
  • Type: Boolean
  • Cardinality: [0..1]
Delete
  • Field Name: tspAccount.tspAccount.[n].delete
  • Type: Boolean
  • Cardinality: [0..1]
Language
  • Field Name: language
  • Type: String
  • Cardinality: [0..1]
Visit Count
  • Field Name: visitCount
  • Type: Integer
  • Cardinality: [0..1]
Address
  • Field Name: address
  • Type: Object
  • Cardinality: [0..1]
City
  • Field Name: address.city
  • Type: String
  • Cardinality: [0..1]
Address Type Default: PERSONAL
  • Field Name: address.addressType
  • Type: String
  • Cardinality: [0..1]
  • Default: PERSONAL
  • Choices: ["PERSONAL", "GLOBAL"]
Address1
  • Field Name: address.address1
  • Type: String
  • Cardinality: [0..1]
Address2
  • Field Name: address.address2
  • Type: String
  • Cardinality: [0..1]
Zip Code
  • Field Name: address.zipCode
  • Type: String
  • Cardinality: [0..1]
State
  • Field Name: address.state
  • Type: String
  • Cardinality: [0..1]
Country
  • Field Name: address.country
  • Type: String
  • Cardinality: [0..1]
Active *
  • Field Name: active
  • Type: String
  • Cardinality: [0..1]
  • Choices: ["ACTIVATED", "REQUEST_TO_ACTIVATE", "DEACTIVATED"]
Password *
  • Field Name: password
  • Type: String
  • Is Password: True
  • Cardinality: [0..1]
  • MaxLength: 60
Remote Access
  • Field Name: remoteAccess
  • Type: Object
  • Cardinality: [0..1]
Recording
  • Field Name: recording
  • Type: Object
  • Cardinality: [0..1]
Type
  • Field Name: remoteAccess.recording.type
  • Type: String
  • Cardinality: [0..1]
  • Choices: ["NBR", "LOCAL"]
Enforce *
  • Field Name: remoteAccess.recording.enforce
  • Type: Boolean
  • Cardinality: [1..1]
Location
  • Field Name: remoteAccess.recording.location
  • Type: String
  • Cardinality: [0..1]
Sharing View
  • Field Name: remoteAccess.sharingView
  • Type: String
  • Cardinality: [0..1]
  • Choices: ["FS_SCALE", "FS", "WIN_SCALE", "WIN"]
Sharing Color
  • Field Name: remoteAccess.sharingColor
  • Type: String
  • Cardinality: [0..1]
  • Choices: ["256", "16BIT"]
Officeurl
  • Field Name: officeurl
  • Type: String
  • Cardinality: [0..1]
Tracking
  • Field Name: tracking
  • Type: Object
  • Cardinality: [0..1]
Tracking Code5
  • Field Name: tracking.trackingCode5
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 128
Tracking Code4
  • Field Name: tracking.trackingCode4
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 128
Tracking Code7
  • Field Name: tracking.trackingCode7
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 128
Tracking Code6
  • Field Name: tracking.trackingCode6
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 128
Tracking Code1
  • Field Name: tracking.trackingCode1
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 128
Tracking Code10
  • Field Name: tracking.trackingCode10
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 128
Tracking Code3
  • Field Name: tracking.trackingCode3
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 128
Tracking Code2
  • Field Name: tracking.trackingCode2
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 128
Tracking Code9
  • Field Name: tracking.trackingCode9
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 128
Tracking Code8
  • Field Name: tracking.trackingCode8
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 128
My Web Ex
  • Field Name: myWebEx
  • Type: Object
  • Cardinality: [0..1]
Is My Web Ex Pro
  • Field Name: myWebEx.isMyWebExPro
  • Type: Boolean
  • Cardinality: [0..1]
Total Storage Size
  • Field Name: myWebEx.totalStorageSize
  • Type: Integer
  • Cardinality: [0..1]
My Profile
  • Field Name: myWebEx.myProfile
  • Type: Boolean
  • Cardinality: [0..1]
My Meetings
  • Field Name: myWebEx.myMeetings
  • Type: Boolean
  • Cardinality: [0..1]
My Computer
  • Field Name: myWebEx.myComputer
  • Type: Integer
  • Cardinality: [0..1]
My Folders
  • Field Name: myWebEx.myFolders
  • Type: Boolean
  • Cardinality: [0..1]
Personal Meeting Room
  • Field Name: myWebEx.personalMeetingRoom
  • Type: Boolean
  • Cardinality: [0..1]
My Contact
  • Field Name: myWebEx.myContact
  • Type: Boolean
  • Cardinality: [0..1]
My Workspaces
  • Field Name: myWebEx.myWorkspaces
  • Type: Boolean
  • Cardinality: [0..1]
Additional Recording Storage
  • Field Name: myWebEx.additionalRecordingStorage
  • Type: Integer
  • Cardinality: [0..1]
My Partner Links
  • Field Name: myWebEx.myPartnerLinks
  • Type: Boolean
  • Cardinality: [0..1]
Recorded Events
  • Field Name: myWebEx.recordedEvents
  • Type: Boolean
  • Cardinality: [0..1]
My Reports
  • Field Name: myWebEx.myReports
  • Type: Boolean
  • Cardinality: [0..1]
Training Recordings
  • Field Name: myWebEx.trainingRecordings
  • Type: Boolean
  • Cardinality: [0..1]
Service
  • Field Name: service
  • Type: String
  • Cardinality: [0..1]
  • Choices: ["FREE_OFFICE", "STANDARD_OFFICE", "PRO_OFFICE"]
First Name *
  • Field Name: firstName
  • Type: String
  • Cardinality: [0..1]
Scheduling Permission
  • Field Name: schedulingPermission
  • Type: String
  • Cardinality: [0..1]
Password Hint Answer
  • Field Name: passwordHintAnswer
  • Type: String
  • Cardinality: [0..1]
Last Name *
  • Field Name: lastName
  • Type: String
  • Cardinality: [0..1]
Category Id
  • Field Name: categoryId
  • Type: Integer
  • Cardinality: [0..1]
Support Center
  • Field Name: supportCenter
  • Type: Object
  • Cardinality: [0..1]
Service Desk
  • Field Name: serviceDesk
  • Type: Object
  • Cardinality: [0..1]
Enable
  • Field Name: supportCenter.serviceDesk.enable
  • Type: Boolean
  • Cardinality: [0..1]
Order Tabs
  • Field Name: orderTabs
  • Type: Object
  • Cardinality: [0..1]
Tab
  • Field Name: tab.[n]
  • Type: Array
  • Cardinality: [4..4]
Third Party Teleconf
  • Field Name: thirdPartyTeleconf
  • Type: Object
  • Cardinality: [0..1]
Account
  • Field Name: account.[n]
  • Type: Array
  • Cardinality: [0..3]
Moderator Code
  • Field Name: thirdPartyTeleconf.account.[n].moderatorCode
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 32
Conf Bridge Num
  • Field Name: thirdPartyTeleconf.account.[n].confBridgeNum
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 32
Pause
  • Field Name: thirdPartyTeleconf.account.[n].pause
  • Type: Integer
  • Cardinality: [0..1]
Name
  • Field Name: thirdPartyTeleconf.account.[n].name
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 32
Account Index *
  • Field Name: thirdPartyTeleconf.account.[n].accountIndex
  • Type: Integer
  • Cardinality: [1..1]
Phone Name1
  • Field Name: thirdPartyTeleconf.account.[n].phoneName1
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 32
Access Code
  • Field Name: thirdPartyTeleconf.account.[n].accessCode
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 32
Phone Name2
  • Field Name: thirdPartyTeleconf.account.[n].phoneName2
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 32
Toll Free Num
  • Field Name: thirdPartyTeleconf.account.[n].tollFreeNum
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 32
Default Flag
  • Field Name: thirdPartyTeleconf.account.[n].defaultFlag
  • Type: Boolean
  • Cardinality: [0..1]
Mp Profile Number
  • Field Name: mpProfileNumber
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 64
Password Hint
  • Field Name: passwordHint
  • Type: String
  • Cardinality: [0..1]
Time Zone
  • Field Name: timeZone
  • Type: String
  • Cardinality: [0..1]
  • Choices: ["GMT-12:00, Dateline (Eniwetok)", "GMT-11:00, Samoa (Samoa)", "GMT-10:00, Hawaii (Honolulu)", "GMT-09:00, Alaska (Ancorage)", "GMT-08:00, Pacific (San Jose)", "GMT-07:00, Mountain (Arizona)", "GMT-07:00, Mountain (Denver)", "GMT-06:00, Central (Chicago)", "GMT-06:00, Mexico (Mexico City,Tegucigalpa)", "GMT-06:00, Central (Regina)", "GMT-05:00, S. America Pacific (Bogota)", "GMT-05:00, Eastern (New York)", "GMT-05:00, Eastern (Indiana)", "GMT-04:00, Atlantic (Halifax)", "GMT-04:00, S. America Western (Caracas)", "GMT-03:30, Newfoundland (Newfoundland)", "GMT-03:00, S. America Eastern (Brasilia)", "GMT-03:00, S. America Eastern (Buenos Aires)", "GMT-02:00, Mid-Atlantic (Mid-Atlantic)", "GMT-01:00, Azores (Azores)", "GMT+00:00, Greenwich (Casablanca)", "GMT+00:00, GMT (London)", "GMT+01:00, Europe (Amsterdam)", "GMT+01:00, Europe (Paris)", "GMT+01:00, Europe (Prague)", "GMT+01:00, Europe (Berlin)", "GMT+02:00, Greece (Athens)", "GMT+02:00, Eastern Europe (Bucharest)", "GMT+02:00, Egypt (Cairo)", "GMT+02:00, South Africa (Pretoria)", "GMT+02:00, Northern Europe (Helsinki)", "GMT+02:00, Israel (Tel Aviv)", "GMT+03:00, Saudi Arabia (Baghdad)", "GMT+03:00, Russian (Moscow)", "GMT+03:00, Nairobi (Nairobi)", "GMT+03:00, Iran (Tehran)", "GMT+04:00, Arabian (Abu Dhabi, Muscat)", "GMT+04:00, Baku (Baku)", "GMT+04:00, Afghanistan (Kabul)", "GMT+05:00, West Asia (Ekaterinburg)", "GMT+05:00, West Asia (Islamabad)", "GMT+05:30, India (Bombay)", "GMT+06:00, Columbo (Columbo)", "GMT+06:00, Central Asia (Almaty)", "GMT+07:00, Bangkok (Bangkok)", "GMT+08:00, China (Beijing)", "GMT+08:00, Australia Western (Perth)", "GMT+08:00, Singapore (Singapore)", "GMT+08:00, Taipei (Hong Kong)", "GMT+09:00, Tokyo (Tokyo)", "GMT+09:00, Korea (Seoul)", "GMT+09:30, Yakutsk (Yakutsk)", "GMT+09:30, Australia Central (Adelaide)", "GMT+09:30, Australia Central (Darwin)", "GMT+10:00, Australia Eastern (Brisbane)", "GMT+10:00, Australia Eastern (Sydney)", "GMT+10:00, West Pacific (Guam)", "GMT+10:00, Tasmania (Hobart)", "GMT+10:00, Vladivostok (Vladivostok)", "GMT+11:00, Central Pacific (Solomon Is)", "GMT+12:00, New Zealand (Wellington)", "GMT+12:00, Fiji (Fiji)", "GMT-09:00, Alaska (Anchorage)"]
Security
  • Field Name: security
  • Type: Object
  • Cardinality: [0..1]
Force Change Password
  • Field Name: security.forceChangePassword
  • Type: Boolean
  • Cardinality: [0..1]
Lock Account
  • Field Name: security.lockAccount
  • Type: Boolean
  • Cardinality: [0..1]
Reset Password
  • Field Name: security.resetPassword
  • Type: Boolean
  • Cardinality: [0..1]
Registration Date
  • Field Name: registrationDate
  • Type: String
  • Cardinality: [0..1]
Options
  • Field Name: options
  • Type: Object
  • Cardinality: [0..1]
Notify On New Message
  • Field Name: options.notifyOnNewMessage
  • Type: Boolean
  • Cardinality: [0..1]
Folder Read
  • Field Name: options.folderRead
  • Type: Boolean
  • Cardinality: [0..1]
Subscription Office
  • Field Name: options.subscriptionOffice
  • Type: Boolean
  • Cardinality: [0..1]
List In Category
  • Field Name: options.listInCategory
  • Type: Boolean
  • Cardinality: [0..1]
Picture Visible
  • Field Name: options.pictureVisible
  • Type: Boolean
  • Cardinality: [0..1]
Notify On Link Request
  • Field Name: options.notifyOnLinkRequest
  • Type: Boolean
  • Cardinality: [0..1]
Support Meeting Record
  • Field Name: options.supportMeetingRecord
  • Type: Boolean
  • Cardinality: [0..1]
Title Visible
  • Field Name: options.titleVisible
  • Type: Boolean
  • Cardinality: [0..1]
Cell Phone Visible
  • Field Name: options.cellPhoneVisible
  • Type: Boolean
  • Cardinality: [0..1]
Office Url Visible
  • Field Name: options.officeUrlVisible
  • Type: Boolean
  • Cardinality: [0..1]
Support Desktop Share
  • Field Name: options.supportDesktopShare
  • Type: Boolean
  • Cardinality: [0..1]
Fax Visible
  • Field Name: options.faxVisible
  • Type: Boolean
  • Cardinality: [0..1]
Folder Write
  • Field Name: options.folderWrite
  • Type: Boolean
  • Cardinality: [0..1]
Support Desktop Share Remote
  • Field Name: options.supportDesktopShareRemote
  • Type: Boolean
  • Cardinality: [0..1]
Hold On Link Request
  • Field Name: options.holdOnLinkRequest
  • Type: Boolean
  • Cardinality: [0..1]
Notify On Meeting
  • Field Name: options.notifyOnMeeting
  • Type: Boolean
  • Cardinality: [0..1]
Email Visible
  • Field Name: options.emailVisible
  • Type: Boolean
  • Cardinality: [0..1]
Is Enable CET
  • Field Name: options.isEnableCET
  • Type: Boolean
  • Cardinality: [0..1]
Message Visible
  • Field Name: options.messageVisible
  • Type: Boolean
  • Cardinality: [0..1]
Icon Select2
  • Field Name: options.iconSelect2
  • Type: Boolean
  • Cardinality: [0..1]
Icon Select1
  • Field Name: options.iconSelect1
  • Type: Boolean
  • Cardinality: [0..1]
Work Phone Visible
  • Field Name: options.workPhoneVisible
  • Type: Boolean
  • Cardinality: [0..1]
Support App
  • Field Name: options.supportApp
  • Type: Boolean
  • Cardinality: [0..1]
Support Appshare Remote
  • Field Name: options.supportAppshareRemote
  • Type: Boolean
  • Cardinality: [0..1]
Accept Link Request
  • Field Name: options.acceptLinkRequest
  • Type: Boolean
  • Cardinality: [0..1]
First Name Visible
  • Field Name: options.firstNameVisible
  • Type: Boolean
  • Cardinality: [0..1]
Support File Share
  • Field Name: options.supportFileShare
  • Type: Boolean
  • Cardinality: [0..1]
Support Web Tour Remote
  • Field Name: options.supportWebTourRemote
  • Type: Boolean
  • Cardinality: [0..1]
Follow Me Enable
  • Field Name: options.followMeEnable
  • Type: Boolean
  • Cardinality: [0..1]
Address Visible
  • Field Name: options.addressVisible
  • Type: Boolean
  • Cardinality: [0..1]
Last Name Visible
  • Field Name: options.lastNameVisible
  • Type: Boolean
  • Cardinality: [0..1]
Support Video
  • Field Name: options.supportVideo
  • Type: Boolean
  • Cardinality: [0..1]
Pager Visible
  • Field Name: options.pagerVisible
  • Type: Boolean
  • Cardinality: [0..1]