admin/raven
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Browse Source
This commit is contained in:
John Cardinal
2022-03-28 18:08:38 +00:00
parent b8fc078aad
commit 06298c5f89
5 changed files with 149 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/8.0/ayanova/docs/adm-import-customer.md
View File

@@ -1,6 +1,6 @@
# Customer import / update specifications
Names of fields listed here are the exact case and spelling required to be recognized by AyaNova for importing / updating.
Names of fields listed here are the exact case and spelling required to be recognized by AyaNova for [importing / updating](adm-import.md).
Any field in the import file that is not listed on this page will be removed before sending to the server for import.

2
docs/8.0/ayanova/docs/adm-import-headoffice.md
View File

@@ -1,6 +1,6 @@
# Head office import / update specifications
Names of fields listed here are the exact case and spelling required to be recognized by AyaNova for importing / updating.
Names of fields listed here are the exact case and spelling required to be recognized by AyaNova for [importing / updating](adm-import.md).
Any field in the import file that is not listed on this page will be removed before sending to the server for import.

142
docs/8.0/ayanova/docs/adm-import-part-assembly.md Normal file
View File

@@ -0,0 +1,142 @@
# Part assembly import / update specifications
Names of fields listed here are the exact case and spelling required to be recognized by AyaNova for [importing / updating](adm-import.md).
Any field in the import file that is not listed on this page will be removed before sending to the server for import.
## Required fields
- Name
## Key field used to match to existing records
- Name
## Fields directly importable / updateable
- Name (import only)
- Active
- Notes
- Wiki
- Tags
- Items
- Quantity
## Linked object fields
The following linked objects are importable / updateable:
- Part via "PartNameViz" field which must contain the name of an existing Part
## JSON file format
The .json file must contain an array of Part assembly objects, so even a single object must be within [] square brackets in the import file.
The first Part assembly record here illustrates importing a Part assembly with links to existing Manufacturer, Wholesaler and Alternative Wholesaler and also how to include serial numbers.
```JSON
[
{
"Name": "Primary 7242",
"Active": true,
"Notes": "Corrupti et animi non soluta.",
"Wiki": null,
"Tags": [
"orange",
"silver",
"zone3",
"zone5"
],
"Items": [
{
"PartNameViz": "097091",
"Quantity": 1.00000
},
{
"PartNameViz": "874579",
"Quantity": 3.00000
},
{
"PartNameViz": "375486",
"Quantity": 1.00000
},
{
"PartNameViz": "983612",
"Quantity": 15.00000
},
{
"PartNameViz": "198660",
"Quantity": 1.00000
}
]
},
{
"Name": "Lower Arm 5369",
"Active": true,
"Notes": "Voluptatum et molestiae magnam at iste similique iusto modi ea.",
"Wiki": null,
"Tags": [
"orange",
"zebra",
"zone1"
],
"Items": [
{
"PartNameViz": "734629",
"Quantity": 1.00000
},
{
"PartNameViz": "048902",
"Quantity": 1.00000
}
]
},
{
"Name": "Board 9995",
"Active": true,
"Notes": "Iure eius ut id consequatur omnis aut ut.",
"Wiki": null,
"Tags": [
"gold",
"mauve",
"violet",
"zone8"
],
"Items": [
{
"PartNameViz": "335219",
"Quantity": 1.00000
},
{
"PartNameViz": "048902",
"Quantity": 1.00000
},
{
"PartNameViz": "417318",
"Quantity": 1.00000
}
]
}
]
```
## CSV file format
The first row of the .csv file must contain column headers that match the field names listed above.
CSV doesn't cleanly map on to structured elements with sub collections well so the Items column here which contains the part and quantity items for this assembly has a special format we've adopted:
The Items column **must** be:
- surrounded in double "quotes"
- contain the parts and their quantities in pairs separated by commas
- each pair must be split by the pipe character |
- each pair must contain the part name of an existing part in AyaNova as the *first* part of the pair
- each pair must contain the quantity of that part as the second part of the pair
```
Name,Active,Notes,Wiki,Tags,Items
Primary 7242,true,Corrupti et animi non soluta.,,"orange,silver,zone3,zone5","097091|1.00000,874579|3.00000,375486|1.00000,983612|15.00000"
Lower Arm 5369,true,Voluptatum et molestiae magnam at iste similique iusto modi ea.,,"orange,zebra,zone1","734629|1.00000,048902|1.00000"
Board 9995,true,Iure eius ut id consequatur omnis aut ut.,,"gold,mauve,violet,zone8","335219|1.00000|048902|1.00000,417318|1.00000"
```

2
docs/8.0/ayanova/docs/adm-import-part.md
View File

@@ -1,6 +1,6 @@
# Part import / update specifications
Names of fields listed here are the exact case and spelling required to be recognized by AyaNova for importing / updating.
Names of fields listed here are the exact case and spelling required to be recognized by AyaNova for [importing / updating](adm-import.md).
Any field in the import file that is not listed on this page will be removed before sending to the server for import.

4
docs/8.0/ayanova/docs/adm-import.md
View File

@@ -104,6 +104,10 @@ You can import / update from either JSON or CSV files.
The AyaNova server only supports .json data; a .csv file is converted to json format first by the AyaNova web app before sending it to the AyaNova server for import.
#### Use .json if possible
If at all possible, we recommend using the .json format _over_ the .csv format as .json can exactly match the structure of the objects in AyaNova and imports in one step, whereas the CSV files need to be mapped on to the .json format structure before sending to the server for import / update.
### Import file format
Each supported object type that can be imported has it's [import specification](#import-specifications) and examples documented individually, click through the objects listed below to see the import file specifications for each type.