Semeion Archive API for Windows

Connects your core business and back-office (e.g. MS-Office) applications to Semeion Archive.
The electronic documents are the lifeblood of the modern business. Some organizations take all too often totally for granted. Document Management has long been ignored by too many of them. This is changing very fast. Our customers are implementing Semeion, a robust document management software solution in orderto deliver real results and knowledge in the daily work. Semeion and its Intelligent Document Discovery module allow a semantic analysis of the document contents and provide the best search results ever.

Introduction

To test Semeion Archive API, you might have an account on semeion-demo.com or your own instance of Semeion Archive. Please register to test.

Semeion Archive API is a set of functions written in .NET (framework 4.0 is required) which will allow you saving your documents in Semeion Archive.

API Download

Follow the link below to download the Semeion Archive API for MS-Windows.

DownloadNow

To install the API, extract the content of the zip file to a temporary folder. Then please run first the 'setup.exe' file.

To test the API, run the Microsoft Excel Spreadsheet named "Test Archive DLL.xlsm". Make sure that the macros are activated (no risk for your computer),

You can access to the source code by pressing ALT+F11. Have a look and see how the implementation is simple.

API User Manual

This section provide information about the Semeion Archive API for MS-Windows. Please contact our support team via email if you have questions or if you are facing some problems while integrating this product in your applications.

List of Functions

Connect(url, userName, password)

Parameters

  • url: string
  • userName: string
  • password: string

Description

  • Connects to the Archive and validates provided credentials

Returns

  • Token: string: as Guid

Error Codes

  • 403: Access Denied
  • 404: Connection Error
  • 500: Internal Server Error

Disconnect(url, token)

Parameters

  • url: string
  • token: string

Description

  • Disconnects from the Archive

Returns

  • Nothing

Error Codes

  • 201: Session does not Exist
  • 202: Session Expired
  • 404: Connection Error
  • 500: Internal Server Error

GetDocumentTypes(url, token)

Parameters

  • url: string
  • token: string

Description

  • Connects to the Archive and returns all available document types

Returns

  • DocumentTypes: string(): array of DocumentType names

Error Codes

  • 200: Session Already Exists
  • 201: Session does not Exist
  • 202: Session Expired
  • 404: Connection Error
  • 500: Internal Server Error

FindAttributeTypes(url, token, documentType)

Parameters

  • url: string
  • token: string
  • documentType: string: DocumentType name

Description

  • Connects to the Archive and returns all available attribute types for specified document types

Returns

  • AttributeTypes: string(): array of AttributeType names

Error Codes

  • 200: Session Already Exists
  • 201: Session does not Exist
  • 202: Session Expired
  • 203: No rights for DocumentType
  • 204: DocumentType does not Exist
  • 404: Connection Error
  • 500: Internal Server Error

NewDocumentSet(url, token, name, filePath, documentType, labels, attributesValues, versionToIncrement)

Parameters

  • url: string
  • token: string
  • name: string: DocumentSet name
  • filePath: string: filePath of the current opened file
  • documentType: string: DocumentType name
  • labels: string(): array of label names
  • attributeValues: string(): array of key-value pairs (for instance: “Attr1=Value1”)
  • roles: string() – array of key-value pairs for specifying the permission (for instance: “roleName=roleValue”, where roleValue is an integer which defines an access (1 – Read, 3 – Read & Write))
  • versionToIncrement: string: available types: “Major”, “Minor” or “Update”

Description

  • Connects to the Archive and archives the document

Returns

  • Nothing

Error Codes

  • 200: Session Already Exists
  • 201: Session does not Exist
  • 202: Session Expired
  • 203: No rights for DocumentType
  • 204: DocumentType does not Exist
  • 208: Required attribute is missing
  • 404: Connection Error
  • 500: Internal Server Error

GetDocuments(url, token, query)

Parameters

  • url: string
  • token: string
  • query: string – for instance: “user: smith #”Doc Group” type:SALI ”

Description

  • Connects to the Archive and returns all documents filtered by search query based on user permission

Returns

  • Documents: string(), array of document names

Error Codes

  • 200: Session Already Exists
  • 201: Session does not Exist
  • 202: Session Expired
  • 404: Connection Error
  • 500: Internal Server Error

SaveDocument(url, token, documentName, documentTypeName, localFilePath)

Parameters

  • url: string
  • token: string
  • documentName: string
  • documentTypeName: string
  • localFilePath: string – if not set, My Documents folder is used a destination root

Description

  • Connects to the Archive and save the document into location specified by localFilePath parameter.

Returns

  • Nothing

Error Codes

  • 200: Session Already Exists
  • 201: Session does not Exist
  • 202: Session Expired
  • 203: No rights for DocumentType
  • 204: DocumentType does not Exist
  • 300: Directory does not Exists
  • 301: File already Exists
  • 302: Unspecified IO Error
  • 404: Connection Error
  • 500: Internal Server Error