Skip to content

DOCS-823 - Break up integration framework article #5367

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
May 14, 2025
Merged

DOCS-823 - Break up integration framework article #5367

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8cea9a7
Break up article
jpipkin1 May 12, 2025
80195a3
Fix build break
jpipkin1 May 13, 2025
8c1ad81
Fix broken links
jpipkin1 May 13, 2025
da4130b
Fix another broken link
jpipkin1 May 13, 2025
b46233b
Fix redirects
jpipkin1 May 13, 2025
4c4416c
Merge branch 'main' into docs-823-break-up-integration-framework-article
jpipkin1 May 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions cid-redirects.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4295,8 +4295,8 @@
"/docs/cse/automation-service/automation-service-bridge": "/docs/platform-services/automation-service/automation-service-bridge",
"/docs/cloud-soar/cloud-soar-bridge": "/docs/platform-services/automation-service/automation-service-bridge",
"/docs/cloud-soar/audit-event-index": "/docs/platform-services/automation-service/automation-service-audit-logging/",
"/docs/cse/automation-service/automation-service-integration-framework": "/docs/platform-services/automation-service/automation-service-integration-framework",
"/docs/cloud-soar/cloud-soar-integration-framework": "/docs/platform-services/automation-service/automation-service-integration-framework",
"/docs/cse/automation-service/automation-service-integration-framework": "/docs/platform-services/automation-service/integration-framework",
"/docs/cloud-soar/cloud-soar-integration-framework": "/docs/platform-services/automation-service/integration-framework",
"/docs/send-data/collect-from-other-data-sources/kubernetes": "/docs/send-data/kubernetes",
"/docs/send-data/kubernetes/v4": "/docs/send-data/kubernetes",
"/docs/send-data/collect-from-other-data-sources/azure-blob-storage/collect-logs-azure-blob-storage": "/docs/send-data/collect-from-other-data-sources/azure-blob-storage/block-blob/collect-logs",
Expand Down
2 changes: 1 addition & 1 deletion docs/cloud-soar/automation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Because Cloud SOAR provides automation functionality to the [Automation Service]
* [Playbooks](/docs/platform-services/automation-service/automation-service-playbooks/)
* [Integrations](/docs/platform-services/automation-service/automation-service-integrations/)
* [Automation bridge](/docs/platform-services/automation-service/automation-service-bridge)
* [Integration framework](/docs/platform-services/automation-service/automation-service-integration-framework/)
* [Integration framework](/docs/platform-services/automation-service/integration-framework/)
* [Audit logging](/docs/platform-services/automation-service/automation-service-audit-logging)

The following sections describe automation features only used in Cloud SOAR.
Expand Down
2 changes: 1 addition & 1 deletion docs/cloud-soar/compared-to-automation-service.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The Automation Service doesn't include any of Cloud SOAR’s case management or

### Daemon and trigger action types

The Automation Service does not support [daemon](/docs/platform-services/automation-service/automation-service-integration-framework/#daemon-action-definitions) and [trigger](/docs/platform-services/automation-service/automation-service-integration-framework/#trigger-action-definitions) action types. The Automation Service can only use triggers built into Cloud SIEM and the Log Analytics platform. So you can’t configure a playbook in the Automation Service to monitor an external process or file and fire a trigger in response like you can with Cloud SOAR. A trigger can only fire in the Automation Service for limited events, such as when an Insight is created in Cloud SIEM.
The Automation Service does not support [daemon](/docs/platform-services/automation-service/integration-framework/about-integration-framework/#daemon-action-definitions) and [trigger](/docs/platform-services/automation-service/integration-framework/about-integration-framework/#trigger-action-definitions) action types. The Automation Service can only use triggers built into Cloud SIEM and the Log Analytics platform. So you can’t configure a playbook in the Automation Service to monitor an external process or file and fire a trigger in response like you can with Cloud SOAR. A trigger can only fire in the Automation Service for limited events, such as when an Insight is created in Cloud SIEM.

### Additional features

Expand Down
2 changes: 1 addition & 1 deletion docs/cloud-soar/introduction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -409,7 +409,7 @@ Within Automation, you’ll see subsections for:
* [App Central](/docs/platform-services/automation-service/app-central/). A large out-of-the-box library of playbooks, integrations, and use cases for different threats to get you started with orchestrating and automating your SOC.
* [Playbooks](/docs/platform-services/automation-service/automation-service-playbooks/). Allows you to create new playbooks and edit, delete, and manage existing ones.
* [Template](/docs/cloud-soar/automation/#incident-templates). Allows you to create new incident templates and edit, delete, and manage existing ones.
* [Integrations](/docs/platform-services/automation-service/automation-service-integration-framework/). Lets you connect third party tools through APIs.
* [Integrations](/docs/platform-services/automation-service/automation-service-integrations/). Lets you connect third party tools through APIs.
* [Rules](/docs/cloud-soar/automation/#automation-rules). Lets you create new automation rules.
* [Bridge](/docs/platform-services/automation-service/automation-service-bridge/). Contains configuration details on any installed bridges.

Expand Down
2 changes: 1 addition & 1 deletion docs/cloud-soar/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Gain complete insight into incident response performance with customizable dashb

### Open Integration Framework (OIF)

Choose from hundreds of out-of-the-box actions and playbooks or ask the Sumo Logic team to develop the connectors you need. Anyone can access the API code to quickly integrate tools without any coding experience required. For more information, see [Integrations](/docs/platform-services/automation-service/automation-service-integrations/) and [Integration Framework](/docs/platform-services/automation-service/automation-service-integration-framework/).
Choose from hundreds of out-of-the-box actions and playbooks or ask the Sumo Logic team to develop the connectors you need. Anyone can access the API code to quickly integrate tools without any coding experience required. For more information, see [Integrations](/docs/platform-services/automation-service/automation-service-integrations/) and [Integration Framework](/docs/platform-services/automation-service/integration-framework/).

<img src={useBaseUrl('img/cloud-soar/overview-openI-itegration.png')} alt="Integrations" style={{border: '1px solid gray'}} width="800" />

Expand Down
2 changes: 1 addition & 1 deletion docs/cse/automation/cloud-siem-automation-examples.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ The following example shows how to configure a notification that sends an email

## Advanced example: Configure a custom integration

The following example shows how to create a custom integration with an action that runs a script you provide. The custom integration and action are defined by YAML files. To learn how to build your own YAML files, see [Integration framework file formats](/docs/platform-services/automation-service/automation-service-integration-framework/#integration-framework-file-formats).
The following example shows how to create a custom integration with an action that runs a script you provide. The custom integration and action are defined by YAML files. To learn how to build your own YAML files, see [Integration framework file formats](/docs/platform-services/automation-service/integration-framework/about-integration-framework/#integration-framework-file-formats).

The action uses [IP Quality Score](https://www.ipqualityscore.com/) to gather IP reputation information for enrichment. (This example shows how to add enrichment to an insight. To use the same action to add enrichment to entities, see [Add entity enrichment](#add-entity-enrichment) below.)

Expand Down
4 changes: 2 additions & 2 deletions docs/platform-services/automation-service/automation-service-audit-logging.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ The table below shows the `_sourceCategory` that is assigned to Audit Event Inde
| [Automation action](/docs/platform-services/automation-service/automation-service-playbooks/#add-an-action-node-to-a-playbook) | `oarAutomationActions` |
| [Automation action configuration](/docs/platform-services/automation-service/automation-service-playbooks/#add-an-action-node-to-a-playbook) | `oarAutomationActionConfigurations` |
| [Integration](/docs/platform-services/automation-service/automation-service-integrations/) | `oarIntegrations` |
| [Integration resource](/docs/platform-services/automation-service/automation-service-integration-framework/) | `oarIntegrationResources` |
| [Integration resource](/docs/platform-services/automation-service/integration-framework/) | `oarIntegrationResources` |
| [Playbook execution](/docs/platform-services/automation-service/automation-service-playbooks/) | `oarPlaybookExecutions` |
| [Playbook revision](/docs/platform-services/automation-service/automation-service-playbooks/) | `oarPlaybookRevisions` |

Expand All @@ -70,7 +70,7 @@ The table below shows the `_sourceCategory` that is assigned to Audit Event Inde
| Product Feature | _sourceCategory Value |
|:--|:--|
| [Custom Field](/docs/cloud-soar/overview/#custom-fields) | `oarCustomFields` |
| [Daemon](/docs/platform-services/automation-service/automation-service-integration-framework/#daemon-action-definitions) | `oarDaemons` |
| [Daemon](/docs/platform-services/automation-service/integration-framework/about-integration-framework/#daemon-action-definitions) | `oarDaemons` |
| [Dashboard](/docs/cloud-soar/incidents-triage/#dashboards) | `oarDashboards` |
| Email | `oarEmails` |
| [Entity](/docs/cloud-soar/incidents-triage/#entities) | `oarEntities` |
Expand Down
Loading