Managing Social Definitions

These topics discuss how to manage social definitions:

Social Definition Properties in the Administration UI

A Social Definition is a "model" of a Social Object; after you add a Social Definition on your system, users can create Social Object instances based on the definition. A Social Definition specifies the properties of its corresponding Social Object and how to display it in different client interfaces.

You can create a Social Definition in different ways, including using the Social Definition Builder tool in the Oracle Social Network developer website, or using the Oracle Social Network REST API. For more information, see the Oracle Social Network Developer's Guide (accessible from the developer website).

If the customizable property of a Social Definition is enabled, you can change some of its properties using the Administration UI. After you save a change, it is visible to end users when they start a new browser session or do a full page refresh. You can set the customizable property from the Social Definition Builder in the developer website, or using the Oracle Social Network REST API. For more information, see the Oracle Social Network Developer's Guide (accessible from the developer website).

The following table shows the (non-editable) properties that display for Social Definitions when you navigate to Social Definitions. Additional properties display when you choose to edit an individual definition.

Element Description

Social Definition Name

The name of the Social Definition as it appears in the Administration user interface. This property is editable from the Social Definitions page when you add the definition, and editable from the Apps page after creation.

External ID

The unique identifier for the Social Definition. This identifier uses namespacing to specify the originating application; for example, a Social Definition named Opportunities might have the External ID companyname.crm.opportunities. This property is editable from the Social Definitions page when you add the definition, and editable from the Apps page after creation.

Enabled

Shows whether the Social Definition is enabled. Enabled Social Definitions display in the client user interface's Social Objects drop-down list (if the app is Discoverable or if it was shared with the user). This property is editable from the Social Definitions page when you add the definition, and editable from the Apps page after creation.

Where to Customize Social Definitions

The following table lists the properties of a Social Definition and shows where the property can be changed after it has been created. Note that only Social Definitions that are defined as Customizable can be edited from the Social Definitions page. For more information about Social Object properties and the Social Definition Builder, refer to the Oracle Social Network Developer's Guide (accessible from the developer website).

The editable properties on your system might differ from those shown in this table. Your specific configuration determines which properties are available in Oracle Social Network.

Note: If a developer on your team changes a Social Object definition file outside the Administration user interface using the Oracle Social Network REST API or another tool, you must re-upload the updated definition file to Oracle Social Network from the Apps properties page.

Property Type Property Apps Page Social Definitions Page Social Definition Builder

Social Definition

Social Definition Name

X

   

Display Name

   

X

External ID

X

 

X

Fields

   

X

Group

   

X

Enabled

X

 

X

Available

X

 

X

Local

X

 

X

Definition File

X

 

X

Social Definition Field

Columns to Display

 

X

X

Label Position

 

X

X

Show in Summary

 

X

X

Show in Detail

 

X

X

Show in Digest

 

X

X

Sortable

 

X

X

Filterable

 

X

X

Read Only

   

X

Required

   

X

Social Object Instance

Customizable

   

X

Createable

   

X

Deleteable

   

X

Discoverable

 

X

X

Updateable

   

X

Closeable

   

X

Renameable

   

X

Adding a Social Definition

When you add a Social Definition, Oracle Social Network uploads the definition file containing the code for the Social Definition and installs (deploys) it.

  1. Log in to Oracle Social Network as an administrator.
  2. From the Administration UI, click Social Definitions. The Social Definitions page opens and lists the existing definitions.
  3. Click New Social Definition.
  4. Enter a name and external ID for the Social Definition. For more information about these fields, see Social Definition Properties Page.
  5. Click Select File and follow the screen prompts to upload the Social Definition. The definition file must be valid XML that conforms to the Social Definition schema.
  6. Click Create.
  7. Edit the properties of the Social Definition as needed, by following the steps in Editing Social Definition Properties.

Editing Social Definition Properties

To customize a Social Definition:

  1. Log in to Oracle Social Network as an administrator.
  2. From the Administration UI, click Social Definitions.
  3. Select the Social Definition that you want to change. Its properties page opens.
  4. Edit the values that are displayed. For more information about a field, see Social Definition Properties Page.
  5. To reorder a field, select it and click Up or Down.
  6. To preview your selections as they would be displayed in the web client, click Preview. A popup window opens and displays the Social Object as it would look with your changes.
  7. Click Save. The change is visible to end users when they start a new browser session or do a full page refresh.

Social Definition Properties Page

If the Social Definition specifies that it is Customizable, some of its properties can be changed using the Social Definitions properties page.

Element Description

General Properties

General properties appear at the top of the page. They are not editable.

Display Name

The name of the Social Definition as it appears in the client user interface.

Display Name Plural

The plural name of the Social Definition as it appears in the More drop-down list in the client user interface.

Social Definition Name

The name of the Social Definition as it appears in the administrator user interface. Editable from the Apps page.

Namespace

Oracle Social Network supports namespacing all the objects under their respective originating applications. The use of namespacing ensures that External IDs remain unique across all Social Object definitions and Social Object instances. In addition to External ID namespacing, you should namespace Social Object field names. Social Definition fields are restricted to the Social Definition namespace and must be unique within the definition.

External ID

The unique identifier for the Social Definition. This identifier uses namespacing to specify the originating application; for example, a Social Definition named Opportunities might have the External ID companyname.crm.opportunities. Editable from the Apps page.

Group Name

The name of the group, such as CRM. Typically the Group Name corresponds to the name of the System of Record providing data for the Social Definition, but this is not required. In the Oracle Social Network browser client, Social Definitions generally are grouped and displayed in the Social Objects drop-down list.

Enabled

Shows whether the Social Definition is enabled. Enabled Social Definitions display in the client user interface (if the Social Definition is also Discoverable). Editable from the Apps page.

Closeable

Shows whether a Social Definition instance (Social Object) can be closed by the end user in the web client interface.

Deletable

Shows whether a Social Definition instance (Social Object) can be deleted by the end user in the web client interface.

Updateable

Shows whether a Social Definition instance (Social Object) can be updated by the end user in the web client interface.

Renameable

Shows whether a Social Definition instance (Social Object) can be renamed by the end user in the web client interface.

Visibility

These options affect whether users can make Social Definition instances (Social Objects) public, and the default setting for new Social Objects.

Allow Public (Discoverable) Social Objects

If enabled, the Social Definition displays in the Social Objects drop-down list in the user interface, and users can make Social Objects public in the same way they would make a Conversation public. Public Social Objects appear in search results and in the Available area on the Social Objects page. If disabled, the user does not see the Social Definition or any of its Social Objects unless it is shared with them.

Default Visibility Setting

Specifies whether newly-created Social Objects are publicly available or members-only by default. After the Social Object is created, users can change this setting.

Layout Options

These options affect the position of the fields in the Social Object.

Columns to Display

Specifies the number of columns to use when displaying the Social Object in the user interface.

Label Position

Specifies whether to display the field name above the field or to the left of the field in the Social Object.

Ordered Fields

These options affect the fields in the client user interface.

Field Order (arrows)

Use these arrows to change the order of the fields as displayed in the user interface.

Field Name

Not editable. The name of the field as it appears in the user interface.

Type

Not editable. The data type of the property.

Read Only

Specifies whether the field is read-only in the Detail view of the Social Object.

Required

Specifies whether the field must have a value.

Show in Summary

Specifies whether the field displays in the Summary (List) view of the Social Object.

Show in Detail

Specifies whether the field displays in the Detail view of the Social Object.

Show in Digest

Specifies whether the field displays in the email digest.

Sortable

Specifies whether the user can sort the list view of the content using this field. If enabled, the field displays as a Sort by selection.

Filterable

Specifies whether the user can filter (search on) the list view of the content based on this field.