Difference between revisions of "Asset Data Import Tool"

From Hornbill
Jump to navigation Jump to search
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
This document can now be found at its new location in the [https://docs.hornbill.com/data-imports-guide/assets/overview Hornbill Document Library].
 +
 +
[[file:hornbill-document-library.png|Data Imports Guide|link=https://docs.hornbill.com/data-imports-guide/assets/overview]]
 +
 +
<!--
 +
 +
 
=About the Hornbill Asset Import Utility=
 
=About the Hornbill Asset Import Utility=
  
Line 5: Line 12:
 
==Open Source==
 
==Open Source==
  
The Asset Import Utility is provided open source under the [https://wiki.hornbill.com/index.php/The_Hornbill_Community_License_(HCL) Hornbill Community Licence] and can be found [https://github.com/hornbill/goDBAssetImport Here] on GitHub
+
The Azure User Import Utility is no longer provided open-source, and is maintained solely by Hornbill as a closed-source, but free-to-use, tool.
 
 
===History===
 
This tool is an evolution the previous [[Special:Permalink/26928|Database Asset Import v1.*]], combining the [[Special:Permalink/26716|CSV Asset Import v1.*]] tool and a revamp of the templating system.  
 
  
 
==Installation Overview==
 
==Installation Overview==
Line 327: Line 331:
 
* <code><nowiki>{{.columnName | epoch}}</nowiki></code> will convert an epoch value to the YYYY-MM-DD HH:II:SS format required for a Hornbill DateTime field
 
* <code><nowiki>{{.columnName | epoch}}</nowiki></code> will convert an epoch value to the YYYY-MM-DD HH:II:SS format required for a Hornbill DateTime field
 
* <code><nowiki>{{.columnName | epoch_clear}}</nowiki></code> will convert an epoch value to the YYYY-MM-DD HH:II:SS format required for a Hornbill DateTime field. Defaulting to CLEAR the column if unable to convert.
 
* <code><nowiki>{{.columnName | epoch_clear}}</nowiki></code> will convert an epoch value to the YYYY-MM-DD HH:II:SS format required for a Hornbill DateTime field. Defaulting to CLEAR the column if unable to convert.
* <code><nowiki>{{.columnName | date_conversion "date time format of the content in .columnName"}}</nowiki></code> Provide the input format based on the following reference time of Jan 1st 2006 4 minutes and 5 seconds past 3pm - eg "02/01/2006 15:04:05" will convert the regular UK/European date time format to the format useable in the Hornbill datetime field, whereas "01/02/2006 15:04" will process default US date time. '''Please note''' that IF your formatting is already in the Hornbill date time format (2006-01-02 15:04:05), you don't need to convert anything.
+
* <code><nowiki>{{.columnName | date_conversion "date time format of the content in .columnName"}}</nowiki></code> Provide the input format based on the following reference time of Jan 2nd 2006 4 minutes and 5 seconds past 3pm - eg "02/01/2006 15:04:05" will convert the regular UK/European date time format to the format useable in the Hornbill datetime field, whereas "01/02/2006 15:04" will process default US date time. '''Please note''' that IF your formatting is already in the Hornbill date time format (2006-01-02 15:04:05), you don't need to convert anything.
* <code><nowiki>{{.columnName | date_conversion_clear "date time format of the content in .columnName"}}</nowiki></code> Provide the input format based on the following reference time of Jan 1st 2006 4 minutes and 5 seconds past 3pm - eg "02/01/2006 15:04:05" will convert the regular UK/European date time format to the format useable in the Hornbill datetime field, whereas "01/02/2006 15:04" will process default US date time. Defaulting to CLEAR the column if unable to convert.
+
* <code><nowiki>{{.columnName | date_conversion_clear "date time format of the content in .columnName"}}</nowiki></code> Provide the input format based on the following reference time of Jan 2nd 2006 4 minutes and 5 seconds past 3pm - eg "02/01/2006 15:04:05" will convert the regular UK/European date time format to the format useable in the Hornbill datetime field, whereas "01/02/2006 15:04" will process default US date time. Defaulting to CLEAR the column if unable to convert.
  
 
==AssetTypeFieldMapping==
 
==AssetTypeFieldMapping==
Line 666: Line 670:
 
<pre>
 
<pre>
 
{
 
{
    "APIKey": "yourapikey",
 
    "InstanceId": "yourinstanceid",
 
 
     "KeysafeKeyID": 0,
 
     "KeysafeKeyID": 0,
 
     "LogSizeBytes": 1000000,
 
     "LogSizeBytes": 1000000,
Line 759: Line 761:
 
* data:entityUpdateRecord
 
* data:entityUpdateRecord
 
* data:queryExec
 
* data:queryExec
 +
* session:getApplicationList
 
* system:logMessage
 
* system:logMessage
 
* apps/com.hornbill.core:getSitesList
 
* apps/com.hornbill.core:getSitesList
Line 771: Line 774:
 
* debug - defaults to `false` = Set to true to enable debug mode, which will output debugging information to the log
 
* debug - defaults to `false` = Set to true to enable debug mode, which will output debugging information to the log
 
* forceupdates - one of the optimisations, previously included, is the comparison between new data and old data in order to decided whether the record needs an update or not. The decision is, in essence, a detection of changes in SOURCE data, not any data that might have been manipulated by using the template. This paramater caters for this - i.e. an update will always be attempted - whether or not there are going to be any changes.
 
* forceupdates - one of the optimisations, previously included, is the comparison between new data and old data in order to decided whether the record needs an update or not. The decision is, in essence, a detection of changes in SOURCE data, not any data that might have been manipulated by using the template. This paramater caters for this - i.e. an update will always be attempted - whether or not there are going to be any changes.
 +
* creds - Defaults to `false` - Set to `true` to decrypt and output the API key that is stored locally. NOTE - the tool will prompt you for your instance ID, and this can only be decrypted by the user who originally performed the encryption, and only on the same machine that it was encrypted on.
  
 
=== First Run ===
 
=== First Run ===
Line 853: Line 857:
  
 
[[Category:Integration]]
 
[[Category:Integration]]
 +
-->
 +
[[Category:HDOC]]

Latest revision as of 18:06, 10 April 2024

This document can now be found at its new location in the Hornbill Document Library.

Data Imports Guide