Guest

Cisco WebEx Social

Exporting Data from Cisco WebEx Social, Release 3.4.2

  • Viewing Options

  • PDF (364.4 KB)
  • Feedback

Table of Contents

Exporting Data from Cisco WebEx Social, Release 3.4.2

Overview

Portal Properties

Export File Size Portal Properties

Export Operation Performance Portal Property

Configuring Portal Properties

Exporting Data

Export Folders and Files

Export Folders

Export Files

Error Handling

Exported Data Formats

Community Export File

Post Export File

Post Comment Export File

User Export File

User Group Export File

Exporting Data from Cisco WebEx Social, Release 3.4.2

Revised: February 19, 2014

This document explains how to export data from Cisco WebEx Social 3.4.2 into files that you can then import to other systems. It also describes the format of files that contain exported data.

This document contains these sections:

Export File Size Portal Properties

Export Operation Performance Portal Property

Configuring Portal Properties

Export Folders

Export Files

Community Export File

Post Export File

Post Comment Export File

User Export File

User Group Export File

Overview

The Cisco WebEx Social data export feature lets you export data from various Cisco WebEx Social entities, including communities, posts, post comments, users, and user groups. When you execute an export operation, the system extracts data from the entities that you specify and saves the data in one or more export files that it stores in an export folder on the NFS server. You can then import this data to other systems.

The data extraction process is handled by the Worker nodes in your Cisco WebEx Social cluster. For efficiency, Cisco recommends that your cluster have at least two Worker nodes when you execute an export operation.

Portal Properties

Cisco WebEx Social provides portal properties that control the size of export files and the operation of the export process. The following sections describe these portal properties and explain how to configure them:

Export File Size Portal Properties

Table 1 describes the portal properties that control the size of export files. Each field accepts integer values of 1 and above. To change a value, see the “Configuring Portal Properties” section.

 

Table 1 Portal Properties for Export File Sizes

Portal Property
Description
Default Value

com.cisco.ecp.vdl.dataexport.community.batch.size

Maximum number of records in an export file that contains data from communities

500

com.cisco.ecp.vdl.dataexport.post.batch.size

Maximum number of records in an export file that contains data from posts

500

com.cisco.ecp.vdl.dataexport.
postcomment.batch.size

Maximum number of records in an export file that contains data from post comments

500

com.cisco.ecp.vdl.dataexport.user.batch.
size

Maximum number of records in an export file that contains data from users

500

com.cisco.ecp.vdl.dataexport.usergroup.
batch.size

Maximum number of records in an export file that contains data from user groups

500

Export Operation Performance Portal Property

When you execute an export operation, the extraction of data from the entities that you designate is performed by a message processor thread that runs on each Worker node in your Cisco WebEx Social cluster. If the cluster includes multiple Worker nodes, the message processor thread runs in parallel on each of these nodes, which reduces the time that data extraction requires.

By default, one message processor thread runs on each Worker node, but running multiple threads further reduces the time that data extraction requires. The extra.migration.reciever.count portal property lets you designate that additional message processor threads (up to a total of four threads) run on each Worker node when you execute an export operation.

Valid values for the extra.migration.reciever.count portal property are the integers 0 through 3. A value of 0 means no additional message processor threads, so with this value, 1 thread runs on each Worker node. A value of 1 means that 1 additional thread, or a total of 2 threads, run on each Worker node. Similarly, values of 2 or 3 indicate a total of 3 threads or 4 threads, respectively.

The default value is 0 (no additional threads). To change the value, see the “Configuring Portal Properties” section.

A message processor thread requires significant processor and memory resources on a Worker node, so running additional threads on a node affects overall system performance. Table 2 shows recommended values for the extra.migration.reciever.count portal property, based on the following factors:

  • Cisco WebEx Social environment—Whether end users are performing Cisco WebEx Social activities when you execute an export operation and the relative amount of data that you are exporting
  • Worker node specification—The number of CPUs and the amount of memory on each Worker node in your Cisco WebEx Social cluster

 

Table 2 Recommended Values for extra.migration.reciever.count Portal Property

Cisco WebEx Social Environment
Worker Node Specification
Portal Property Value
Recommended
Maximum

In use by end users

0

0

Not in use by end users

Low to medium amount of data to export

4 CPUs

8 GB memory

1

2

Not in use by end users

Large amount of data to export

6 CPUs

8 GB memory or more

2

3

Configuring Portal Properties

To configure the file size or performance portal properties that relate to export operations, follow these steps:

Procedure


Step 1 Sign in to the Director.

Step 2 Click Application in the Director menu bar, then select Portal from the list on the left of your screen.

Step 3 (Optional) Designate the number of portal properties that appear on each page by selecting the number from the Show drop-down list.

Step 4 Take either of these actions to locate the portal property that you want to change:

  • Scroll through the list of properties, using the Next and Previous buttons as needed to go to other pages of the list.
  • Type part of all of a property name in the Search field. The system automatically displays matching properties as you type.

Step 5 Enter the new value in the Value field.

Step 6 Click Save .

The App Server nodes restart automatically.


 

Exporting Data

To export data from Cisco WebEx Social, perform the steps that this section describes.

Before You Begin

Review these guidelines before you perform an export operation:

  • Execute an export operation during a scheduled maintenance window. An export operation consumes significant system resources, which affects system performance.
  • Make sure that your entire Cisco WebEx Social cluster is running while you perform an export operation.
  • Make sure that users do not create or update Cisco WebEx Social data while an export operation is in process.
  • Make sure that file size and performance portal properties are set as appropriate for your situation. See the Portal Properties.
  • Make sure that the NFS server has enough disk space to store the files that the export process creates. A typical export operation for all Cisco WebEx Social entities requires 10 to 20 GB of disk space.

Procedure


Step 1 From Cisco WebEx Social, take these actions to access the Server Administration window:

a. Click the down-arrow to the right of your name in the Global Navigation bar.

b. Select Account Settings from the drop-down menu.

c. Click the right-arrow next to Server

d. Click Server Administration in the Server drawer.

Step 2 Select the Data Export tab in the Server Administration window.

This window lists the following Cisco WebEx Social entities from which you can export data:

  • Communities
  • Post Comments
  • Posts
  • User Groups
  • Users

Step 3 Check one or more boxes to select the corresponding entity for data export.

To quickly select all entities, click the topmost check box.

Data from the selected entity is exported when you execute the export operation.

Step 4 Click the Execute button.

The system exports data from the selected entities to files that are created and stored on the NFS server, as described the “Export Folders and Files” section.

You can monitor progress of the export operation by clicking the Refresh button to update the information in the following fields in the Server Administration window:

  • Status—Information in this field includes the following for the corresponding entity:

Not started —A data export operation has not been started

Started —A data export operation has been started but the Worker nodes have not started the data extraction process

In progress —A data export operation has been started and Worker nodes are extracting data

Complete —A data export operation completed successfully

Completed with errors —A data export operation completed and an error file has been generated

  • % Complete—Percentage of the export operation that has completed for the corresponding entity
  • Completed Time—Date and time that the last export operation completed for the corresponding entity

Step 5 After the export operation completes, use the following buttons as needed:

  • Zip All Files button—Click to create on the NFS server a Zip file that includes all files from the last export operation that was performed. The Zip file is saved in the same folder in which the exported files that it includes are saved.
  • Download Zip File button—Becomes available after you click the Zip All Files button. Click to download the last Zip file that was created with the Zip All Files button to your local drive or a network drive.
  • Delete All Files button—Click to permanently delete from the NFS server all export files and all Zip files from all export operations. In the dialog box that appears, click Delete All Files to complete the deletion or click the Cancel button to cancel the delete operation.


 

Export Folders and Files

When you execute an export operation, the system saves exported data in export files that it stores in an export folder on the NFS server. The following sections describes these folders and files:

Export Folders

Each time you execute an export operation, the system creates an export folder under the /mnt/auto/cms/extraction folder on the NFS server. You can access export folders through App Server nodes or Worker nodes.

The export folder is named as follows.

yyyymmdd - hh - mm - ss

where:

  • yyyy —Year in which the export process started
  • mm —Numerical representation of the month in which the export process started
  • dd — Date of the month on which the export process started
  • hh —Hour, in 24-hour format, at which the export process started
  • mm —Minute after the hour at which the export process started
  • ss —Seconds after the hour at which the export process started

The dates and times in the export folder name are based on the time zone of the primary Cisco WebEx Social App Server.

For example, if you started an export operation at 15 minutes and 12 seconds after 8:20 p.m. on January 20, 2014, the export folder is named 20140120-20-15-12.

Export Files

The data that the system exports during an export operation is stored in one or more export files under an export folder that the system creates for that operation. You can access export files through App Server nodes or Worker nodes.

An export file contains information for one entity type (such as a community, a post, or a user), and contains up to the number of records that the export file size portal property for that entity type defines. (The default number of records for each export file is 500. See the “Export File Size Portal Properties” section for more information.) The records in an export file are in ascending order according to a sort key for each entity type.

If an entity contains more records than the file export file size portal property defines, the system splits the data into multiple files. For example, consider the following situation:

  • You perform an export operation for user information
  • Your system includes 10,350 users
  • The export file size property for user data is set to the default value of 500

In this case, the system creates 21 export files. The first 20 export files contain 500 records each, and the 21st export files contains 350 records.

An export file is named as follows.

Entity _EXPORT_ StartRecord - EndRecord .txt

Where:

  • Entity —Cisco WebEx Social entity from which the data is exported. Values are:

COMMUNITY

POST_COMMENT

POST

USER_GROUP

USER

  • StartRecord —The record number (based on the sort key) of the first record in the export file
  • EndRecord —The record number (based on the sort key) of the last record in the export file

Table 3 provides examples of export files names and shows the sort key for each export file type.

 

Table 3 Export File Names and Sort Key

Entity
File Name Example
Sort Key

Communities

COMMUNITY_EXPORT_1-6.txt

Community ID

Post Comments

POST_COMMENT_EXPORT_1-235.txt

Post comment ID

Posts

POST_EXPORT_1-197.txt

Post ID

User Groups

USER_GROUP_EXPORT_1-68.txt

User Group ID

Users

USER_EXPORT_1-23.txt

User ID

Error Handling

If during a data export process the system encounters an error or data inconstancy that prevents the system from exporting data from one or more records, the system creates error files that provide information about the situation. An error file contains a comma-separated list of the entity identifier for each record that could not be exported.

An error file for an export operation is stored in the export folder that the system creates on the NFS server when you execute the operation. To determine additional information if an error occurs, see the logs for the App Server nodes and the Worker nodes.

An error file is named as follows:

Entity _EXPORT_ StartRecord - EndRecord _err.txt

Where:

  • Entity —Cisco WebEx Social entity from which the data is exported. Values are:

COMMUNITY

POST_COMMENT

POST

USER_GROUP

USER

  • StartRecord —The record number (based on the sort key) of the first record in the export file
  • EndRecord —The record number (based on the sort key) of the last record in the export file

Examples of error file names are as follows:

  • COMMUNITY_EXPORT_1-500_err.txt—Error file for records 1 through 500 for community data
  • POST_COMMENT_EXPORT_1-500_err.txt—Error file for records 1 through 500 for post comment data
  • POST_EXPORT_1-500_err.txt—Error file for records 1 through 500 for post data
  • USER_GROUP_EXPORT_1-500_err.txt—Error file for records 1 through 500 for user group data
  • USER_EXPORT_1-500_err.tx—Error file for records 1 through 500 for user data

Exported Data Formats

An export file is a single JSON array that contains multiple records. These records includes fields that contain the data that an export operation obtained for the entity. Fields that include the value “null” are not included in an export file.

Some fields provide the URI of an attachment. To obtain an attachment, in a web browser enter the URI prepended with https:// hostname / , where hostname is the host name of the Cisco WebEx Social App Server. For example:

https://wxs.cisco.com/c/post_action/get_attachment?postId=123&postVersionId=1&attachmentId=324
 

The following sections provide information about the fields that each record in an export file can contain and provide examples of export file records. The examples in these sections are formatted for readability.

Community Export File

Table 4 describes the record fields for an export file that contains community data.

 

Table 4 Community Data Export File Record Fields

Field
Description

administratorUserGroups

Contains the following field for each user group that has the Administrator role for the community:

  • id—Unique identifier of the user group

administratorUsers

Contains the following field for each user who has the Administrator role for the community:

  • id—Unique identifier of the user

category

Contains the following fields:

  • id—Unique identifier of the community category to which the community belongs
  • name—Name of the community category to which the community belongs

creator

Contains the following fields:

  • id—Unique identifier of the user who created the community
  • screenName—Unique Cisco WebEx Social screen name of the user who created the community

customAttributes

Custom attributes of the community

description

Description of the community

email

Contains the following fields:

  • address—Email address of the community
  • primary—Indicates whether the email address is the primary email address of the entity ( true = primary address, false = not primary address)

id

Unique identifier of the community

images

Contains the following fields for each image of the community:

  • image—Contains the following fields:

id—Unique identifier of the image

uri—Relative path to the image file

  • sizeType—One of the following values, which indicates the of the image:

small —24 x 24 pixels

medium1 —31 x 31 pixels

medium2 —48 x 48 pixels

medium3 —64 x 64 pixels

medium4 —110 x 110 pixels

large —150 x 150 pixels

legalHoldStatus

Indicates whether the community is on legal hold ( hold = on legal hold, nohold = not on legal hold)

liveDate

Date and time that the community state was set to live, in Java long type date format

memberUserGroups

Contains the following field for each user group that has the Member role for the community:

  • id—Unique identifier of the user group

memberUsers

Contains the following field for each user who has the Member role for the community:

  • id—Unique identifier of the use

name

Name of the community

ownerUserGroups

Contains the following field for each user group that has the Owner role for the community:

  • id—Unique identifier of the user group

ownerUsers

Contains the following field for each user who has the Owner role for the community:

  • id—Unique identifier of the user

questionAnswer

Contains the following fields for each question and answer that were provided when the community was created:

  • questionId—Unique identifier of the question
  • question—Text of the question
  • answer—Text of the answer to the question

shortName

Short URL that can be used to access the community from within Cisco WebEx Social

state

One of the following values, which indicates the state of a request to create the community:

  • approved —The request has been approved by an administrator and the community can be made live
  • denied —The request has been denied by an administrator and the community cannot be made live
  • live —Community is live
  • pending —An administrator has not yet approved nor denied the request

stateChangedDate

Date and time that the state of the community was last updated, in Java long type date format

tags

Contains the following fields for each tag that is associated with the community:

  • name—Name of the tag

type

Type of the community ( hidden , open , or restricted )

userCount

Number of users that belong to the community

userGroupCount

Number of user groups that belong to the community

Example 1 shows sample record from a community data export file.

Example 1 Community Data Export File Sample Record

{
 
"administratorUserGroups":[
{
"id":3811266
}
],
"administratorUsers":[
{
"id":810015
}
],
"category":{
"id":10350,
"name":"General"
},
"creator":{
"id":810015,
"screenName":"pkim"
},
"description":"Pat Open Community",
"email":{
"address":"72a21773bd@your_company.com",
"primary":false
},
"id":3810942,
"images":[
{
"image":{
"id":10355,
"uri":"/image/image_gallery?img_id=10355&t=1379198703048"
},
"sizeType":"medium4"
},
{
"image":{
"id":10351,
"uri":"/image/image_gallery?img_id=10351&t=1379198702895"
},
"sizeType":"small"
},
{
"image":{
"id":10356,
"uri":"/image/image_gallery?img_id=10356&t=1379198703108"
},
"sizeType":"large"
},
{
"image":{
"id":10353,
"uri":"/image/image_gallery?img_id=10353&t=1379198702978"
},
"sizeType":"medium2"
},
{
"image":{
"id":10354,
"uri":"/image/image_gallery?img_id=10354&t=1379198703014"
},
"sizeType":"medium3"
},
{
"image":{
"id":10352,
"uri":"/image/image_gallery?img_id=10352&t=1379198702944"
},
"sizeType":"medium1"
}
],
"legalHoldStatus":"nohold",
"liveDate":1380689880948,
"memberUserGroups":[
{
"id":3811266
},
{
"id":17010124
}
],
"memberUsers":[
{
"id":810015
},
{
"id":810083
}
],
"name":"Pat Open Community",
"ownerUserGroups":[
{
"id":17010124
}
],
"ownerUsers":[
{
"id":810015
}
],
"shortName":"/pat-open-community",
"state":"live",
"stateChangedDate":1380689880948,
"tags":[
{
"name":"blog1-tag1"
},
{
"name":"blog1-tag2"
},
{
"name":"blog2-tag1"
},
{
"name":"blog2-tag2"
},
{
"name":"blog2-tag3"
},
{
"name":"generaldiscussion"
},
{
"name":"Pat"
},
{
"name":"patopencomm"
}
],
"type":"open",
"userCount":6,
"userGroupCount":2
}

Post Export File

Table 5 describes the record fields for an export file that contains post data.

 

Table 5 Post Data Export File Record Fields

Field
Description

allowedCommentsEndTime

Date and time after which comments on the post are not allowed, in Java long type date format

answerCount

Number of answers within the post

answered

Indicates whether a question type post has at least one answer ( true = post has at least one answer, false = post does not have at least one answer)

attachments

Contains the following fields for each attachment to the post:

  • fileName—File name of the attachment
  • id—Unique identifier of the attachment
  • mimeType—One of the following values, which indicates the type of attachment:

DOCUMENT —Document file

IMAGE —Image file

IMAGE_LINK —Link to an image

POST —Cisco WebEx Social post

UNKNOWN_TYPE —Unidentified type

VIDEO —Video file

VIDEO_LINK —Link to a video file

  • uri—URI of the attachment

attachmentsCount

Number of files that are attached to the post

body

Body of the post

clientAppName

Name of the application that created the post

commentCount

Number of comments that have been made on the post

createDate

Date and time that the post was created, in Java long type date format

creator

Contains the following fields:

  • id—Unique identifier of the user who created the post
  • screenName—Unique Cisco WebEx Social screen name of the user who created the post

defaultPermissions

Contains the following fields:

  • authorize—Indicates whether authorize permission is granted for the post ( true = has authorize permission, false = does not have authorize permission)
  • comment—Indicates whether comment permission is granted for the post ( true = has comment permission, false = does not have comment permission)
  • edit—Indicates whether edit permission is granted for the post ( true = has edit permission, false = does not have edit permission)
  • share—Indicates whether share permission is granted for the post ( true = has share permission, false = does not have share permission)
  • view—Indicates whether view permission is granted for the post ( true = has view permission, false = does not have view permission)

documentContainer

Indicates whether the post is a document container type post ( true = post is a document container post, false = post is not a document container post)

editCount

Number of edits that have been made to the post

embeddedMedia

Contains the following fields for each media file that has been embedded in the post content:

  • author—Name of the user who uploaded the media file
  • fileName—Name of the media file
  • id—Unique identifier of the media file
  • mimeType—One of the following values, which indicates the type of media file:

DOCUMENT —Document file

IMAGE —Image file

IMAGE_LINK —Link to an image

POST —Cisco WebEx Social post

UNKNOWN_TYPE —Unidentified type

VIDEO —Video file

VIDEO_LINK —Link to a vide file

  • published—Date and time that the media file was uploaded to the system, in Java long type date format
  • size—Size of the media file in bytes
  • updated—Date and time that the media file was updated in the system, in Java long type date format
  • updatedBy—Unique identifier of the user who added the media file
  • uri—URI of the media file

embeddedVideos

Contains the following fields for each video from an external provider that is embedded in a TEXT type post or attached to a micropost, wall post, or community wall post:

  • html—HTML code of the video
  • tag—Tag of the video in the format *[ url [[ , width , height ]]|[ , width , ]|[ , , height ] ] , where:

url is the URL of the video.

width —Width of the video, in pixels. If you do not specify a width, system sizes the width of the video as defined by the ?tag query parameter in an operation, if provided, or by the width that the com.cisco.ecp.vdl.
post.embeddedvideo.defaultWidth portal property defines.

height —Height of the video, in pixels. If you do not specify a height, the system sizes the height of the video as defined by the ?tag query parameter in an operation, if provided, or by the height that the com.cisco.ecp.vdl.post
.embeddedvideo.defaultHeight portal property defines.

externalFileLink

For a document container post, link to the document on an external server

externalID

For a document container post, identifier of the document

externalPost

Indicates whether the post has been posted outside of Cisco WebEx Social ( true = posted outside of Cisco WebEx Social, false = not posted outside of Cisco WebEx Social)

extraMetaData

For an EXTERNAL type post, metadata from the external source

fileName

For a document container post, name of the document in the document container

folderName

For a document container post, name of the folder that contains the document

hasAttachments

Indicates whether the post includes attachments ( true = includes attachments, false = does not include attachments)

id

Unique identifier of the post

lastModifiedDate

Date and time that the post was last modified, in Java long type date format

lastModifier

Contains the following fields:

  • id—Unique identifier of the user who last modified the post
  • screenName—Unique Cisco WebEx Social screen name of the user who last modified the post

lastTransactionTime

Date and time that the last transaction that affected the post occurred, in Java long type date format

lastTransactionType

One of the following values, which indicates the type of transaction that was last performed on the post:

  • COMMENT —A user added a comment to the post
  • COMMENT_DELETE —A user deleted a comment from the post
  • COMMENT_UPDATE —A user updated a comment on the post
  • CREATE —A user created the post
  • FAVORITE —A user added the post to favorites
  • PERMISSION_REVOKE —A user was denied permission to access the post
  • SHARE —A user shared the post
  • UPDATE —A user updated the post

lastTransactionUser

Contains the following fields:

  • id—Unique identifier of the user who performed the last transaction on the post
  • screenName—Unique Cisco WebEx Social screen name of the user who performed the last transaction on the post

lastUpdatedTime

Date and time that the post was last updated, in Java long type date format

latlong

Latitude and longitude coordinates, respectively and separated by a comma, of the location of the user who created the post at the time that the post was created

legalHold

Indicates whether the post is on legal hold ( hold = on legal hold, nohold = not on legal hold)

likers

Contains the following field for each user who liked the post:

  • id—Unique identifier of the user

likesCount

Number of users who like this post

links

Contains the following fields for each link that is associated with the post:

  • categoryName—User-defined name to categorize the link or file
  • links—Contains the following fields:

linkTitle—Title of the link

linkUrl—URL of the link

refId—Identifier of the link

locationDisplayName

Name of the location of the user who created the post at the time that the post was created

netVoteIncrementForPostActivity

Incremental number of net votes (the number of up votes minus the number of down votes) on the post beyond the value that the netVoteThresholdForPostActivity field defines (see next row) at which the system generates additional activities regarding the votes on the post

netVoteThresholdForPostActivity

Number of net votes (the number of up votes minus the number of down votes) on the post at which the system generates the first activity regarding the votes on the post

permissions

Contains the following fields for each permission type that has been granted to the post:

  • permissionFlags—Contains the following fields:

authorize—A value of true indicates that authorize permission is granted for the post

comment— value of true indicates that comment permission is granted for the post

edit— value of true indicates that edit permission is granted for the post

share— value of true indicates that share permission is granted for the post

view— value of true indicates that view permission is granted for the post

  • principal—Contains the following field

id—Unique ID of a user or community with which the post is shared

resource—Namespace that identifies a user or community with which the post is shared

poll

Contains the following fields:

  • anonymous—Indicates whether users who respond to the poll are anonymous ( true = poll responders are anonymous, false = poll responders are not anonymous)
  • endDate—Date and time at which the poll ends, in Java long type date format
  • lastModifiedDate—Date and time at which the poll was last modified, in Java long type date format
  • pollQuestion—Contains the following fields for each poll question:

isOptional—Indicates whether the question is optional or must be answered ( true = question is optional, false = question must be answered)

lastModifiedDate—Date and time at which the question was last modified, in Java long type date format

pollAnswer—Contains the following fields for each answer to the question:

- answerId—Unique identifier of the answer

- answerText—Text of the answer

- author—Contains the following fields:

* id—Unique identifier of the user who answered

* screenName—Unique Cisco WebEx Social screen name of the user who answered

- customId—User defined identifier of the answer.

- isFreeForm—Indicates whether the answer is free form text ( true = answer is free form text, false = answer is not free form text)

- modifiedDate—Date and time at which the answer was last modified, in Java long type date format

questionAuthor—Contains these fields:

- id—Unique identifier of the user who is the author of the question

- screenName—Unique Cisco WebEx Social screen name of the user who is the author of the question

questionId—Unique identifier of the question

questionText—Text of the question

questionType—Type of the question ( SINGLE_SELECT or MULTI_SELECT )

poll ( continued )

  • pollStats— Contain the following fields which relate to statistical information about poll responses.

id—Unique identifier of the poll

questionStats—Contains the following fields for each poll question:

- answerStats—Contains the following fields for each answer to the question:

* id—Unique identifier of the answer

* responseCount—Number of users who chose this answer.

responseCount—Number of users who responded to the poll

  • showInProgressResults—Indicates whether users other than users with edit permissions on the poll can view a summary of the in-progress poll results ( true = users can view results summary, false = users cannot view results summary)
  • showResultsAtEnd—Indicates whether the final poll results should be shown to users other than users with edit permissions who have access to the ( true = show poll results, false = do not show poll results)
  • startDate—Date and time at which the poll started, in Java long type date format

poll ( continued )

  • userPollResponse—Contains the following fields for each response to the poll:

createDate—Date and time that the response occurred, in Java long type date format

modifiedDate—Date and time that the response was modified, in Java long type date format

pollId—Unique identifier of the poll

pollResponses—Contains these fields for each question that a user answered :

- questionId—Unique identifier of the question

- questionResponses—Contains these fields:

* answerId—Unique identifier of the answer

* freeFormText—Text of the response

- responseTime—Date and time that the response occurred, in Java long type date format

responder—Contains these fields:

- id—Unique identifier of the user who responded to the poll

- screenName—Unique Cisco WebEx Social screen name of the user who responded to the poll

publicPost

Indicates whether this post is a public post ( true = public post, false = not a public post)

question

Indicates whether the post is a question type post ( true = question type post, false = not a question type post).

remoteMessageId

For an EXTERNAL type post, identifier of the external source

remoteSource

Contains these fields for an EXTERNAL type post:

  • id—Identifier of the external source
  • description—Descriptive name of the external source

rootMessageId

Unique identifier of the root of a comment tree

state

One of the following values, which indicates the state of the post:

  • ACTIVE —Post is accessible to users
  • DELETED —Post is deleted
  • FLAGGED —Post is flagged for review by an administrator
  • HIDDEN —Post is hidden
  • INACTIVE —Post is inactive

summary

Summary of the post, based on the initial characters of the post body after stripping out HTML tags

tags

Contains the following fields for each tag that is associated with the post:

  • name—Name of the tag

title

Title of the post

type

One of the following values, which indicates the type of the post:

  • COMMUNITY_WALL —Post that appears on the wall of a community
  • DOCUMENT_CONTAINER —Document container post
  • EXTERNAL — External post
  • IDEA —Ideation post
  • MICRO —Micropost
  • POLL —Poll post
  • TEXT —Standard Cisco WebEx Social post
  • VIDEO —Video post
  • WALL —Post that appears on the wall of a user

uri

URI of the post

version

Version of the post

voteOnCommentsEndTime

Date and time after which votes on comments on the post cannot be added, modified, or deleted, in Java long type date format

voteOnPostEndTime

Date and time after which votes on the post cannot be added, modified, or deleted, in Java long type date format

voteProperties

Contains the following fields:

  • netVoteCount—Total number of votes that the post received
  • voteDownCount—Number of down votes that the post received
  • voteUpCount—Number of up votes that the post received

Example 2 shows sample record from a post data export file.

Example 2 Post Data Export File Sample Record

post export,
{
 
"allowedCommentsEndTime":0,
"answerCount":0,
"answered":false,
"attachments":[
{
"fileName":"sampleword.doc",
"id":16510002,
"mimeType": "DOCUMENT"
"uri":"/c/post_action/get_attachment?postId=10700004&attachmentId=16510002"
},
{
"fileName":"panda.JPG",
"id":16510003,
"mimeType": "DOCUMENT"
"uri":"/c/post_action/get_attachment?postId=10700004&attachmentId=16510003"
}
],
"attachmentsCount":2,
"body":"<div>\n\ttest post.</div>\n<div>\n\t </div>\n<div>\n\tembed video.</div>\n<div>\n\t </div>\n<div>\n\t<img class=\"shownsharevideo\" dojotype=\"com.cisco.ecp.mediagallery.thumbnail\" entryid=\"23910022\" size=\"medium\" src=\"https://ws-sns.cisco.com:443/vportal/fileUploads/C-3d01ea00-01ac-430d-aaa4-8071fbd133e5_1/0c2107e1-15-00-242x136.jpg\" style=\"padding: 5.0px;\"> </div>\n<div>\n\t </div>\n<div>\n\tinline youtube.</div>\n<div>\n\t </div>\n<div>\n\t<object height=\"315\" width=\"420\"><param name=\"movie\" value=\"//www.youtube.com/v/sDsiUGQqaps?version=3&hl=en_US\"><param name=\"allowFullScreen\" value=\"true\"><param name=\"allowscriptaccess\" value=\"always\"><embed allowfullscreen=\"true\" allowscriptaccess=\"always\" height=\"315\" src=\"//www.youtube.com/v/sDsiUGQqaps?version=3&hl=en_US\" type=\"application/x-shockwave-flash\" width=\"420\"></embed></object></div>\n<div>\n\t </div>\n<div>\n\t </div>\n<div>\n\tembedded images.</div>\n<div>\n\t </div>\n<div>\n\t(uploaded from safari)</div>\n<div>\n\t<img border=\"0\" src=\"/image/image_gallery?img_id=13310119\"> </div>\n<div>\n\t </div>\n<div>\n\t(uploaded from FF)</div>\n<div>\n\t<img border=\"0\" src=\"/image/image_gallery?img_id=13310086\"></div>\n<div>\n\t </div>\n<div>\n\t(uploaded from FF)</div>\n<div>\n\t<img border=\"0\" height=\"254\" src=\"/image/image_gallery?img_id=13310067\" width=\"340\"></div>\n<div>\n\t </div>\n<div>\n\t </div>\n<div>\n\t(uploaded from chrome)</div>\n<div>\n\t<img border=\"0\" src=\"/image/image_gallery?img_id=13310028\"> </div>\n<div>\n\t </div>\n<div>\n\t(uploaded from chrome)</div>\n<div>\n\t </div>\n<div>\n\t<img border=\"0\" src=\"/image/image_gallery?img_id=13310036\"> </div>",
"clientAppName":"",
"commentCount":3,
"createDate":1386107773914,
"creator":{
"id":10254,
"screenName":"pkim"
},
"defaultPermissions":{
"authorize":false,
"comment":true,
"edit":true,
"share":true,
"view":true
},
"documentContainer":false,
"editCount":12,
"embeddedMedia":[
{
"fileName":"upload_00000019.flv",
"id":23910025,
"mimeType":"VIDEO_LINK",
"published":1390608513213,
"size":15872147,
"updated":1390608513213
},
{
"fileName":"C:\\fakepath\\owl-7.jpeg",
"id":13310124,
"mimeType":"IMAGE_LINK",
"published":1386200393421,
"size":30853,
"updated":1386200393421,
"uri":"/image/image_gallery?img_id=13310119"
},
{
"fileName":"panda.jpeg",
"id":13310091,
"mimeType":"IMAGE_LINK",
"published":1386200064929,
"size":47903,
"updated":1386200064929,
"uri":"/image/image_gallery?img_id=13310086"
},
{
"fileName":"Penguins.jpg",
"id":13310072,
"mimeType":"IMAGE_LINK",
"published":1386199466675,
"size":777835,
"updated":1386199466675,
"uri":"/image/image_gallery?img_id=13310067"
},
{
"fileName":"C:\\fakepath\\Box.jpg",
"id":13310042,
"mimeType":"IMAGE_LINK",
"published":1386195919173,
"size":73591,
"updated":1386195919173,
"uri":"/image/image_gallery?img_id=13310036"
},
{
"fileName":"C:\\fakepath\\Art-6-150x150.jpg",
"id":13310041,
"mimeType":"IMAGE_LINK",
"published":1386195919162,
"size":8076,
"updated":1386195919162,
"uri":"/image/image_gallery?img_id=13310028"
}
],
"embeddedVideos":[
],
"externalPost":false,
"extraMetaData":"",
"hasAttachments":true,
"id":10700004,
"lastModifiedDate":1390608513230,
"lastModifier":{
"id":10254,
"screenName":"pkim"
},
"lastTransactionTime":1390608513230,
"lastTransactionType":"UPDATE",
"lastTransactionUser":{
"id":10254,
"screenName":"pkim"
},
"lastUpdatedTime":1390608513230,
"latlong":"",
"legalHold":"NOHOLD",
"likers":[
{
"id":16210008
},
{
"id":810015
},
{
"id":10254
}
],
"likesCount":3,
"links":[
{
"categoryName":"category-internal-link",
"links":[
{
"linkTitle":"question post-1",
"linkUrl":"/web/view-post/post/-/posts?postId=13000027",
"refId":13000027
}
]
},
{
"categoryName":"category-attachments",
"links":[
]
},
{
"categoryName":"category-external-link",
"links":[
{
"linkTitle":"cisco.com",
"linkUrl":"http://www.cisco.com";,
"refId":0
}
]
},
{
"categoryName":"category-misc-links",
"links":[
{
"linkTitle":"Chrome3DGlasses",
"linkUrl":"/c/document_library/get_file?folderId=10403&name=DLFE-100001.pdf",
"refId":16510004
},
{
"linkTitle":"angry_birds_3ds",
"linkUrl":"/image/image_gallery?img_id=16510013",
"refId":16510013
}
]
}
],
"locationDisplayName":"",
"netVoteIncrementForPostActivity":0,
"netVoteThresholdForPostActivity":0,
"permissions":[
{
"permissionFlags":{
"authorize":true,
"comment":true,
"edit":true,
"share":true,
"view":true
},
"principal":{
"id":10254,
"resource":"http://quad.cisco.com/schema/1.0/user";
}
},
{
"permissionFlags":{
"authorize":false,
"comment":true,
"edit":true,
"share":true,
"view":true
},
"principal":{
"id":16210008,
"resource":"http://quad.cisco.com/schema/1.0/user";
}
},
{
"permissionFlags":{
"authorize":false,
"comment":true,
"edit":true,
"share":true,
"view":true
},
"principal":{
"id":3810942,
"resource":"http://quad.cisco.com/schema/1.0/community";
}
},
{
"permissionFlags":{
"authorize":false,
"comment":true,
"edit":true,
"share":true,
"view":true
},
"principal":{
"id":810015,
"resource":"http://quad.cisco.com/schema/1.0/user";
}
}
],
"publicPost":true,
"question":false,
"rootMessageId":12810033,
"state":"ACTIVE",
"summary":" \n\ttest post. \n \n\t \n \n\tembed video. \n \n\t \n \n\t \n \n\t \n \n\tinline youtube. \n \n\t \n \n\t \n \n\t \n \n\t \n \n\tembedded images. \n \n\t \n \n\t(uploaded from safari) \n \n\t \n \n\t \n \n\t(uploaded from ...",
"tags":[
{
"name":"test-tag1"
},
{
"name":"test-tag2"
},
{
"name":"test-tag3"
}
],
"title":"pat open comm post",
"type":"TEXT",
"uri":"/posts/10700004",
"version":13,
"voteOnCommentsEndTime":0,
"voteOnPostEndTime":0,
"voteProperties":{
"netVoteCount":0,
"voteDownCount":0,
"voteUpCount":0
}
}

Post Comment Export File

Table 6 describes the record fields for an export file that contains post comment data.

 

Table 6 Post Comment Data Export File Record Fields

Field
Description

answer

Indicates whether the comment has been marked as answer ( true = marked as answered, false = not marked as answered).

body

Body of a comment.

contentState

One of the following values, which indicates the state of the post comment:

  • ACTIVE —Post comment is accessible to users
  • FLAGGED —Post comment is flagged for review by an administrator
  • HIDDEN —Post comment is hidden
  • INACTIVE —Post comment is inactive
  • VERSIONED —Post comment is a previous version
  • MARK_FOR_DELETE —Post comment is marked for deletion

createDate

Date and time that the comment was created, in Java long type date format.

creator

User identifier of the user the user who created the comment.

id

Unique identifier of the comment.

likesCount

Number of likes on the comment.

modifiedDate

Date and time that the comment was last edited, in Java long type date format.

parentMessageId

Identifier of the comment to which this comment is the reply.

For a first-level comment on a post, this identifier is the identifier of the root of the comment tree.

parentPostId

Unique identifier of the post with which the post comments is associated

replyCount

Number of replies that have been made to the comment.

replyCount

Number of replies to the comment.

voteProperties

Contains the following fields:

  • voteUpCount—Number of up votes that the comment received
  • voteDownCount—Number of down votes that the comment received
  • netVoteCount—Total number of votes that the comment received

Example 3 shows sample record from a post comment data export file.

Example 3 Post Comment Data Export File Sample Record

{
"id": 111,
"parentPostId": 111,
"body": "post comment1",
"createDate": 1381879940192,
"modifiedDate": 1381879940192,
"parentMessageId": 111,
"replyCount": 111,
"likesCount": 111,
"contentState": "ACTIVE",
"voteProperties": { "voteUpCount":111, "voteDownCount":111, "netVoteCount": 111 },
"answer": true,
"creator": { "id": 111 }
}

User Export File

Table 7 describes the record fields for an export file that contains user data.

 

Table 7 User Data Export File Record Fields

Field
Description

alternateContact

Contains the following field:

  • id—Unique identifier of another user who is an alternate contact for the user

customAttributes

Custom attributes of the user

emails

Contains the following fields for each email address of the user:

  • address—Email address
  • primary—Indicates whether the email address is the primary email address of the user ( true = primary address, false = not primary address)

endWorkHour

Hour that the user stops work

firstName

First name of the user

followers

Contains the following field:

  • id—Unique identifier of another user who is following the user

following

Contains the following field:

  • id—Unique identifier of another user whom the user is following

friendlyJobTitle

Informal job title of the user

fullName

First and last name of the user

images

Contains the following fields for each profile image of the user:

  • image—Contains the following fields:

id—Unique identifier the image

size—Size in bytes of the image file

published—Date and time that the image file was updated, in Java long type date format

updated—Date and time that the image file was updated, in Java long type date format

fileName—Name of the image file

mimeType—Type of the image file, such as JPG or PNG .

uri—Relative path to the image file

height—Height in pixels of the image file

width—Width in pixels of the image file

  • sizeType—One of the following values, which indicates the size of the profile image:

small —24 x 24 pixels

medium1 —31 x 31 pixels

medium2 —48 x 48 pixels

medium3 —64 x 64 pixels

medium4 —110 x 110 pixels

large —150 x 150 pixels

jobTitle

Formal job title of the user

lastName

Last name of the user

phones

Contains the following fields for each telephone number of the user:

  • id—Unique identifier of the telephone number
  • primary—Indicates whether the telephone number is the primary number for the user ( true = primary number, false = not primary number)
  • number—Area code and telephone number
  • extension—Telephone extension
  • One of the following values, which indicates the type of the telephone number.

business

businessfax

mobile

pager

personal

personalfax

other

tty

preferredName

Name by which the user prefers to be referred

profileSummary

Profile summary of the user, which is text that can be used in the Bio area of the Profile page of the user

screenName

Unique Cisco WebEx Social screen name of the user

startWorkHour

Hour that the user starts work

status

Contains the following fields, which indicate the status of the user in Cisco WebEx Social

  • active —Active user
  • inactive —Deactivated user

tags

Contains the following fields for each tag that is associated with the user:

  • id—Unique identifier of the tag that is associated with the user
  • name—Name of the tag
  • type—Type of the tag

timeZone

Time zone in which the user is located

Example 4 shows sample record from a user data export file.

Example 4 User Data Export File Sample Record

{
"addresses": [],
"customAttributes": [],
"department": "",
"emails": [
{
"address": "a@dummy.com",
"id": 0,
"primary": true
}
],
"endWorkHour": 18,
"firstName": "Pat",
"followers": [
{
"id": 10449
}
],
"following": [
{
"id": 10449
}
],
"fullName": "Pat Kim",
"id": 10422,
"images": [
{
"id": 0,
"image": {
"height": 24,
"id": 8010013,
"mimeType": "jpg",
"published": 0,
"size": 944,
"updated": 1383775317098,
"uri": "/image/user_portrait?img_id=8010013&t=1383775317098",
"width": 24
},
"sizeType": "small"
},
{
"id": 0,
"image": {
"height": 150,
"id": 8010011,
"mimeType": "jpg",
"published": 0,
"size": 6841,
"updated": 1383775317160,
"uri": "/image/user_portrait?img_id=8010011&t=1383775317160",
"width": 150
},
"sizeType": "large"
},
{
"id": 0,
"image": {
"height": 48,
"id": 8010015,
"mimeType": "jpg",
"published": 0,
"size": 1806,
"updated": 1383775317120,
"uri": "/image/user_portrait?img_id=8010015&t=1383775317120",
"width": 48
},
"sizeType": "medium2"
},
{
"id": 0,
"image": {
"height": 31,
"id": 8010014,
"mimeType": "jpg",
"published": 0,
"size": 1111,
"updated": 1383775317110,
"uri": "/image/user_portrait?img_id=8010014&t=1383775317110",
"width": 31
},
"sizeType": "medium1"
}
],
"jobTitle": "SE",
"lastName": "Kim",
"phones": [
{
"extension": "",
"id": 10310003,
"number": "1234567890",
"primary": false,
"type": "mobile"
}
],
"preferredName": "",
"profileSummary": "What can I saw about myself.",
"screenName": "pkim",
"startWorkHour": 10,
"status": "ACTIVE",
"tags": [
{
"id": 10310010,
"name": "development",
"type": "interest"
},
{
"id": 10310008,
"name": "java",
"type": "expertise"
}
],
"uri": "/users/10422"
}

User Group Export File

Table 8 describes the record fields for an export file that contains user group data.

 

Table 8 User Group Data Export File Record Fields

Field
Description

creator

Contains the following field:

  • id—Unique identifier of the user who created the user group

description

Description of the user group

id

Unique identifier or the user group

members

Contains the following field for each user who a member of the user group:

  • id—Unique identifier the each user

name

Name of the user group

Example 5 shows sample record from a user group data export file.

Example 5 User Group Data Export File Sample Record

{
"id": 111,
"creator": {"id":111}
"name": "TestUserGroup",
"description": "test user group",
"members": [{ "id": 111 }, { "id": 222 }, ...],
}
 

 

Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: www.cisco.com/go/trademarks . Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1110R)