Configuration Explanation

• KeysafeKeyID - Type: integer - The ID of the KeySafe Key that contains your database authentication details. See the KeySafe section of the Authentication article for more information.
• CSV - Type: object - If the data source is an on-disk CSV file, then this should be populated with the information needed to extract the user records. If the DataSourceFile value is set, then the import will skip the Database properties, below.
  • DataSourceFile - Type: string - The path of the CSV file which contains the data
  • CommaCharacter - Type: string - The character used as field separator (usually “,”)
  • LazyQuotes - Type: boolean - true/false if quoted fields might appear in an unquoted field
  • FieldsPerRecord - Type: integer - a number that will automatically be calculated based on the first (header) line. This allows for manipulation (in case later records might have more fields)
  • CarriageReturnRemoval - Type: boolean - true/false - tidying up the CSV file if necessary
• Database - Type: object - The information that the utility needs to query your source database.
  • Source - Type: string - The database technology the utility needs to connect to, one of:
    • mssql - Microsoft SQL Server
    • mysql - MySQL or MariaDB
    • csv - CSV file, via ODBC
    • excel - Excel spreadsheet, via ODBC
  • Encrypt - Type: boolean - Specifies whether the connection between this utility and the source database should be encrypted. There is a bug in SQL Server 2008 and below that causes connection failures if the connection is encrypted. Only set this to true if your SQL Server supports this, or has been patched accordingly.
  • Query - Type: string - The SQL query to return your list of users for import. Please note that all field names are specificied as lowercase - this is to ensure smooth operation for field mapping (as they are case-sensitive). Also, by specifying each field in use, one is following SQL best practice as it prevents unnecessary/unused data to be returned, stored and processed (longvarchar and blob fields, for instance, can take up a lot of memory). For CSV please use UPPERCASE for all field names and, also, do NOT use spaces in the headers/fieldnames.
• Action - Type: string - Can be Create, Update, or Both. Import actions to perform on the discovered user records.
• User - Type: object - Contains all source database records to Hornbill mappings, and user configuration.
  • UserDN - Type: string - The content from the source database user records that matches the unique reference against your Hornbill user records.
  • HornbillUniqueColumn - Type: string - Can be h_user_id, h_employee_id, h_login_id or h_email. The column from the Hornbill user records that is used to match the user records against their UserDN (above).
  • AccountMapping - Type: object - Data mapping, in the format "fieldInHornbill": "data to insert". The data to insert can either be hard-coded strings, mapped from the source data using one or more Go templates, or a mixture of the two. Some specific examples:
    • "UserType": "basic" - All records will be created as Basic Users in Hornbill. See the Hornbill user documentation for more information.
    • "Password": "" - if the Password data mapping is left empty, then the utility with generate a random password to create new users with. The generated passwords will obey the password policies defined on the target Hornbill instance.
    • "Site": "1" - If set, see the comments below on SiteLookup
    • TimeZone - See the list of timezones supported by Hornbill for valid values.
    • Language - Language localization tags, ISO 629 in combination with ISO 3166, examples:
      • en-GB
      • en-US
      • fr-FR
      • etc…
    • DateTimeFormat - See the list of supported DateTime formats for valid values.
    • CountryCode - ISO 3166 Alpha 2 two Character Country Code.
    • NOTE - Any value of __clear__ will clear the target field for user records being updated.
  • ProfileMapping - Type: object - Data mapping for user profile fields, in the format "fieldInHornbill": "data to insert". See AccountMapping above for details.
  • Type - Type: object - Contains a single property Action, which can be Create, Update, or Both. Import actions to perform on the Type field of the discovered user records.
  • Status - Type: object - Contains two properties, Import actions to perform on the Status of the discovered user records:
    • Action - Type: string - Can be Create, Update, or Both.
    • Value - Type: string - The user account status. Can be active, suspended, or archived.
  • Role - Type: object - Contains two properties, Import actions to perform on the Roles of the discovered user records:
    • Action - Type: string - Can be Create, Update, or Both.
    • Roles - Type: array - A list of application or system roles that should be assigned to the users being imported.
  • Manager - Type: object - Contains three properties, Import actions to perform on the Manager field of the discovered user records:
    • Action - Type: string - Can be Create, Update, or Both.
    • Value - Type: string - The mapped value of the users manager. . Set to __clear__ to remove the manager for user records being updated.
    • Options - Type: object - Contains several properties to allow granular searching of the relevant manager records:
      • Get String From Value - Type: object
        • Regex - Type: string - Optional regular expression to match the name from a DSN String.
        • Reverse Type: boolean - Reverse the name string matched from the regular expression, above.
      • Match Against DN Type: string - Match the users manager against the Distinguished Name instead of their name.
      • Search - Type: object
        • Enable - Type: boolean
        • SearchField - Type: string - The field to search for manager records against.
  • Image - Type: object - Contains several properties, Import actions to perform on profile images of the discovered user records:
    • Action - Type: string - Can be Create, Update, or Both.
    • UploadType - Type: string - Can be URI or URL - local (network) drive or HTTP(S) served images
    • InsecureSkipVerify - Type: boolean - Skip invalid certificate verification when importing images
    • ImageType - Type: string - Image type, can be png or jpg
    • URI - Type: string - The source mapping for the image… Set to __clear__ to remove the profile image for user records being updated.
  • Site - Type: object - Contains two properties, Import actions to perform on the Location of the discovered user records:
    • Action - Type: string - Can be Create, Update, or Both.
    • Value - Type: string - The source mapping of the Location.
  • Org - Type: array - An array of objects containing several properties of Organizational Unit/Group information to associate the imported user with:
    • Action - Type: string - Can be Create, Update, or Both.
    • Value - Type: string - The mapped name of the Organizational Unit.
    • Options - Type: object - A collection of properties to define membership settings of organizational group:
      • Type - Type: integer - The numeric value for the group type:
        • 0 - general
        • 1 - team
        • 2 - department
        • 3 - costcenter
        • 4 - division
        • 5 - company
        • 6 - businessUnit
        • 7 - directorate
        • 8 - branch
        • 9 - function
        • 10 - board
        • 11 - subsidiary
      • Membership - Type: string - The group membership role, can be one of member, teamLeader or manager.
      • TasksView - Type: boolean - If set to true, then the imported users can view tasks assigned to this group (Typically only required for Groups of type “Team”).(Typically only required for Groups of type “Team”).
      • TasksAction - Type: boolean - If set to true, then the user can action tasks assigned to this group.
      • OnlyOneGroupAssignment - Type: boolean - When set to true, a user can only be associated with a single group of the specified type at any one time. So for example, if in the latest import the configuration was set to associate users to the Accounting department, the users would be associated with this new department and removed from any other department group that they were already associated with.
      • SetAsHomeOrganisation - Type: boolean - Only used when the group type is Company (5). When set to true, the Company will be set as the users Home Organization.
  • Actions - Type: array - A list of transform actions that can be performed on mapped field values:
    • Action - Type: string - One of Trim, Replace or Regex.
      • Trim - Trims whitespace characters from the beginning and end of the value.
      • Replace - Replaces part of a value string with another string.
      • Regex - Searches the value for content using a provided regular expression, and returns that value.
    • Options - Type: object - A collection of properties to control either the Replace or Regex actions:
      • replaceFrom - Type: string - Used in the Replace action. The old string that should be replaced.
      • replaceWith - Type: string - Used in the Replace action. The new string to replace the old string with.
      • regexValue - Type: string - Used in the Regex action. The regular expression to use to search the value.