File tree Expand file tree Collapse file tree 1 file changed +75
-5
lines changed
docs/learn/sftp-s3-import-export Expand file tree Collapse file tree 1 file changed +75
-5
lines changed Original file line number Diff line number Diff line change @@ -67,13 +67,83 @@ Alternatively, it is also possible to install them manually (advanced):
67
67
68
68
<RossumInternalOnly url =" https://rossumai.atlassian.net/l/cp/S1coKmuC " />
69
69
70
- ## Basic usage
71
-
72
- <WIP />
73
-
74
70
## Available configuration options
75
71
76
- Available configuration options are described in the API documentation:
72
+ Common import/export configuration:
73
+
74
+ ``` json
75
+ {
76
+ "credentials" : {
77
+ // Credentials section depends on whether you are using S3 or SFTP (see below)
78
+ // …
79
+ },
80
+ "import_rules" : [
81
+ {
82
+ "dataset_name" : " PURCHASE_ORDERS_EXAMPLE_v1" ,
83
+ "import_methods" : {
84
+ "replace_method" : {
85
+ "path" : " /datasets" ,
86
+ "dynamic" : false ,
87
+ "file_format" : " xlsx" ,
88
+ "file_match_regex" : " PURCHASE_ORDERS\\ .xlsx"
89
+ }
90
+ },
91
+ "result_actions" : {
92
+ "failure" : [
93
+ {
94
+ "path" : " /datasets/failed_imports" ,
95
+ "type" : " move"
96
+ }
97
+ ],
98
+ "success" : [
99
+ {
100
+ "path" : " /datasets/archive" ,
101
+ "type" : " move"
102
+ }
103
+ ]
104
+ }
105
+ }
106
+ ]
107
+ }
108
+ ```
109
+
110
+ Credentials for ** SFTP-related** import/export are specified in the following format:
111
+
112
+ ``` json
113
+ {
114
+ "credentials" : {
115
+ "host" : " sftp.example.com" ,
116
+ "port" : " 22" ,
117
+ "type" : " sftp" ,
118
+ "username" : " example" ,
119
+
120
+ // (Optional) Version of your SFTP server. Needed only exceptionally when automatic detection of
121
+ // the version fails.
122
+ "sftp_version" : 5
123
+ },
124
+ "import_rules" : [
125
+ // … (see above)
126
+ ]
127
+ }
128
+ ```
129
+
130
+ Credentials for ** S3-related** import/export:
131
+
132
+ ``` json
133
+ {
134
+ "credentials" : {
135
+ "host" : " sftp.example.com" ,
136
+ "port" : " 22" ,
137
+ "type" : " s3" ,
138
+ "username" : " example"
139
+ },
140
+ "import_rules" : [
141
+ // … (see above)
142
+ ]
143
+ }
144
+ ```
145
+
146
+ All available configuration options are also described in the API documentation:
77
147
78
148
- Import: [ Scheduled Imports - File storage] ( https://elis.rossum.ai/svc/scheduled-imports/api/docs#tag/File-Storage/operation/import_dataset_from_file_storage_api_file_storage_v1_dataset_import_post )
79
149
- Export: [ File Storage Export] ( https://elis.rossum.ai/svc/file-storage-export/api/docs )
You can’t perform that action at this time.
0 commit comments