You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This is a **maintained** fork of the fruition-parteners filesync repo. This repository adds support for current versions of ServiceNow, cleans up code management (to allow more contribution!) and provides further solutions to common "editing in ServiceNow environment" issues (eg, conflict saves). See the **Road Map** below for more info. **Contributors wanted!**
38
+
This is a **maintained** fork of the fruition-partners filesync repo. This repository adds support for current versions of ServiceNow, cleans up code management (to allow more contribution!) and provides further solutions to common "editing in ServiceNow environment" issues (eg, conflict saves). See the **Road Map** below for more info. **Contributors wanted!**
39
39
40
40
41
41
## Overview
@@ -53,7 +53,7 @@ Running a `--resync` (optional) will re-download all existing downloaded record
53
53
Conflict management also detects if the server version has changed before trying to upload local changes that may be outdated.
54
54
55
55
56
-
## Intall and Setup
56
+
## Install and Setup
57
57
58
58
Older versions of FileSync include all relevant node modules and the node engine required to run FileSync. If you want a quick install/test then follow the instructions for FileSync tag [v3.0.5](https://github.com/dynamicdan/filesync/tree/v3.0.5) (stable).
59
59
@@ -69,7 +69,7 @@ The original video for installing, configuring and using FileSync for v.0.1.0 ca
69
69
70
70
### Configuration
71
71
72
-
**Step 1.** Ensure that your instance is running with a version greater or equal to Eureka to make use of the JSONv2 API (enabled by default). For versions prior to Eurkea use the [older version of FileSync](https://github.com/fruition-partners/filesync).
72
+
**Step 1.** Ensure that your instance is running with a version greater or equal to Eureka to make use of the JSONv2 API (enabled by default). For versions prior to Eureka use the [older version of FileSync](https://github.com/fruition-partners/filesync).
73
73
74
74
**Step 2.** Create a folder on your computer where the records will be saved.
75
75
@@ -132,7 +132,7 @@ Adding an empty JSUtil.js file in the script_includes folder will cause FileSync
132
132
The basic workflow is to initially create a record/script on ServiceNow (script include, business rule, ui script, etc.), then
133
133
add an empty file of the same name (and mapped extension) to a mapped local folder (defined in config and displayed at startup).
134
134
135
-
FileSync can not support creating new records in ServiceNow by simply adding local files since there are
135
+
FileSync does not (and cannot) support creating new records in ServiceNow by simply adding local files since there are
136
136
additional fields and rules that cannot be evaluated locally. Always start by creating a new
137
137
record on the instance, then add the empty local file and start editing your script.
138
138
@@ -157,7 +157,7 @@ Example app.config.json (see also the included app.config.json file):
157
157
"host":"demo002.service-now.com",
158
158
"auth":"YWRtaW46YWRtaW4="// example of encoded user/pass
159
159
},
160
-
"/Users/joe.developer/instance/records": { //mac os non-https example
160
+
"/Users/joe.developer/instance/records": { //Mac OS non-https example
161
161
"host":"some.instance.com:16001",
162
162
"protocol":"http", // if https is not supported then force http here
163
163
"auth":"YWRtaW46YWRtaW4=",
@@ -276,7 +276,7 @@ folders | Object listing folders | not set (inherited) | See **lib/records.confi
276
276
createAllFolders | Bool: true / false | false | Creates all folders specified by folders (if set) or the default **lib/records.config.json** file.
277
277
preLoad | Bool: true / false | false | Creates local files that can be specified per root setting "`preLoadList`" (defined below). Set to false to ignore the property. Note that files that already exist are ignored but there is however a slight performance cost if you leave this option set to true. <br />**TIP**: set to false once files have been created.
278
278
ignoreList | Array of matches | `/[\/\\]\./` | Define what files are **not** tracked for changes. Defaults to ignore hidden files on any directory level (eg `.sync_data`). Usage details can be found on the [chokidar readme](https://github.com/paulmillr/chokidar#path-filtering).
279
-
ensureUniqueNames | Bool: true / false | false | If set to true then files will be post-fixed with the record sys_id to ensure all saved files have unique names. This supports records that have the same name on the same table. By default this is false to encourage more useful record names on the instance.
279
+
ensureUniqueNames | Bool: true / false | false | If set to true then files will be post-fixed with the record sys_id to ensure all saved files have unique names. This supports records that have the same name on the same table. This is false by default to encourage more useful record names on the instance.
280
280
proxy | Object | not set | Required if stuck behind a proxy. <br />Eg. `"proxy": { `<br />`"host": "host.com",`<br />`"port": "3860"`<br />` }`
281
281
282
282
@@ -361,9 +361,9 @@ Using this setup ensures that the customer will have all the files needed to do
361
361
The search feature supports 3 activites:
362
362
1.**Demo** mode to test out the tool and your connection.
363
363
1.**Custom search** that works with sysparm_query and your desired table(s) to search for records. Note that by default all tables defined under the ```folders``` config are searched if the ```table``` option is not provided.
364
-
1.**Download** option. Set to true when the search results match what you want in order to start syncing. When false or not set the search system displays found results but will not save the records to files.
364
+
1.**Download** option. Set to true when the search results match what you want in order to start syncing. When the value is false or not set, the search system displays found results but will not save the records to files.
365
365
366
-
Additionally it's possible to set the max amount of records returned per search (instance default is normally 10,000) and specify a specific table to search on (so long as it's mapped in your *folders* config).
366
+
Additionally, it's possible to set the max amount of records returned per search (instance default is normally 10,000) and specify a specific table to search on (so long as it's mapped in your *folders* config).
367
367
368
368
Pro users will find search especially useful with to always get the latest versions of records from their instance. There are also many advanced options for searching. See below for examples.
369
369
@@ -429,7 +429,7 @@ The search component enforces encourages using the config file instead of the co
0 commit comments