DataImporter - Import Request Attached Files

Table of contents

Overview

This article presents the method to import attached files associated to incidents or service requests. 

NOTE: Importing attached files for hosted customers needs to be done from our servers or from a server available on the Web.
Please contact us for more information.

References

 

What you need to know:

The reference template files (.xlsx et .xml) to prepare imports are included in the Requests.zip file.

Requirements for importing files
To be able to import attached files, the following conditions must be met:

  • Files to be attached need to be located directly on your local server.
  • The service account for the Octopus server (normally Network Service) must have read access to the source folder containing the files to be imported.
  • The service account for the Octopus server (normally Network Service) must have full control to the attachment share.  If the attachment share is located on another server, you might have to temporarily configure the share allowing Everyone full control.

Required Fields

  • Number - Whole number
    • Represents the number of the request (incident or SR) associated to the activity
    • The number used can be the one from Octopus or the one from the source system, if requests were imported from another system
    • For more details, refer to the Request identification method section
  • Attachment - Text
    • Must contain the complete local path to find the file to attach
    • Example: C:\NameOfFolder\FileName.txt

Configuration File (XML)

The declaration of the source is done by indicating the IncidentAttachment value in the <Content> tag.

NOTE: The XML file used as this example is for an import done from Excel 2007 or 2010. To explain the tags used in all types and to find out more about the types of files, please refer to the XML Configuration File article
<?xml version="1.0" encoding="utf-8" ?>

<Sources>

   <Source Name="ImportIncidentAttachment">

      <ConnectionString> Provider=Microsoft.ACE.OLEDB.12.0; Data Source=c:\Import\RequetesTI.xlsx; Extended Properties="Excel 12.0 Xml;HDR=YES"; </ConnectionString>

      <ViewName>[ImportRequestAttachment$]</ViewName>

      <Content>IncidentAttachment</Content>

      <IncidentIdentificationMethod>ByImportedIncidentID</IncidentIdentificationMethod>

   </Source>

</Sources>

Information on Additional Tags

To import incident or SR attachments, the XML file can contain 1 additional tag. This tag is not mandatory and if it's not specified, the default value will be used. 

Request Identification Method

In the XML file to import request activities, it is possible to specify how the request will be found, either by the incident/SR number or by the imported request number.

Permitted values for the IncidentIdentificationMethod tag:

  • ByIncidentID: Octopus incident/SR number
  • ByImportedIncidentID (Default value): Imported source request number

Can be used when importing incidents from an external source and later import attachments, the system will use the number from the source system.

To use this tag, add the following line to the XML file:

<IncidentIdentificationMethod>VALUE</IncidentIdentificationMethod>
X
Help us improve our articles








Help us improve our articles