Skip to content

Integrity Gateway extension to load complete Documents from Excel files, for example for a data migration

Notifications You must be signed in to change notification settings

VEckardt/IntegrityCustomImport

Repository files navigation

IntegrityCustomImport

Integrity Gateway extension to create complete Integrity Lifecycle Manager Documents from Excel files. This tool provides a Java loader for Excel, directly linked into the Integrity Gateway.

Use Cases

  • Date migration from other Requirement tools via Excel into Integrity LM

Possible Import Layout

CustomImport

Important

  • Please try it out in a test environment first, NEVER go directly with this into production
  • This is NOT intended for a permanent use of Excel together with Integrity
  • Use the Standard Excel Integration instead (Integrity Add On, available from the PTC Software Download Page)

Tested with

  • Integrity Lifecycle Manager 10.6
  • Integrity Lifecycle Manager 10.8
  • Integrity Lifecycle Manager 10.9
  • Integrity Lifecycle Manager 11.0

Hints

  • It's possible to set the Document ID, then the loader will update an existing document in Integrity
    • But: be very careful, because the tool was not intended to offer this feature (even if it works like that)!
  • The column "External ID" is required. This is a reference column, allowing the loader to connect Excel Data rows with Integrity Data rows. Internally the "External ID" can be mapped to a different field if needed.
  • The column "Section" is required and has to have a value. The loader determines by counting the dots in the section field into which level the row has to be placed. It doesn't matter if the section number has any meaning (no need for gapless etc.)
  • If you want to gain from automated formatting of the headings, then the Category column must be placed before the Text column (this feature is under review)
  • If you upload into rich text fields, like into the Text, then declare this field accordingly in the mapping file. Otherwise the text may display html tags.
  • To add additional fields, add them at first into the mapping XML, and then you can use the external field name defined also in your Excel template.

Installation

  • Jar files must be installed locally, because the Integrity Gateway is a local application. This can be inside your Integrity client directory, but also outside if you don't have needed write access
  • Addition to the Gateway.lax is on client, pointing to the new libs above. This operation requires write access to your Integrity client directory. Gateway.lax is located in your Integrity client folder /bin.
  • XML mapping files can be copied on client or server
  • Addition to the gateway-tool-config.xml is on client or server
  • I am using the POI libraries for Excel handling. You can also use newer versions for sure.

File List (target):

bin/gateway.lax (addition only)
config/gateway/gateway-tool-configuration.xml  (addition only, can be placed on server)
config/gateway/mappings/Excel_Import_Requirement_Document.xml (new, can be placed on server)
config/gateway/mappings/Excel_Import_Test_Suite.xml (new, can be placed on server)
lib/IntegrityCustomImport.jar (new, from dist folder)
lib/IntegrityAPI.jar (new)
lib/dom4j-1.6.1.jar (new)
lib/xmlbeans-2.6.0.jar (new)
lib/poi-3.11-20141221.jar (new)
lib/poi-ooxml-3.11-20141221.jar (new)
lib/poi-ooxml-schemas-3.11-20141221.jar (new)
lib/mksapi.jar (!! use the existing in your installation !!)

Documentation

  • For detailed instructions, please review the provided documentation "doc/Technical_Documentation_Migrate_Documents_with_Excel.docx"

Related Solutions

About

Integrity Gateway extension to load complete Documents from Excel files, for example for a data migration

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages