Update config json parameters authored by Rich Moeller's avatar Rich Moeller
[Return Home](home) [Return Home](home)
# "config.json" File Parameters # "config.json" File Parameters
By default, two backups configurations are defined, a merged document file containing emergency student information and also a spreadsheet of the same student data. You can define more or remove ones that you do not want here in this JSON file. All parameters are required unless specified otherwise. By default, two backups configurations are defined, a merged document file containing emergency student information and also a spreadsheet of the same student data. You can define more or remove ones that you do not want here in this JSON file. All parameters are required unless specified otherwise.
- `type:` Enter either `"mergeDoc"` or `"sheet"` to define the type of export. - `type:` Enter either `"mergedoc"` or `"sheet"` to define the type of export.
- `"mergeDoc"` will create a document with a page for each row of data from the PowerQuery using the DOCX template. The template file uses standard Mail Merge syntax. - `"mergedoc"` will create a document with a page for each row of data from the PowerQuery using the DOCX template. The template file uses standard Mail Merge syntax.
- `"sheet"` will create a spreadsheet with the data from the query. - `"sheet"` will create a spreadsheet with the data from the query.
- `powerschool:` Enter information for your PowerSchool server instance here. - `powerschool:` Enter information for your PowerSchool server instance here.
- `api:` Define the API URL and credentials in this section. - `api:` Define the API URL and credentials in this section.
...@@ -20,14 +20,14 @@ By default, two backups configurations are defined, a merged document file conta ...@@ -20,14 +20,14 @@ By default, two backups configurations are defined, a merged document file conta
- `sheet:` _(Only if type of "sheet")_ Name of the tab for the sheet in the file to insert the data. - `sheet:` _(Only if type of "sheet")_ Name of the tab for the sheet in the file to insert the data.
- `clear:` _(Only if type of "sheet")_ Boolean true or false if the sheet should be cleared prior to upload. - `clear:` _(Only if type of "sheet")_ Boolean true or false if the sheet should be cleared prior to upload.
- `ref:` _(Only if type of "sheet")_ Enter the cell reference to begin inserting the data in the sheet. Normally "A1". - `ref:` _(Only if type of "sheet")_ Enter the cell reference to begin inserting the data in the sheet. Normally "A1".
- `template:` (Only if type of `"mergeDoc"`) Name of the DOCX file containing the template for creating the merged documents. - `template:` (Only if type of `"mergedoc"`) Name of the DOCX file containing the template for creating the merged documents.
- `output:` Name of the DOCX (for type of `"mergeDoc"`) or XLSX (for type of `"sheet"`) file for the file output. - `output:` Name of the DOCX (for type of `"mergedoc"`) or XLSX (for type of `"sheet"`) file for the file output.
**Example "config.json" file contents** **Example "config.json" file contents**
``` ```
[ [
{ {
"type": "mergeDoc", "type": "mergedoc",
"powerschool": { "powerschool": {
"api": { "api": {
"base_url": "powerschool.domain.com", "base_url": "powerschool.domain.com",
... ...
......