Limeade ONE O365 Cloud Comm Collector Administration Guide

Limeade ONE O365 Cloud Comm Collector Administration

Overview

Deploying Limeade ONE Collector in O365

Configuring the Collector App

Company Configuration

Adding List Configurations

Managing Configured List

Cloud Comm Integration

Example Sample Payload

Configuring Limeade ONE Cloud Comm Integration

Adding a New Message Configuration

Field Definitions

Editing a Message Configuration

Deleting a Message Confirmation

Overview

This administration guide is intended on guiding O365 SharePoint administrators to deploy and configure the Limeade ONE O365 Cloud Comm Connector, allowing O365 lists to push content to the Limeade ONE platform as Cloud Comm messages.

Deploying Limeade ONE Collector in O365

The first step in integrating O365 lists to the Limeade ONE Cloud Comm platform is to install the Limeade ONE SharePoint app in the O365 SharePoint site that is desired to be integrated. Search for ONE in the SharePoint app store, and click the app to open install dialogue. When prompted to trust app, click the trust it button.

one-o365-cloud-comm-collector-administration-guide.003.png

one-o365-cloud-comm-collector-administration-guide.004.png

Once the Trust It button is clicked, the app will begin its installation. Installation can be verified by the greyed-out state in the SharePoint Site Contents view

one-o365-cloud-comm-collector-administration-guide.005.png

Once the installation has successfully completed the Site Contents entry will no longer be greyed out

one-o365-cloud-comm-collector-administration-guide.006.png

Configuring the Collector App

To configure the collector app the first step is to click the application from the Site Contents view. This will navigate the user to the Limeade ONE Integration configuration page.

one-o365-cloud-comm-collector-administration-guide.007.png

Company Configuration

This section allows administrators to configure the company configuration. To find the company configuration, navigate to the Getting Started Page in the Limeade ONE tenant administration console.

one-o365-cloud-comm-collector-administration-guide.008.png

Fill out Company ID and Company Password. The server URL is typically set by default. If another environment is used, enter the URL for the environment and click Save Company Configuration.

one-o365-cloud-comm-collector-administration-guide.009.png

Adding List configurations

The next step in allowing content in SharePoint O365 to push card content to Limeade ONE is to configure a list to be watched by the Limeade ONE Integration Collector. The Collector is limited to the site where the Limeade ONE Integration O365 app is installed.

one-o365-cloud-comm-collector-administration-guide.010.png

Use the dropdown to select the list content that should be published to Limeade ONE through the SharePoint List or Library dropdown.

one-o365-cloud-comm-collector-administration-guide.011.png

Once a list is selected, choose a Message Type. The Message Type can be set to any string value. For any card other than the Cloud Comm card, the Message Type is used in the Limeade ONE platform to choose which card app should intercept the card. This should be coordinated with the card message typeset for cards in the roles configured in the Tenant Administration Roles Editor.

For Cloud Comm integration, the Message Type should be coordinated with Cloud Comm Publishing API configuration.

The next option is to choose which events trigger card content to be sent to the Limeade ONE platform.

one-o365-cloud-comm-collector-administration-guide.012.png

Enable On Create to create a card when a list item is added. This mode respects approvals and publishing
Enable On Update to update a card when a new list item is updated
Enable On Delete to delete and remove a card from user streams when the list item is deleted

Lastly, click Save List Configuration to save the list configuration for the chosen list.

Managing Configured List

In the Configured List section, all lists that are being watched by the Limeade ONE Collector and which list events are being watched for each configured list can be viewed. Each list entry allows administrators to delete the configured list and download a sample list payload for integration activities using the Download Sample link. It is necessary to download a sample to integrate with custom card implementations or for use in the Cloud Comm integration.

Cloud Comm Integration

For Cloud Comm integration, the first step is to use the Download Sample feature for the list desired to use for publishing Cloud Comm messages. See Manage Configured Lists above. This will download a sample JSON payload that allows users to examine which fields/columns will be transported to the Limeade ONE platform. Use the fields/columns to map to existing Cloud Comm fields.

Example Sample Payload

{
"Actor": {
"DisplayName": "user A",
"Email": user.a@email.com
},
"SendTo": null,
"SendToGroups": null,
"CardId": "Sample-46c56766-3fe4-4a92-8248-75b30c499539-1",
"MessageType": "Sample",
"ActionType": 1,
"Data": {
"ContentType": "Picture",
"__ListId": "46c56766-3fe4-4a92-8248-75b30c499539",
"__ListItemId": "1",
"__ListTitle": "TestImageLibrary",
"__WebUrl": "https://your.sharepoint.com/sites/TestPublishing",
"__Web__Title": "Test Publishing Portal",
"Author": "user A",
"Author_Email": "user.a@email.com",
"Editor": "user A",
"Editor_Email": "user.a@email.com",
"FileLeafRef": "Antoine6.jpg",
"Title": "Antoine and Crew O365",
"ImageWidth": "2048",
"ImageHeight": "1367",
"Description": "A group picture from O365",
"Description__PlainText": "A group picture from O365",
"MediaServiceAutoTags": "outdoor",
"ID": "1",
"Created": "9/7/2017 6:30:27 PM",
"Modified": "9/7/2017 6:34:25 PM",
"_CheckinComment": "",
"ItemChildCount": "0",
"FolderChildCount": "0",
"_ComplianceFlags": "",
"_ComplianceTag": "",
"_ComplianceTagWrittenTime": "",
"_ComplianceTagUserId": "",
"_UIVersionString": "1.0",
"ParentVersionString": null,
"ParentLeafName": null
},
"CardDate": "2017-09-11T15:05:44.2480984Z"
}

Configuring Limeade ONE Cloud Comm Integration

For this step, it is necessary to navigate to the Cloud Comm settings console in the Limeade ONE Tenant and select the Publishing API tab.

one-o365-cloud-comm-collector-administration-guide.013.png

Adding a New Message Configuration

To add a new message configuration, click the Add button in the Publishing API console.

one-o365-cloud-comm-collector-administration-guide.014.png

Fill in all fields from the configuration editor. The Message Type field should map to the list configuration created in this SharePoint instance. The remaining fields need to match the field/column names found in the downloaded sample payload. Once complete, click Save.

one-o365-cloud-comm-collector-administration-guide.015.png

Field Definitions

Field	Description
Message Type	This tells the Cloud Comm engine which messages coming from a third party to intercept and manage. This is the same message type entered earlier when configuring a list to send card data to the Limeade ONE environment. If the message type is not configured here it will be processed through the regular card processing engine and not end up creating a Cloud Comm card.
Header field	The JSON variable specified in this field will be displayed in the title/header of the Cloud Comm Card
Summary field	The JSON variable specified in this field will be displayed in the Summary of the Cloud Comm Card Note: If nothing is specified here, the content of the Message field will be used. It’s important to note that message truncation rules are applied to the summary text.
Message field	Used as the detailed message for the card.
Link field	Adds a clickable URL to the message detail. Note: If no summary text was specified then the link will be shown as summary text.
Group field	Used to target the message to a group. Will try to map the value by looking at groups ExternalID and group name.
Group value template	This allows users to format the values they might have in the group field to match a format they might be using as external ID’s or name for groups. Example: The group values coming from the O365 are from a Country field and are formatted as: CDN, USA, etc. In Limeade ONE groups are imported and have the following format for external ID’s CONTRY_CDN, CONTRY_USA. You would specify the template as: CONTRY_{value} Where {value} gets replaced with the value gotten from the Group field
Channel field	Used to target the message to a channel. Will try to map the value by looking at channels name.
Channel value template	Works the same as the group’s template but for channels.
Push notification field	The value of this field should be Boolean and will determine if a push notification is sent when creating the message. By default, notification is not sent.
Important field	The value of this field should be Boolean and will determine if the important flag will be set on the message.
Disable social field	The value of this field should be Boolean and will determine social interaction is disabled on the message. By default, social interaction is allowed on the created cards.
Publish as card actor	There are 2 options. Let the card publisher be the author that is coming through in the card payload or choose to force the publisher to be an account specify when this option is not selected. By default, the card will be published as the creator in the card payload (the user who created the list item). **If the user creating the content in SharePoint has an email address that does not exist in the Limeade ONE platform then the message will not be published. In these cases, ensure that publish as actor is not enabled.

Editing a Message Configuration

To edit a message configuration just click the configuration to be edited and edit the properties in the configuration editor. Only when the Save button is clicked will the edit take effect.

Deleting a Message Confirmation

To delete a message configuration, click the Delete button to remove the configuration. A confirmation toggle will be displayed to ensure that a user is wanting to delete the message configuration.

one-o365-cloud-comm-collector-administration-guide.016.png

Articles in this section