This commit is contained in:
@@ -1,15 +1,20 @@
|
||||
# Importing Customers
|
||||
# Customer import / update specifications
|
||||
|
||||
Names of fields here are the exact case and spelling required to be recognized by AyaNova for importing / updating.
|
||||
|
||||
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
|
||||
|
||||
## Field used to match to existing records
|
||||
## Key field used to match to existing records
|
||||
|
||||
- Name
|
||||
|
||||
## Fields directly importable / updateable
|
||||
|
||||
- Name (import only)
|
||||
- Active
|
||||
- Notes
|
||||
- Wiki
|
||||
|
||||
@@ -1,7 +1,73 @@
|
||||
# Import
|
||||
|
||||

|
||||
The Import form is used to import new records *or* update existing records in AyaNova.
|
||||
|
||||
|
||||
## Authorization Roles required
|
||||
|
||||
This form is available to User's with the following [roles](ay-biz-admin-roles.md):
|
||||
|
||||
Full access
|
||||
|
||||
- Business administration
|
||||
|
||||
Read only access
|
||||
|
||||
- Business administration - restricted
|
||||
|
||||
|
||||
## How to access Import
|
||||
|
||||
From the `Administration` navigation pane select `Import` navigation item.
|
||||
|
||||
|
||||
## Import file requirements
|
||||
### File types supported
|
||||
|
||||
You can import / update from either JSON or CSV files.
|
||||
|
||||
Internally AyaNova only imports .json data so a .csv file is converted to json by the web app before sending it to the server for import.
|
||||
|
||||
### Import file format
|
||||
|
||||
Each supported object type that can be imported has it's format documented individually, click through the objects listed below to see the import file requirements.
|
||||
|
||||
Field names in .json or header row names in .csv files *must* match exactly in case and spelling the field names in each object type's specification document. Any other fields included will be removed by AyaNova before sending to the server for import.
|
||||
|
||||
|
||||
CSV files must have a header row as the first row containing the specified field names. It's ok to omit any non-required fields.
|
||||
|
||||
#### Header row
|
||||
|
||||
CSV files must have the specified field names in the header row.
|
||||
|
||||
|
||||
|
||||
## Object types supported
|
||||
|
||||
Currently these types of AyaNova objects can be imported. Each item below links to the specific format and special notes about importing that specific object:
|
||||
|
||||
- [Customer specifications](adm-import-customer.md)
|
||||
|
||||
|
||||
## How import works
|
||||
|
||||
Non matching by key field specified, if not found (any difference in spelling or case) will attempt to import.
|
||||
Uses same code as entering in form so any errors will be returned and are same as ones displayedin form for validation.
|
||||
|
||||
## How update works
|
||||
|
||||
|
||||
## Import form
|
||||
|
||||
|
||||
|
||||
### Menu options
|
||||
|
||||
|
||||
|
||||
|
||||
00000000000000000000000000000000000000000000
|
||||
Notes for docs:
|
||||
Import new records - if checked will import any records that are not found to match by name
|
||||
Update matching records - if checked will overwrite any existing records that match by name with any values in the import file, if you do not want a particular field updated, do not include it in the import file
|
||||
|
||||
Reference in New Issue
Block a user