Author: schuch
Date: Sun Oct 22 12:35:35 2017
New Revision: 1812903
URL: http://svn.apache.org/viewvc?rev=1812903&view=rev
Log:
added docs for the rocket.chat connector
Added:
manifoldcf/branches/CONNECTORS-1468/site/src/documentation/resources/images/en_US/rocketchat-configure-restapi.PNG
(with props)
manifoldcf/branches/CONNECTORS-1468/site/src/documentation/resources/images/en_US/rocketchat-job-notifications.PNG
(with props)
Modified:
manifoldcf/branches/CONNECTORS-1468/site/src/documentation/content/xdocs/en_US/end-user-documentation.xml
manifoldcf/branches/CONNECTORS-1468/site/src/documentation/content/xdocs/en_US/included-connectors.xml
Modified:
manifoldcf/branches/CONNECTORS-1468/site/src/documentation/content/xdocs/en_US/end-user-documentation.xml
URL:
http://svn.apache.org/viewvc/manifoldcf/branches/CONNECTORS-1468/site/src/documentation/content/xdocs/en_US/end-user-documentation.xml?rev=1812903&r1=1812902&r2=1812903&view=diff
==============================================================================
---
manifoldcf/branches/CONNECTORS-1468/site/src/documentation/content/xdocs/en_US/end-user-documentation.xml
(original)
+++
manifoldcf/branches/CONNECTORS-1468/site/src/documentation/content/xdocs/en_US/end-user-documentation.xml
Sun Oct 22 12:35:35 2017
@@ -3116,6 +3116,26 @@ curl -XGET http://localhost:9200/index/_
If no channel is defined, the message is sent to
the default channel of the Slack Incoming WebHook.</p>
<p>The "Message" supports Markdown formatting. Refer to the
<a href="https://api.slack.com/custom-integrations";>Slack Custom
Integrations</a> documentation for more information.</p>
</section>
+
+ <section>
+ <title>Rocket.Chat Notifications</title>
+ <p>The Rocket.Chat notification connection allows you to
send job notifications to a Rocket.Chat channel. The connection type uses the
Rocket.Chat REST API to post messages.</p>
+ <p>A Rocket.Chat notification connection has only one
special tab on the notification connection editing screen: the "Rocket.Chat
REST API" tab. The tab looks like this:</p>
+ <br/><br/>
+ <figure src="images/en_US/rocketchat-configure-restapi.PNG"
alt="Rocket.Chat Notification Connection, Rocket.Chat REST API tab"
width="80%"/>
+ <br/><br/>
+ <p>Enter the server URL and the user credentials here. The
user field takes either the username or the email address. Fill the proxy
fields if your
+ Rocket.Chat instance is only reachable through a http
proxy.</p>
+ <p>When you configure a job to use a notification
connection of the Rocket.Chat notification type, an additional tab "Rocket.Chat
Notifications" is presented.</p>
+ <p>The tab looks like this:</p>
+ <br/><br/>
+ <figure src="images/en_US/rocketchat-job-notifications.PNG"
alt="Rocket.Chat Notification Job, Notification tab" width="80%"/>
+ <br/><br/>
+ <p>This tab allows you to set the notification messages for
the different job statuses. The tab begins with a section for global settings,
followed by multiple sections for each
+ notification type. The default channel defines the
channel, to which the messages are posted. You can customize the appearance of
the posted message with the alias, emoji and avatar fields.</p>
+ <p>The "Channel" field in the second section allows you to
override the default channel for the corresponding notification type. If no
channel is defined, the message is sent to the specified default channel.</p>
+ <p>The "Message" field supports Markdown formatting. Refer
to the <a href="https://docs.rocket.chat";>Rocket.Chat</a> documentation for
detailed information.</p>
+ </section>
</section>
Modified:
manifoldcf/branches/CONNECTORS-1468/site/src/documentation/content/xdocs/en_US/included-connectors.xml
URL:
http://svn.apache.org/viewvc/manifoldcf/branches/CONNECTORS-1468/site/src/documentation/content/xdocs/en_US/included-connectors.xml?rev=1812903&r1=1812902&r2=1812903&view=diff
==============================================================================
---
manifoldcf/branches/CONNECTORS-1468/site/src/documentation/content/xdocs/en_US/included-connectors.xml
(original)
+++
manifoldcf/branches/CONNECTORS-1468/site/src/documentation/content/xdocs/en_US/included-connectors.xml
Sun Oct 22 12:35:35 2017
@@ -54,7 +54,6 @@
<tr><td>Meridio (Autonomy)</td><td> Pure Java </td><td> Win </td><td>
N/A </td><td> Tested with Meridio 4.1, 5.0 </td></tr>
<tr><td>RSS</td><td> Pure Java </td><td> N/A </td><td> N/A
</td><td>Atom, RSS 2.0, others </td></tr>
<tr><td>SharePoint (MSFT)</td><td>Pure Java </td><td>Win</td><td> N/A
</td><td> Tested with SharePoint 2003 (2.0), 2007 (3.0), 2010 (4.0), 2013
(5.0)</td></tr>
- <tr><td>Slack</td><td>Pure Java</td><td> N/A </td><td> N/A
</td><td>Tested with Slack API November 2016</td></tr>
<tr><td>Web</td><td> Pure Java </td><td>N/A</td><td> N/A </td><td>HTML
Version 1.0, 1.1, 2.0, Atom, RSS 2.0, others </td></tr>
<tr><td>Windows Shares</td><td>Pure Java</td><td> Win, Samba, NetApp,
other NAS systems </td><td>N/A</td><td>N/A</td></tr>
<tr><td>Wiki</td><td> Pure Java </td><td>N/A</td><td> N/A
</td><td>Wiki version 1.8 and above </td></tr>
@@ -88,6 +87,13 @@
<tr><td>OpenNLP Extractor</td><td>Pure
Java</td><td>Various</td><td>Various</td><td>Various</td></tr>
<tr><td>Tika Content Extractor</td><td>Pure
Java</td><td>Various</td><td>Various</td><td>Various</td></tr>
</table>
+
+ <table>
+ <caption>Notification Connector interoperability table</caption>
+ <tr><td>Email</td><td>Pure Java</td><td>Various</td><td>Javamail
1.4</td><td>N/A</td></tr>
+ <tr><td>Rocket.Chat</td><td>Pure Java</td><td> N/A </td><td> N/A
</td><td>Tested with Rocket.Chat 0.58.1</td></tr>
+ <tr><td>Slack</td><td>Pure Java</td><td> N/A </td><td> N/A
</td><td>Tested with Slack API November 2016</td></tr>
+ </table>
</section>
</body>
</document>
Added:
manifoldcf/branches/CONNECTORS-1468/site/src/documentation/resources/images/en_US/rocketchat-configure-restapi.PNG
URL:
http://svn.apache.org/viewvc/manifoldcf/branches/CONNECTORS-1468/site/src/documentation/resources/images/en_US/rocketchat-configure-restapi.PNG?rev=1812903&view=auto
==============================================================================
Binary file - no diff available.
Propchange:
manifoldcf/branches/CONNECTORS-1468/site/src/documentation/resources/images/en_US/rocketchat-configure-restapi.PNG
------------------------------------------------------------------------------
svn:mime-type = image/png
Added:
manifoldcf/branches/CONNECTORS-1468/site/src/documentation/resources/images/en_US/rocketchat-job-notifications.PNG
URL:
http://svn.apache.org/viewvc/manifoldcf/branches/CONNECTORS-1468/site/src/documentation/resources/images/en_US/rocketchat-job-notifications.PNG?rev=1812903&view=auto
==============================================================================
Binary file - no diff available.
Propchange:
manifoldcf/branches/CONNECTORS-1468/site/src/documentation/resources/images/en_US/rocketchat-job-notifications.PNG
------------------------------------------------------------------------------
svn:mime-type = image/png
