Skip to content

Commit a2c16df

Browse files
committed
rf
1 parent 82ef33f commit a2c16df

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -520,13 +520,13 @@ An archive job configuration may contain the following properties and subsection
520520
| ------------- | ------------- | -----------------|
521521
| `name` | Name of the job. Used for logging. | Customers Archiving - May 2019 |
522522
| `list` | The title of a SharePoint list to archive | `customers` |
523-
| `exportColumns` | List of column titles for archiving or export as JSON array of strings | `["ID", "GUID", "Title","col1", "col2", "Published", "Bool", "Archived", "ArchivedDate"]` |
523+
| `exportColumns` | List of column titles for archiving or export as JSON array of strings. Note: `ID` and `GUID` columns are mandatory and have to be in the list. | `["ID", "GUID", "Title","col1", "col2", "Published", "Bool", "Archived", "ArchivedDate"]` |
524524
| `exportAttachments` | Do we need to export attachments as well (true/false). Default is `false`. | `true` or `false` |
525525
| `batchSize` | When Listman.io gets list data from Sharepoint lists it iterates through the list's data in batches or pages. The default `batchSize` value is `500`. We recommend to keep this value as 500 or lower if you have slow or unstable Internet connection | 500 |
526-
| `filterRecordsBy` | You could specify what list records to archive or export using a simple equality criteria. This subsection is used to filter specific list records for archiving or export. | See [Filter By configuration]() |
527-
| `recordAction` | You may want to delete or modify some fields of a record from the list after archiving. This subsection is used to configure post archive action for the record. | See [Record Action configuration]() |
528-
| `archiveTo` | This section is used to specify properties of the archiving or export output files like file path, adding header and file write modes like `append` or `rewrite` | See [Archive To configuration]() |
529-
| `schedule` | This section is used to specify job run schedule. Basically you could run jon immediately after application launch or by schedule using cron syntax. | See [Schedule configuration]() |
526+
| `filterBy` | You could specify what list records to archive or export using a simple equality criteria. This subsection is used to filter specific list records for archiving or export. Don't use that field or set it's value to `null` if you want to archive/export **all the list items** without filtering. Default is `null`. | See [Filter By configuration]() for details |
527+
| `recordAction` | You may want to delete or modify some fields of a record from the list after archiving. This subsection is used to configure post archive action for the record. | See [Record Action configuration]() for details |
528+
| `archiveTo` | This section is used to specify properties of the archiving or export output files like file path, adding header and file write modes like `append` or `rewrite` | See [Archive To configuration]() for details |
529+
| `schedule` | This section is used to specify job run schedule. Basically you could run jon immediately after application launch or by schedule using cron syntax. | See [Schedule configuration]() for details |
530530

531531
**Errors:**
532532
There are some errors that may be generated by the app if that section is filled up with incorrect information:
@@ -557,7 +557,9 @@ There are some errors that may be generated by the app if that section is filled
557557

558558
#### Filter By configuration
559559

560-
`filteredBy` subsection is used to specify a simple equality condition under which record from the SharePoint list will be marked for archiving or export. Condition could be specified just for one column that has `number`, `string`, `bool`, `currency` or `datetime` type.
560+
`filterBy` subsection is used to specify a simple equality condition under which record from the SharePoint list will be marked for archiving or export. Condition could be specified just for one column that has `number`, `string`, `bool`, `currency` or `datetime` type.
561+
562+
> If you want to archive/export all list items without filtering just **don't** provide `filterBy` in your config file.
561563
562564
For example let's say you have a list of `Articles` with columns `State (string)`, `Published (boolean)`, `Published Date (datetime)` and `Price (currency)`.
563565

0 commit comments

Comments
 (0)