diff --git a/docs/8.0/ayanova/docs/adm-import.md b/docs/8.0/ayanova/docs/adm-import.md index ade6ff52..f638191a 100644 --- a/docs/8.0/ayanova/docs/adm-import.md +++ b/docs/8.0/ayanova/docs/adm-import.md @@ -37,6 +37,18 @@ If errors are found during validation no save is made and the error message is a 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. +### Import items are automatically tagged + +To make it easier to identify and if necessary mass delete imported records (for example if a mistake was found), imported records are automatically tagged with a unique time-stamped import tag. The time stamp is the same for that entire batch imported at once making them easy to identify. + +The time stamp is created at the AyaNova server from the server's time zone so it may differ from the local time of the person doing the import if they are in a different time zone than the server. + +The Tag format is `zz-import-yyyyMMddHHmmss` for example `zz-import-20220619114532` indicating a record imported June 19th 2022 at 11:45am and 32 seconds. + +The zz is prepended to ensure it displays last in the list of existing tags so it won't get in the way. + +You can easily remove the tag later if desired by using the [bulk tagger extension](ay-ex-tags.md) with the delete option. + ## How update works Checkmarking "Update existing records" indicates you want to **update** matched records in AyaNova. @@ -51,9 +63,13 @@ All the fields provided in the import file will be used to replace the matching The key (usually `Name`) field can not be updated as it's used to match records. -### Partial updates +Unlike the import process, updated records are _not_ automatically tagged however you can still see which records were updated if necessary via the [history feature](ay-history.md). -You may want to only partially update existing records in specific fields. AyaNova supports this by convention: only include fields you want updated. +### Partial record updates + +You may want to only partially update existing records in specific fields. + +AyaNova supports this by convention: only include fields you want updated. Any fields that should remain untouched must **not** be included in the import file. @@ -115,6 +131,10 @@ JSON export files created with the [Export extension](ay-ex-export.md) can be im The export extension exports many more object types and includes more fields than the import process supports. +## When in doubt about a field format + +If you're not sure how to specify a particular field, try exporting a record first using the [Export extension](ay-ex-export.md), this shows the format that each field should be in (other than [Tags in csv files](#tags-in-csv-files)). + ## Import specifications The following listed types of AyaNova objects can currently be imported / updated in AyaNova. @@ -128,21 +148,3 @@ Each item below links to a page showing the specific format required for the imp ## 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 -all dates and times assumed to be in UTC -csv and json supported -csv must have first row headers which must match expected field names in order to map -Records are matched by primary identifier, usually "Name" field and must be unique - -Field names must be the expected ones this means csv column headers as well as json property names, unrecognized fields will be thrown out and ignored - -Each type of supported importable object's allowed fields and types is documented below - -CSV will be converted to JSON before importing, if there are any errors in the CSV the import will not proceed and the results of the CSV parser's errors found will be displayed on the import page -Errors from the parser are in English language only - -