Skip to content

Commit

Permalink
Deploy Resilient/resilient-community-apps to github.ibm.com/Resilient…
Browse files Browse the repository at this point in the history
…/resilient-community-apps.git:gh-pages
  • Loading branch information
traviscibot committed Nov 12, 2024
1 parent 3dbdff5 commit 8ba4fff
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 53 deletions.
Binary file modified .doctrees/environment.pickle
Binary file not shown.
Binary file modified .doctrees/rc_data_feed_plugin_elasticfeed/README.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion _downloads/2a0fda0a4ac6ae7a4ed4764b8e60d0e8/LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright © IBM Corporation 2010, 2024
Copyright © IBM Corporation 2010, 2019

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to
Expand Down
17 changes: 3 additions & 14 deletions _sources/rc_data_feed_plugin_elasticfeed/README.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ Refer to the documentation on the Data Feed extension for uses cases support and
## History
| Version | Date | Notes |
| ------- | ---- | ----- |
| 1.2.0 | 09/2024 | Support for time series data |
| 1.1.1 | 01/2024 | Updated base image rc_data_feed to 3.0.0 |
| 1.1.0 | 07/2022 | New base images and functionality for attachments |
| 1.0.1 | 08/2020 | App Host support |
Expand All @@ -26,21 +25,11 @@ This release modified the base portion of the Data Feeder which is controlled by
| workspaces | "Default Workspace": ["sqlserver_feed"], "workspace A": ["kafka_feed", "resilient_feed"] | This setting allows for the partitioning of Data Feeder execution among different workspaces. The format is to specify the workspace name with the data feeder components to associated with it: "workspace": ["app.config section_name"]. If unused, data from all workspaces is accessed. |
| include_attachment_data | true/false | set to true if attachment data should be part of the sent payload. When 'true', the attachment's byte data is saved in base64 format. |

### 1.2.0 Changes
Version 1.2.0 introduces incident timeseries data fields. These are custom select or boolean fields, as well as incident `Owner`, `Phase` and `Severity` fields, which record the duration in seconds each field contains a particular value.
For instance, how many seconds `Severity` has a value of `Low` and `Medium`, etc.

To use this capability, add the following app.config settings to the `[feeds]` configuration section.

| Key | Values | Description |
| :-- | :----- | :---------- |
| timeseries | always \| onclose \| never | When to collect time-series data. Because of the extra API call needed to collect this data, it could be more impactful on SOAR when set to 'always'. default is 'never' |
| timeseries_fields | owner_id, phase_id, severity_code, <custom_field> | A comma separated list of time-series fields to collect. Custom select and boolean fields are also possible. Specify wildcard fields with '?' or '*'. ex. ts_* will collect all time-series fields starting with "ts_". default is all timeseries fields |

## Compatibility
SOAR Compatibilty: 51.0.0 or higher

CP4S Compatibility: 1.10 or higher
SOAR Compatibilty: 30.0 or higher

CP4S Compatibility: 1.4 or higher


## License
Expand Down
43 changes: 6 additions & 37 deletions rc_data_feed_plugin_elasticfeed/README.html
Original file line number Diff line number Diff line change
Expand Up @@ -430,23 +430,19 @@ <h2>History<a class="headerlink" href="#history" title="Link to this heading">¶
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>1.2.0</p></td>
<td><p>09/2024</p></td>
<td><p>Support for time series data</p></td>
</tr>
<tr class="row-odd"><td><p>1.1.1</p></td>
<tr class="row-even"><td><p>1.1.1</p></td>
<td><p>01/2024</p></td>
<td><p>Updated base image rc_data_feed to 3.0.0</p></td>
</tr>
<tr class="row-even"><td><p>1.1.0</p></td>
<tr class="row-odd"><td><p>1.1.0</p></td>
<td><p>07/2022</p></td>
<td><p>New base images and functionality for attachments</p></td>
</tr>
<tr class="row-odd"><td><p>1.0.1</p></td>
<tr class="row-even"><td><p>1.0.1</p></td>
<td><p>08/2020</p></td>
<td><p>App Host support</p></td>
</tr>
<tr class="row-even"><td><p>1.0.0</p></td>
<tr class="row-odd"><td><p>1.0.0</p></td>
<td><p>12/2019</p></td>
<td><p>Initial release</p></td>
</tr>
Expand Down Expand Up @@ -481,37 +477,11 @@ <h3>1.1.0 Changes<a class="headerlink" href="#changes" title="Link to this headi
</table>
</div>
</section>
<section id="id1">
<h3>1.2.0 Changes<a class="headerlink" href="#id1" title="Link to this heading"></a></h3>
<p>Version 1.2.0 introduces incident timeseries data fields. These are custom select or boolean fields, as well as incident <code class="docutils literal notranslate"><span class="pre">Owner</span></code>, <code class="docutils literal notranslate"><span class="pre">Phase</span></code> and <code class="docutils literal notranslate"><span class="pre">Severity</span></code> fields, which record the duration in seconds each field contains a particular value.
For instance, how many seconds <code class="docutils literal notranslate"><span class="pre">Severity</span></code> has a value of <code class="docutils literal notranslate"><span class="pre">Low</span></code> and <code class="docutils literal notranslate"><span class="pre">Medium</span></code>, etc.</p>
<p>To use this capability, add the following app.config settings to the <code class="docutils literal notranslate"><span class="pre">[feeds]</span></code> configuration section.</p>
<div class="table-wrapper colwidths-auto docutils container">
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head text-left"><p>Key</p></th>
<th class="head text-left"><p>Values</p></th>
<th class="head text-left"><p>Description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td class="text-left"><p>timeseries</p></td>
<td class="text-left"><p>always | onclose | never</p></td>
<td class="text-left"><p>When to collect time-series data. Because of the extra API call needed to collect this data, it could be more impactful on SOAR when set to ‘always’. default is ‘never’</p></td>
</tr>
<tr class="row-odd"><td class="text-left"><p>timeseries_fields</p></td>
<td class="text-left"><p>owner_id, phase_id, severity_code, &lt;custom_field&gt;</p></td>
<td class="text-left"><p>A comma separated list of time-series fields to collect. Custom select and boolean fields are also possible. Specify wildcard fields with ‘?’ or ‘<em>’. ex. ts_</em> will collect all time-series fields starting with “ts_”. default is all timeseries fields</p></td>
</tr>
</tbody>
</table>
</div>
</section>
</section>
<section id="compatibility">
<h2>Compatibility<a class="headerlink" href="#compatibility" title="Link to this heading"></a></h2>
<p>SOAR Compatibilty: 51.0.0 or higher</p>
<p>CP4S Compatibility: 1.10 or higher</p>
<p>SOAR Compatibilty: 30.0 or higher</p>
<p>CP4S Compatibility: 1.4 or higher</p>
</section>
<section id="license">
<h2>License<a class="headerlink" href="#license" title="Link to this heading"></a></h2>
Expand Down Expand Up @@ -726,7 +696,6 @@ <h3>Considerations<a class="headerlink" href="#considerations" title="Link to th
<li><a class="reference internal" href="#introduction">Introduction</a></li>
<li><a class="reference internal" href="#history">History</a><ul>
<li><a class="reference internal" href="#changes">1.1.0 Changes</a></li>
<li><a class="reference internal" href="#id1">1.2.0 Changes</a></li>
</ul>
</li>
<li><a class="reference internal" href="#compatibility">Compatibility</a></li>
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

0 comments on commit 8ba4fff

Please sign in to comment.