This gem runs in .
Overview
Use a Source or Target gem to read from or write to SharePoint in Prophecy pipelines. This page covers supported file formats, how to create the gem, and how to configure connection details and paths for both Source and Target gems.Supported file formats
| Format | Read | Write |
|---|---|---|
| CSV | ✔ | ✔ |
| Fixed width | ✔ | |
| JSON | ✔ | ✔ |
| XLSX | ✔ | ✔ |
| XML | ✔ | ✔ |
Create a SharePoint gem
To create a SharePoint Source or Target gem in your pipeline:Add a Source or Target gem to the pipeline
- Open your pipeline in the Studio.
- Click on Source/Target in the canvas.
- Select Source or Target from the dropdown.
- Click on the gem to open the configuration.
Set location details
In the Location tab, set your file format and connection details. To learn more, jump to Location.
Set file properties
In the Properties tab, set the file properties. These vary based on the file type that you are working with.
See the list of properties per file type, such as CSV.
Source location
| Parameter | Description |
|---|---|
| Select or create connection | Select an existing SharePoint connection or create a new one. |
| File Path | Path to the file in SharePoint. Example: /sites/sitename/SharedDocuments/file.csv |
| Examine | Automatically determine the file format, compression type (if any), properties, and schema of the file to read. |
| Format type | Type of file to read, such as csv or json. |
| Compression | The compression type of the file to read. Supported types: uncompressed,gzip, zstd, lz4, zlib, snappy, lzop |
Target location
| Parameter | Description |
|---|---|
| Select or create connection | Select an existing SharePoint connection or create a new one. |
| File Path | Path to the file in SharePoint. Example: /sites/sitename/SharedDocuments/file.csv |
| Examine | If an existing file exists at the target path, click Examine to automatically determine the file format and compression type (if any). |
| Encryption Algorithm | The encryption algorithm to use when writing the file. Supported algorithms: AES-192, AES-296, BlowFish |
| Format type | Type of file to write, such as csv or json. |
| Compression | The compression type to use when writing the file. Supported types: uncompressed,gzip, zstd, lz4, zlib, snappy, lzop |
Configure encryption in a Target gem to encrypt an entire file. Use the
DataEncoderDecoder gem to encrypt individual
columns.