SPLDOC 0.4

Author: markheger

docs/doc/spldoc/html/dita.list

@@ -1,4 +1,4 @@
-#Mon Apr 30 11:00:57 PDT 2018
+#Mon Apr 15 12:54:10 CEST 2019
 copytosourcelist=
 hreftargetslist=dita/tk$com.ibm.streamsx.slack/spl$com.ibm.streamsx.slack$types.xml,dita/tk$com.ibm.streamsx.slack/op$com.ibm.streamsx.slack$SendSlackMessage.xml,dita/tk$com.ibm.streamsx.slack/ns$com.ibm.streamsx.slack.services.xml,dita/tk$com.ibm.streamsx.slack/ns$com.ibm.streamsx.slack.xml,dita/toolkits/ix$Namespace.xml,dita/toolkits/ix$Operator.xml,dita/tk$com.ibm.streamsx.slack/ix$Type.xml,dita/toolkits/ix$Type.xml,dita/toolkits/toolkits.xml,dita/tk$com.ibm.streamsx.slack/spl$com.ibm.streamsx.slack.services$message.xml,dita/tk$com.ibm.streamsx.slack/tk$com.ibm.streamsx.slack.xml,dita/tk$com.ibm.streamsx.slack/ix$Operator.xml,dita/tk$com.ibm.streamsx.slack/ix$Namespace.xml,dita/references/OperatorModel.xml
 fullditatopicfile=fullditatopic.list
@@ -23,7 +23,7 @@ conreflist=
 resourceonlyfile=resourceonly.list
 imagefile=image.list
 resourceonlylist=
-imagelist=image/tk$com.ibm.streamsx.slack/op$com.ibm.streamsx.slack$SendSlackMessage.svg
+imagelist=image/tk$com.ibm.streamsx.slack/op$com.ibm.streamsx.slack$SendSlackMessage.svg,image/tk$com.ibm.streamsx.slack/op$com.ibm.streamsx.slack.services$SlackMessageService.svg
 htmlfile=html.list
 htmllist=
 canditopicsfile=canditopics.list
@@ -37,7 +37,7 @@ codereffile=coderef.list
 keylist=
 codereflist=
 user.input.file.listfile=usr.input.file.list
-user.input.dir=/home/streamsadmin/slack/streamsx.slack/com.ibm.streamsx.slack/doc/spldoc
+user.input.dir=/home/streamsadmin/git-public/streamsx.slack/doc/spldoc
 uplevels=../
 tempdirToinputmapdir.relative.value=dita/
 conrefpushfile=conrefpush.list

docs/doc/spldoc/html/dita.xml.properties

@@ -26,7 +26,7 @@
    <entry key="resourceonlyfile">resourceonly.list</entry>
    <entry key="imagefile">image.list</entry>
    <entry key="resourceonlylist"></entry>
-   <entry key="imagelist">image/tk$com.ibm.streamsx.slack/op$com.ibm.streamsx.slack$SendSlackMessage.svg</entry>
+   <entry key="imagelist">image/tk$com.ibm.streamsx.slack/op$com.ibm.streamsx.slack$SendSlackMessage.svg,image/tk$com.ibm.streamsx.slack/op$com.ibm.streamsx.slack.services$SlackMessageService.svg</entry>
    <entry key="htmlfile">html.list</entry>
    <entry key="htmllist"></entry>
    <entry key="canditopicsfile">canditopics.list</entry>
@@ -40,7 +40,7 @@
    <entry key="keylist"></entry>
    <entry key="codereflist"></entry>
    <entry key="user.input.file.listfile">usr.input.file.list</entry>
-   <entry key="user.input.dir">/home/streamsadmin/slack/streamsx.slack/com.ibm.streamsx.slack/doc/spldoc</entry>
+   <entry key="user.input.dir">/home/streamsadmin/git-public/streamsx.slack/doc/spldoc</entry>
    <entry key="uplevels">../</entry>
    <entry key="tempdirToinputmapdir.relative.value">dita/</entry>
    <entry key="conrefpushfile">conrefpush.list</entry>

docs/doc/spldoc/html/references/OperatorModel.html

@@ -552,7 +552,11 @@ <h1 class="title topictitle1">SPL Operator Model</h1>
 The <tt class="ph tt">autoAssignment</tt> element defines whether unassigned attributes will be automatically assigned from the attributes of the input ports.
 If set to true, the SPL compiler will rewrite (at compile-time) the operator invocation as if the unassigned output attributes have 
 explicit assignments in the output section. For each output attribute that is missing an assignment, an input attribute that has 
-the same name and type will be assigned to it. If there is no such input attribute or if there are more than one, an error is 
+the same name and type,
+or that has the same name and type <tt class="ph tt">T</tt>,
+where the output attribute type is <tt class="ph tt">optional&lt;T&gt;</tt>,
+will be assigned to it.
+If there is no such input attribute or if there are more than one, an error is 
 reported at compile-time. Note that an expressionMode value of Constant is incompatible with an autoAssignment value of true. 
 This combination will result in a compilation error.
     </dd>

docs/doc/spldoc/html/tk$com.ibm.streamsx.slack/ix$Namespace.html

@@ -7,22 +7,22 @@
 <meta name="copyright" content="(C) Copyright 2005"/>
 <meta name="DC.rights.owner" content="(C) Copyright 2005"/>
 <meta name="DC.Type" content="reference"/>
-<meta name="DC.Title" content="Namespaces: com.ibm.streamsx.slack 0.3.0"/>
+<meta name="DC.Title" content="Namespaces: com.ibm.streamsx.slack 0.4.0"/>
 <meta name="DC.Format" content="XHTML"/>
 <meta name="DC.Identifier" content="spldoc_index"/>
 <link rel="stylesheet" type="text/css" href="../../html/commonltr.css"/>
 <link rel="stylesheet" type="text/css" href="../../html/spldoc.css"/>
-<title>Namespaces: com.ibm.streamsx.slack 0.3.0</title>
+<title>Namespaces: com.ibm.streamsx.slack 0.4.0</title>
 </head>
 <body id="spldoc_index">
 
 
-<h1 class="title topictitle1">Namespaces: com.ibm.streamsx.slack 0.3.0</h1>
+<h1 class="title topictitle1">Namespaces: com.ibm.streamsx.slack 0.4.0</h1>
 
 <div class="body refbody">
 <div class="section">
 <p class="p">
-<a class="xref" href="../toolkits/toolkits.html">Toolkits</a> &gt; <a class="xref" href="tk$com.ibm.streamsx.slack.html">com.ibm.streamsx.slack 0.3.0</a> &gt; Namespaces</p>
+<a class="xref" href="../toolkits/toolkits.html">IBMStreams streamsx.slack Toolkit</a> &gt; <a class="xref" href="tk$com.ibm.streamsx.slack.html">com.ibm.streamsx.slack 0.4.0</a> &gt; Namespaces</p>
 
 </div>
 

docs/doc/spldoc/html/tk$com.ibm.streamsx.slack/ix$Operator.html

@@ -7,22 +7,22 @@
 <meta name="copyright" content="(C) Copyright 2005"/>
 <meta name="DC.rights.owner" content="(C) Copyright 2005"/>
 <meta name="DC.Type" content="reference"/>
-<meta name="DC.Title" content="Operators: com.ibm.streamsx.slack 0.3.0"/>
+<meta name="DC.Title" content="Operators: com.ibm.streamsx.slack 0.4.0"/>
 <meta name="DC.Format" content="XHTML"/>
 <meta name="DC.Identifier" content="spldoc_index"/>
 <link rel="stylesheet" type="text/css" href="../../html/commonltr.css"/>
 <link rel="stylesheet" type="text/css" href="../../html/spldoc.css"/>
-<title>Operators: com.ibm.streamsx.slack 0.3.0</title>
+<title>Operators: com.ibm.streamsx.slack 0.4.0</title>
 </head>
 <body id="spldoc_index">
 
 
-<h1 class="title topictitle1">Operators: com.ibm.streamsx.slack 0.3.0</h1>
+<h1 class="title topictitle1">Operators: com.ibm.streamsx.slack 0.4.0</h1>
 
 <div class="body refbody">
 <div class="section">
 <p class="p">
-<a class="xref" href="../toolkits/toolkits.html">Toolkits</a> &gt; <a class="xref" href="tk$com.ibm.streamsx.slack.html">com.ibm.streamsx.slack 0.3.0</a> &gt; Operators</p>
+<a class="xref" href="../toolkits/toolkits.html">IBMStreams streamsx.slack Toolkit</a> &gt; <a class="xref" href="tk$com.ibm.streamsx.slack.html">com.ibm.streamsx.slack 0.4.0</a> &gt; Operators</p>
 
 </div>
 

docs/doc/spldoc/html/tk$com.ibm.streamsx.slack/ix$Type.html

@@ -7,22 +7,22 @@
 <meta name="copyright" content="(C) Copyright 2005"/>
 <meta name="DC.rights.owner" content="(C) Copyright 2005"/>
 <meta name="DC.Type" content="reference"/>
-<meta name="DC.Title" content="Types: com.ibm.streamsx.slack 0.3.0"/>
+<meta name="DC.Title" content="Types: com.ibm.streamsx.slack 0.4.0"/>
 <meta name="DC.Format" content="XHTML"/>
 <meta name="DC.Identifier" content="spldoc_index"/>
 <link rel="stylesheet" type="text/css" href="../../html/commonltr.css"/>
 <link rel="stylesheet" type="text/css" href="../../html/spldoc.css"/>
-<title>Types: com.ibm.streamsx.slack 0.3.0</title>
+<title>Types: com.ibm.streamsx.slack 0.4.0</title>
 </head>
 <body id="spldoc_index">
 
 
-<h1 class="title topictitle1">Types: com.ibm.streamsx.slack 0.3.0</h1>
+<h1 class="title topictitle1">Types: com.ibm.streamsx.slack 0.4.0</h1>
 
 <div class="body refbody">
 <div class="section">
 <p class="p">
-<a class="xref" href="../toolkits/toolkits.html">Toolkits</a> &gt; <a class="xref" href="tk$com.ibm.streamsx.slack.html">com.ibm.streamsx.slack 0.3.0</a> &gt; Types</p>
+<a class="xref" href="../toolkits/toolkits.html">IBMStreams streamsx.slack Toolkit</a> &gt; <a class="xref" href="tk$com.ibm.streamsx.slack.html">com.ibm.streamsx.slack 0.4.0</a> &gt; Types</p>
 
 </div>
 

docs/doc/spldoc/html/tk$com.ibm.streamsx.slack/ns$com.ibm.streamsx.slack.html

@@ -22,7 +22,7 @@ <h1 class="title topictitle1">Namespace <tt class="ph tt">com.ibm.streamsx.slack
 <div class="body refbody">
 <div class="section">
 <p class="p">
-<a class="xref" href="../toolkits/toolkits.html">Toolkits</a> &gt; <a class="xref" href="tk$com.ibm.streamsx.slack.html">com.ibm.streamsx.slack 0.3.0</a> &gt; com.ibm.streamsx.slack</p>
+<a class="xref" href="../toolkits/toolkits.html">IBMStreams streamsx.slack Toolkit</a> &gt; <a class="xref" href="tk$com.ibm.streamsx.slack.html">com.ibm.streamsx.slack 0.4.0</a> &gt; com.ibm.streamsx.slack</p>
 
 </div>
 

docs/doc/spldoc/html/tk$com.ibm.streamsx.slack/ns$com.ibm.streamsx.slack.services.html

@@ -22,7 +22,7 @@ <h1 class="title topictitle1">Namespace <tt class="ph tt">com.ibm.streamsx.slack
 <div class="body refbody">
 <div class="section">
 <p class="p">
-<a class="xref" href="../toolkits/toolkits.html">Toolkits</a> &gt; <a class="xref" href="tk$com.ibm.streamsx.slack.html">com.ibm.streamsx.slack 0.3.0</a> &gt; com.ibm.streamsx.slack.services</p>
+<a class="xref" href="../toolkits/toolkits.html">IBMStreams streamsx.slack Toolkit</a> &gt; <a class="xref" href="tk$com.ibm.streamsx.slack.html">com.ibm.streamsx.slack 0.4.0</a> &gt; com.ibm.streamsx.slack.services</p>
 
 </div>
 

docs/doc/spldoc/html/tk$com.ibm.streamsx.slack/op$com.ibm.streamsx.slack$SendSlackMessage.html

@@ -22,7 +22,7 @@ <h1 class="title topictitle1">Operator <tt class="ph tt">SendSlackMessage</tt></
 <div class="body refbody">
 <div class="section">
 <p class="p">
-<a class="xref" href="../toolkits/toolkits.html">Toolkits</a> &gt; <a class="xref" href="tk$com.ibm.streamsx.slack.html">com.ibm.streamsx.slack 0.3.0</a> &gt; <a class="xref" href="ns$com.ibm.streamsx.slack.html">com.ibm.streamsx.slack</a> &gt; SendSlackMessage</p>
+<a class="xref" href="../toolkits/toolkits.html">IBMStreams streamsx.slack Toolkit</a> &gt; <a class="xref" href="tk$com.ibm.streamsx.slack.html">com.ibm.streamsx.slack 0.4.0</a> &gt; <a class="xref" href="ns$com.ibm.streamsx.slack.html">com.ibm.streamsx.slack</a> &gt; SendSlackMessage</p>
 
 </div>
 
@@ -72,7 +72,7 @@ <h1 class="title topictitle1">Operator <tt class="ph tt">SendSlackMessage</tt></
 
   <dt class="dt dlterm">Metrics</dt>
 
-  <dd class="dd">This operator does not report any metrics.</dd>
+  <dd class="dd">This operator reports 3 metrics.</dd>
 
 
 </dl>
@@ -215,6 +215,52 @@ <h1 class="title topictitle1">Operator <tt class="ph tt">SendSlackMessage</tt></
 </dd>
 
 
+</dl>
+
+</div>
+
+<div class="section">
+<p class="p splhead-1"><strong class="ph b"><a class="xref" href="../references/OperatorModel.html#spldoc_reference_operator_model__context__metrics">Metrics</a></strong></p>
+<dl class="dl">
+  
+    <dt class="dt dlterm"><tt class="ph tt">nFailedRequests</tt> - <a class="xref" href="../references/OperatorModel.html#spldoc_reference_operator_model__context__metrics_kind_counter">Counter</a></dt>
+
+    <dd class="dd">
+
+<p class="p">The number of failed messages over the lifetime of the operator.
+</p>
+
+     <p class="p"/>
+
+     </dd>
+
+  
+  
+    <dt class="dt dlterm"><tt class="ph tt">nInsertedMessages</tt> - <a class="xref" href="../references/OperatorModel.html#spldoc_reference_operator_model__context__metrics_kind_counter">Counter</a></dt>
+
+    <dd class="dd">
+
+<p class="p">The number of successful messages over the lifetime of the operator.
+</p>
+
+     <p class="p"/>
+
+     </dd>
+
+  
+  
+    <dt class="dt dlterm"><tt class="ph tt">rateLimitExceeded</tt> - <a class="xref" href="../references/OperatorModel.html#spldoc_reference_operator_model__context__metrics_kind_gauge">Gauge</a></dt>
+
+    <dd class="dd">
+
+<p class="p">Describes whether we exceed a rate limit when sending messages to Slack server. This is set to 1 after response 429 is received. Otherwise the value is 0. 
+</p>
+
+     <p class="p"/>
+
+     </dd>
+
+  
 </dl>
 
 </div>

docs/doc/spldoc/html/tk$com.ibm.streamsx.slack/spl$com.ibm.streamsx.slack$types.html

@@ -22,7 +22,7 @@ <h1 class="title topictitle1">SPL File <tt class="ph tt">types.spl</tt></h1>
 <div class="body refbody">
 <div class="section">
 <p class="p">
-<a class="xref" href="../toolkits/toolkits.html">Toolkits</a> &gt; <a class="xref" href="tk$com.ibm.streamsx.slack.html">com.ibm.streamsx.slack 0.3.0</a> &gt; <a class="xref" href="ns$com.ibm.streamsx.slack.html">com.ibm.streamsx.slack</a> &gt; types.spl</p>
+<a class="xref" href="../toolkits/toolkits.html">IBMStreams streamsx.slack Toolkit</a> &gt; <a class="xref" href="tk$com.ibm.streamsx.slack.html">com.ibm.streamsx.slack 0.4.0</a> &gt; <a class="xref" href="ns$com.ibm.streamsx.slack.html">com.ibm.streamsx.slack</a> &gt; types.spl</p>
 
 </div>