-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
7d40b8b
commit 63a35f7
Showing
1 changed file
with
67 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,67 @@ | ||
# CTX-Salesforce | ||
This module allows users to create, update, get details of, delete, and query each of the following Salesforce objects: Accounts, Cases, Opportunities and Leads | ||
# CTX-Salesforce Cortex Module | ||
|
||
The module allows users to perform the following functionality: | ||
1) Generate details allowing connection to a Salesforce instance. | ||
2) Create, update, get details of, delete and query Salesforce accounts, cases, opportunities and leads. | ||
3) Get details of and download to a target location any attachments associated with these objects. | ||
4) Send a generic API call to the Force.com sObject Resources REST API v37.0 | ||
|
||
## Table of Contents | ||
1) [Dependencies](#dependencies) | ||
* [Cortex Version](#cortex-version) | ||
* [OCIs](#ocis) | ||
* [Files](#files) | ||
* [Other](#other) | ||
2) [Installation](#installation) | ||
3) [How to use](#how-to-use) | ||
4) [How you can contribute](#how-you-can-contribute) | ||
5) [Versioning](#versioning) | ||
6) [Licensing](#licensing) | ||
|
||
|
||
## Dependencies | ||
### Cortex Version | ||
This version of the CTX-Salesforce module was developed in Cortex version 6.5. Some functionality may not be available on different verions of Cortex. | ||
|
||
### OCIs | ||
The module requires the following Cortex OCIs: | ||
* PowerShell | ||
* HTTP | ||
|
||
### Files | ||
The CTX-Salesforce module requires the following files: | ||
* [CTX-Salesforce.studiopkg](https://github.com/CortexIntelligentAutomation/CTX-Salesforce/releases/download/<Module Version>/CTX-Salesforce.studiopkg) | ||
|
||
### Other | ||
The CTX-Salesforce module has the following additional requirements which are explained in detail in the [Installation section](#Installation):<Other Requirements> | ||
|
||
## Installation | ||
Details of the installation can be found in the [CTX-Salesforce Deployment Plan](https://github.com/CortexIntelligentAutomation/CTX-Salesforce/blob/master/CTX-Salesforce%20-%20Deployment%20Plan.pdf). | ||
## How to use | ||
A detailed User Guide has been provided with instructions on how to use the flows/subtasks, available [here](https://github.com/CortexIntelligentAutomation/CTX-Salesforce/blob/master/CTX-Salesforce%20-%20User%20Guide.pdf). Configuration of subtask inputs and outputs are detailed in notes on the subtask workspace. | ||
|
||
## How you can contribute | ||
Unfortunately, we cannot offer pull requests at this time or accept any improvements. | ||
|
||
## Versioning | ||
CTX-Salesforce has the following versions, starting with the most recent:<Module Version History> | ||
|
||
## Licensing | ||
All functionality within this module is licensed under the [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0). | ||
|
||
Copyright 2019 Cortex Limited | ||
|
||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
|
||
http://www.apache.org/licenses/LICENSE-2.0 | ||
|
||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
|
||
|
||
|