DataImporter : Specifications

Overview

Quick overview on how DataImporter works

1. Use the external database system (including database management tools) to define the view. Here are some systems that offer the possibility to create views: Oracle, Microsoft SQL Server, MySql, DB2, DBase, Fox Pro.
2. Use MS-Access as a “bridge” between Octopus and the external system. This option is useful when the external system has an ODBC/OLEDB compatible database but do not include a tool to create views. In that case, we use MS-Access to link tables with the external system and we create the view in MS-Access. With this option, the Access database becomes the data source of DataImporter.
   
   

Steps to define a view that can be used by DataImporter:

1. Create a MS-Access database named db1.mdb.
2. Link one or more tables from the external system.
3. Create a query (view) named “UsersSysFile” in the MS-Access database. The view name can be different.
4. Analyze the external system table structure to discover how you can match it with Octopus specifications. See herein below the section describing specifications.
5. Edit “UsersSysFile” query in order to match the specifications (field names, required fields, etc.).
6. Save MS-Access database including the appropriate changes.
   
   

Creation of the DataImporter Configuration File

<?xml version=”1.0” encoding=”utf-8” ?>
<Sources>
     <Source Name=”UserSource” >
          <ConnectionString>Provider=Microsoft.Jet.OLEDB.4.0;Data Source=c:\\db1.mdb</ConnectionString>
	  <ViewName>UsersSysFile</ViewName>
          <Content>User</Content>
    </Source>
</Sources>

<?xml version= »1.0 » encoding= »utf-8 » ?>
<Sources>
     <Source Name=”SourceName” >
          <ConnectionString>Provider=Microsoft.Jet.OLEDB.4.0;Data Source=c:\\db1.mdb</ConnectionString>
          <ViewName>UsersSysFile</ViewName>
          <Content>User</Content>
     </Source>

     <Source Name=”SourceName2” >
          <ConnectionString>Provider=Microsoft.Jet.OLEDB.4.0;Data Source=c:\\db1.mdb</ConnectionString>
          <ViewName>Computers</ViewName>
          <Content>CI</Content>
     </Source>

     <Source Name=”SourceName3” >
          <ConnectionString>Provider=Microsoft.Jet.OLEDB.4.0;Data Source=c:\\db1.mdb</ConnectionString>
          <ViewName>Monitors</ViewName>
          <Content>CI</Content>
     </Source>
</Sources>

XML file for data sources declaration

<Source Name="Computers">
   <ConnectionString>Provider=Microsoft.Jet.OLEDB.4.0;Data Source=C:\\Computers.mdb</ConnectionString>
   <ViewName>Computers</ViewName>
   <Content>CI</Content>
</Source>

• ConnectionString : Connection String specifies information about a data source and the means of connecting to it. For further information, go to the following site : www.connectionstrings.com.
• ViewName : Name of the view. If your source is built in Excel, the view name must be your Excel worksheet name followed by a ”$“ and wrapped in brackets (example : [Sheet1$]).
• Content : Source Declaration, i.e. what needs to be imported in Octopus (CI, Users, etc.). See next section for the list of sources you can import.
  
  

How to use DataImporter Program

Parameters

• /Login: Octopus username.
• /Password: Octopus password.
• /ConfigFilePath: Complete path of DataImporter Configuration File.

ESI.Octopus.DataImporterApp.exe /login:system /password:octo /ConfigFilePath:c:\pc.xml

Operation Log

Importation Sources Specifications

User Importation

• Surname - Text(100)
• Firstname - Text(100)

• EmployeeID – Text(50)
  • Must be unique.
• Language
  • Must be one of the existing reference values in Octopus.
• Department - Text(50)
  • The system will create the department if it doesn't exist.
• SubDepartment - Text(50)
  • The system will create the sub-department if it doesn't exist.
  • If a sub-department is specified, then a department must also be specified.
• Title - Text(100)
• Site - Text(50)
  • The system will create the site if it doesn't exist.
• Local - Text(50)
• OfficePhone - Text(50)
• PhoneExtension - Text(6)
• CellPhone - Text(50)
• Pager - Text(50) « Version 2.15 »
• Email - Text(50)
• Note - Text(2000)
• Active - (1/0 or True/False)
• WindowsUsername - Text(50)

• UserByID
• UserByName : The format is {First name} {Last name} (ex : John Smith).
• UserByNameAndPhoneExtension
• UserByWindowsUsername

<Source Name="SourceName">
   <ConnectionString>Provider=Microsoft.Jet.OLEDB.4.0;Data Source=c:\\db1.mdb</ConnectionString>
   <ViewName>ViewName</ViewName>
   <Content>User</Content>
   <IdentificationMethod>UserByID</IdentificationMethod>
</Source>

CI Importation

• Name - Text(125)
  • Must be unique
  • We suggest that you concatenate software name with its version to make it as a unique name. For instance, for Octopus version 1.9, we would have: « Octopus (1.9) ».

• Type - Text(50)
  • This column describes the CI type that we want to import. To make the import working, the returned type must match EXACTLY with one of the CI types of Octopus database. Available Octopus CI types appear in the Octopus main menu under Tools > Reference Data Management.

• Manufacturer – Text(500)
  • The system will create a manufacturer if it does not exist.
• Model - Text(50)
  • The system will create a new model if it does not exist.
• Version - Text(50)
• Status
  • Must be one of the CI status in the reference values.
• Criticality
  • Must be one of the CI criticality in the reference values.
• SerialNumber - Text(250)
• InventoryNumber - Text(50)
• Department - Text(50)
  • The system will create a department if it does not exist.
• SubDepartment - Text(50)
  • The system will create a sub-department if it does not exist.
  • If a sub-department is specified, a department must be specified also.
• MainContact
  • See section «Main contact identification method».
• Site - Text(50)
  • The system will create a site if it does not exist.
• Local - Text(50)
  • The system will create a room (local) if it does not exist.
  • If a room (local) is specified, a site must also be specified.
• Category - Text(50)
  • The system will create a category if it does not exist.
  • A CI category is related to its type.
• Note - Text(5000)
• Supplier - Text(500)
  • The system will create the supplier if it does not exist.
• MaintenanceSupplier - Text(500)
• PurchaseOrderNumber - Text(50)
• PurchaseDate - Date and Hour
  • The date format must be compatible with the Octopus server settings (AAAA-MM-JJ HH:MM:SS).
• PurchaseCost - Decimal (ex.: 123456789,12)
• CostCenter – Text(50)
• InvoiceNumber – Text(50)
• WarrantyExpiryDate – Text(50)
• WarrantyType – Text(100)
• FundingSource – Text(100)
• RequiresServiceContract – (1/0 or True/False)
• Lifetime – Text(50)
• AmortizationDuration – Integer (ex : 123)
  • The amortization duration expressed as a number of months.

• Any other custom attribute corresponding to the CI type imported.

• CIByName : (Default value) Name of the CI
• CIByInventoryNumber : CI Inventory number
• CIBySerialNumber : CI Serial number

• UserByID : Main contact Employee number
• UserByName : Main contact First name and last name (format : Martin Tremblay)
• UserByWindowsUsername : (Default value) Main contact Network username (Windows Logon)

<Source Name=”SoftwareView” >
     <ConnectionString>Provider=Microsoft.Jet.OLEDB.4.0;Data Source=c:\\db1.mdb</ConnectionString>
     <ViewName>QueryOrViewNameHere</ViewName>
     <Content>CI</Content>
     <ManageCIRetirement>false</ManageCIRetirement>
     <IdentificationMethod>CIByName</IdentificationMethod>
     <MainContactIdentificationMethod>UserByWindowsUsername</MainContactIdentificationMethod>
</Source>

Import of Relationships Between CI

• CI1 - Text (125)
• CI2 - Text (125)
• Relation - Texte (50)
  • Name of the relationship to be created between 2 CI.

• Note – Text (5000)

<Source Name=”ComputersMonitorsView”>
     <ConnectionString>Provider=Microsoft.Jet.OLEDB.4.0;Data Source=c:\\db1.mdb</ConnectionString>
     <ViewName>QueryOrViewNameHere</ViewName>	
     <Content>CIRelation</Content>
</Source>

Remove relations that no longer exist between 2 CI

<?xml version="1.0" encoding="utf-8" ?> 
<Source Name="CIRelation">   
   <ConnectionString>Provider=Microsoft.Jet.OLEDB.4.0;Data Source=c:\\db1.mdb</ConnectionString>
   <ViewName>NomDeVue</ViewName>	
   <ManageRelations>True</ManageRelations>
   <Content>CIRelation</Content>
</Source>

CI Users Importation

• CI - Text (50)
• User

• UserByID : Employee number of the user
• UserByName : First name and last name of the user (format : John Smith)
• UserByWindowsUsername : (Default value) Network username of the user (Windows Logon)

<Source Name=”UsersOfCIs”>
     <ConnectionString>Provider=Microsoft.Jet.OLEDB.4.0;Data Source=c:\\db1.mdb</ConnectionString>
     <ViewName>QueryOrViewNameHere</ViewName>	
     <Content>CIUser</Content>
     <UserIdentificationMethod>UserByWindowsUsername</UserIdentificationMethod>
</Source>

Service Contract Importation

• Number - Text (50)
• Type - Text (100)
  • Type of service contract (Maintenance, Extended warranty, etc.)
• StartDate - Text (50)
  • The date format must be compatible with Octopus server settings (MM-JJ-YYYY HH :MM :SS)
• EndDate - Text (50)
  • The date format must be compatible with Octopus server settings (MM-JJ-YYYY HH :MM :SS)
• Supplier - Text (500)

• PurchaseOrderNumber - Text (50)
• Cost – Text (50)
• Description - Text (5000)

<Source Name=”ServiceContracts”>
     <ConnectionString>Provider=Microsoft.Jet.OLEDB.4.0;Data Source=c:\\db1.mdb</ConnectionString>
     <ViewName>QueryOrViewNameHere</ViewName>	
     <Content>ServiceContract</Content>
</Source>

Import of CI supported by a Service Contract

• Contract - Text (50)
  • Must contain the contract number
• CI - Text (100)

• Cost – Text (50)

<Source Name=”ServiceContractsCIs”>
     <ConnectionString>Provider=Microsoft.Jet.OLEDB.4.0;Data Source=c:\\db1.mdb</ConnectionString>
     <ViewName>QueryOrViewNameHere</ViewName>	
     <Content>SupportedCI</Content>
</Source>

Lease Contract Importation

• Number - Text (50)
• StartDate - Text (50)
  • The date format must be compatible with Octopus server settings (MM-JJ-YYYY HH :MM :SS)
• EndDate - Text (50)
  • The date format must be compatible with Octopus server settings (MM-JJ-YYYY HH :MM :SS)
• Supplier - Text (500)

• PurchaseOrderNumber - Text (50)
• Cost – Text (50)
• Description - Text (5000)

<Source Name=”LeaseContracts”>
     <ConnectionString>Provider=Microsoft.Jet.OLEDB.4.0;Data Source=c:\\db1.mdb</ConnectionString>
     <ViewName>QueryOrViewNameHere</ViewName>	
     <Content>LeaseContract</Content>
</Source>

Import of CI supported by a Lease Contract

• Contract - Text (50)
  • Must contain the contract number
• CI - Text (100)

• Cost – Text (50)

<Source Name=”LeaseContractsCIs”>
     <ConnectionString>Provider=Microsoft.Jet.OLEDB.4.0;Data Source=c:\\db1.mdb</ConnectionString>
     <ViewName>QueryOrViewNameHere</ViewName>	
     <Content>LeasedCI</Content>
</Source>

Incident Importation

• Issue - Text(500)
• Status
  • Must be a valid incident status.
• User
  • Must be the valid Windows username of an existing user.
• RequestedBy
  • Must be the valid Windows username of an existing user.

• IncidentNumber
  • This number will be prefixed to the subject of the incident.
• DetailedDescription - Text(5000)
  • Full description.
• Group
  • Specifies the group to which the incident will be assigned and therefore must be a valid group name to which the specified assignee has access.
• Assignee
  • Octopus user to whom the incident will be assigned. Must be a valid octopus username.
• Impact
  • Must be equal to the text value of an impact level. (ex : « 1 – High », « 2 – Medium », « 3 – Low »).
• Urgency
  • Must be equal to the text value of an urgency level. (ex : « 1 – High », « 2 – Medium », « 3 – Low »).
• Priority
  • Must be equal to the text value of a priority level (ex : « 1 – Urgent », « 2 – High », « 3 – Normal »).
• Category
  • Must be equal to the text value of an existing Octopus category.
• Subcategory
  • Must be equal to the text value of an existing Octopus subcategory.
• OpenDate
  • Indicates the opening date with the format YYYY-MM-DD HH :MM :SS.
• ResolutionDate
  • Indicates the resolution date with the format YYYY-MM-DD HH :MM :SS.
  • This date must be greater than the opening date.
• ClosureDate
  • Indicates the date at which the incident was closed with the format YYYY-MM-DD HH :MM :SS.
  • This date must be greater than the resolution date.
• OnHoldReason
  • Indicates the reason for which the incident has ben put in the status « On Hold ».
  • Must be equal to the text value of an exiting Ocotopus on hold reason.
• ResolutionDescription - Text(5000)
  • Required field when the incident has the status « Resolved ».
  • Represents the description of the resolution activity.
• ResolutionActivity
  • Required field when the incident has the status « Resolved ».
  • Represents the TYPE of the resolution activity.
• ClosureNote
  • Represents the closure note associated with an incident that has the status « Closed ».
• CI
  • Represents the CI in cause associated with the incident.
• Site
  • Site associated with the incident, if incident sites are required.
• ITService
  • IT service affected by the incident.

<Source Name="SourceName" >
     <ConnectionString>Provider=Microsoft.Jet.OLEDB.4.0;Data Source=c:\\db1.mdb</ConnectionString>
     <ViewName>NomDeVue</ViewName>
     <Content>Incident</Content>
</Source>