Skip to content

Commit 26d5e2b

Browse files
committed
Polishing
1 parent 54f4788 commit 26d5e2b

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

app_docs/README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,25 @@
11
# Foundry Sample with Python Functions
22

3-
This sample is designed to show you how to use Python Functions in Falcon Foundry.
3+
This sample is designed to show how to use Python Functions in Falcon Foundry. It contains a few capabilities:
44

5-
It contains several Python functions that show you how to:
5+
1. Python functions:
66

7-
- Integrate with workflows
8-
- Use FalconPy
9-
- Use FalconPy to invoke an API Integration
10-
- Use FalconPy to store data in a collection
11-
- Share code between functions
7+
- **hello**: Simple greeting service
8+
- **host-details**: Uses FalconPy to get Host details
9+
- **servicenow**: Uses FalconPy to invoke an API Integration
10+
- **log-event**: Uses FalconPy to store data in a collection
11+
12+
2. Test workflows to invoke each function.
13+
3. A UI extension on **Endpoint security** > **Endpoint detections** that can be used to call the `hello` function.
14+
15+
## ServiceNow API Configuration
1216

1317
When you install this app, you will be prompted for ServiceNow credentials. You can create a developer account at <https://developer.servicenow.com>. Your configuration should look similar to the following.
1418

1519
![ServiceNow Configuration](images/snow.png)
1620

1721
> If you'd rather not create an account, just fill in fake values when installing. You won't be able to test the ServiceNow API integration nor invoke the servicenow function if you use fake values.
1822
23+
## Usage
24+
1925
After installing the app, go to **Fusion SOAR** > **Workflows** to see the Test workflows for functions. Execute the **Test hello function** workflow to ensure it works. The host-details one won't succeed unless you change its `host_id` value to match a host in your CID.

0 commit comments

Comments
 (0)