These topics discuss how to manage apps:
Apps (sometimes called applications or gadgets) are web-based applications that can be deployed in Oracle Social Network. Apps are applicable only on the web client.
There are two types of apps:
Conversation apps are external standalone applications that you can add to a Conversation. Examples include a poll, map, or a photo viewer. An app definition file, also called an app specification, is an XML file that defines its content, behavior, properties, and the data it will display.
Social Object apps represent business objects coming from a System of Record or defined directly in Oracle Social Network, to make the information viewable in the context of a Conversation. Social Object apps are managed using the Social Definition Builder in the developer website.
From the Apps page, you can add Conversation apps that were defined in an app definition file or Social Object apps that were exported from the Social Definition Builder; and you can enable, configure, disable, or remove existing apps.
Oracle Social Network comes with two apps, which are enabled by default:
The Oracle Social Network Site App allows you to embed a live web page into a Conversation. Note that many external sites, such as http://www.google.com, don't allow embedding; these sites do not appear when a user puts the URLs in the Oracle Social Network Site app.
The Oracle Social Network Photo App automatically displays all the images in the Conversation as a slide show.
The Oracle Social Network Collection App is included to provide Collection functionality. Although it is included in the product, it is not intended for use as a sample app.
Note: If a developer on your team changes an app definition file or 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 app's properties page.
When you add an app, Oracle Social Network uploads the definition file containing the code for the app and installs (deploys) it.
To delete an app, click Delete to the right of the app in the list. If instances of the app exist in the web client, you can't delete the app.
Deleting an app removes it only from the Oracle Social Network application. The actual file used to create the app is not deleted.
The following table describes app properties.
Element | Description |
---|---|
The general properties of an app display at the top of the page. |
|
App Name |
The name of the app, which is displayed in the client user interface. |
App External ID |
Specifies an identifier that allows other apps or code to refer to the app. The ID can be up to 256 characters in length and must contain at least one period (.) character. Make sure the identifier you specify is unique across your system. Do not change the External ID of an app that is provided with Oracle Social Network. |
ID |
Not editable. An identifier assigned by the system. |
Type |
Not editable. An identifier assigned by the system for the app type. |
Created |
Not editable. Shows the date and time when the app was created. For apps that are included as part of Oracle Social Network, the installation date and time are displayed. |
Last Modified |
Not editable. Shows the most recent date and time that configuration changes were made to the app. |
App Definition File |
Click Select File and follow the screen prompts to upload the file containing the app definition. The definition file must be valid XML. |
General Properties |
This section displays properties that apply to both app types. |
App Enabled |
Enables or disables the app. If an app is available but not enabled, it's visible but not functional, and users can't add new instances of the app to Oracle Social Network. For certain system apps, such as the Collection App, this field is not editable. |
App Available |
Makes the app available or unavailable to users. This control determines whether the app is visible to users in the list of available apps. For certain system apps, such as the Collection App, this field is not editable. |
App Local |
Specifies whether the app communicates with the originating Oracle Social Network server locally or over a proxy. The generated URL sent to the app on the client varies depending on the selection. The default is deselected (not local). Do not change this setting except at the direction of Oracle Support. |
One App Instance Per Conversation |
Specifies whether more than one instance of the app can exist in a Conversation. If you select this option, the client user can add only one instance of the app in the Conversation. For example, it doesn't make sense to have two instances of the Photo Viewer app in a Conversation, but you might want to allow more than one instance of a polling app to be added. |
App Type |
Specifies the functional type of the app. The options are:
|
Social Object App |
For Social Object apps (the App Type is Social Object), the following additional properties display. The properties are not editable from the Administration user interface. You can change them using the REST API or (if you have the Developer privilege), using the Social Definition Builder in the Oracle Social Network developer website. |
Createable |
Instances (Social Objects) based on the Social Definition can be created. If the option is not selected, neither the REST API nor users on any client (such as web, mobile, or Outlook) can create an instance of the Social Definition. |
Customizable |
You can customize the Social Definition. If this option is not selected, the Social Object app does not display in the Social Definitions page. |
Updateable |
The Social Object fields can be updated in Oracle Social Network; an Edit button displays for the object, allowing the user to change the Social Object description, for example. If the option is not selected, neither the REST API nor users on any client (such as web, mobile, or Outlook) can update fields of the Social Object. |
Deletable |
Instances of the Social Object can be permanently deleted. If the option is not selected, neither the REST API nor users on any client (such as web, mobile, or Outlook) can delete instances of the Social Object. |
Renameable |
The Social Object can be renamed. If the option is not selected, neither the REST API nor users on any client (such as web, mobile, or Outlook) can rename the Social Object. |
Closeable |
The Social Object can be closed (made inactive). If the option is not selected, neither the REST API nor users on any client (such as web, mobile, or Outlook) can close the Social Object. |
Required Features |
If applicable, a table displays features that the app requires in order to work properly. You can click a feature name to go to its properties page. |
When Oracle Social Network is installed, certain apps and features are included (seeded). If changes occurred after installation that you want to revert, you can re-seed the default apps and features.
Reseeding your apps and features will not affect any apps and features that you added; only the ones included as part of Oracle Social Network are changed.
Note: Both features and apps are re-seeded. You can't re-seed one without the other.