Installation Instructions for eDOCS Integration Solution

1. Check that eDOCS DM Server API is installed on the IIS Server and you can connect with DM Server through the DM Connection Wizard application, which is provided with the Open Text eDOCS suite.

2. Run the executable eDOCSIS_16_5_Setup to install the eDOCS IS windows service and then the executable setup_eDOCSIS16_5_AppTest to install the eDOCS IS testing application.

3. By default, the application requires that the xml license file and edocs.log file be placed in: C:\Program Files\Genetsis Solutions\eDOCS IS 16.5\GSLogs

However, this can be modified if the changes are reflected in the app.config.

Full installation instructions for Windows Services

eDOCS Integration Solution includes a testing application developed in *.net technology. This application is provided as an MIS package called eDOCSIS_16_5_Setup and it can be installed in any Windows 2012/2016/Windows 8/Windows 10 environments. The installation through an easy wizard guided installation process. Click “Next” in all steps.

Then, let windows services to verify that the windows service is also correctly working.

If eDOCS Integration Solution is installed on the eDOCS DM Server, it is necessary to verify that the services eDOCS IS 16.5 is running.

Configuration Instructions for eDOCS Integration Solution

If we change the location path by default (C:\Program Files\Genetsis Solutions\eDOCS IS 16.5) when we install the eDOCS Integration Solution, we have to change the properties path that belong to appSettings tag; defined in the file: GSWinService.exe.config.

You can change the usage log file by changing the key value LogEnabled False.

Through the Library Maintenance application, check that exists the query user belong to query_users group.

queryUserProfile

queryGroupProfile

The system.web property specifies the root element for the ASP.NET configuration section and contains configuration elements that configure ASP.NET Web applications and control how the applications behave.

SYSTEM-WEB

The maxRequestLength property is used for specifying file upload size.

The maxQueryStringLength property defines the maximum length of the query string, in number of characters.

Basic configuration file to connect with eDOCS IS Services

WCF allow us to give multiple base addresses for each type of protocol.  And at the run time corresponding endpoint will take the base address.

If we do not want to explicitly set address for each EndPoint in our service then we define BASE ADDRESS for the EndPoint exposed for our service. You can change and modify the base address using the suitable structure under baseAddresses/host/ service.

You can use the config file to customize the binding used by the endpoint. Too, add the bindingConfiguration tag to the endpoint section, and name a customized section in the bindings section of the config file.

Bindings parameters

Specify one or more of the system-provided binding elements, for example,

The values maxBufferSize and maxReceivedMessageSize must be the same value.

The value messageEncoding must be MTOM, because is a mechanism for transmitting large binary attachments with SOAP messages as raw bytes.

eDOCS IS TESTING APPLICATION

Installation Instructions for eDOCS Integration Solution – Testing Application

eDOCS Integration Solution includes a testing application developed in *.net technology. This application is provided as an MSI package called setup_eDOCSIS16_5_AppTest and it can be installed in any Windows 2012/2016/Windows 8/Windows 10 environments. The installation through an easy wizard guided installation process. Click “Next” in all steps.

At the end of the installation process the eDOCS Integration Service folder will be created in the Start menu with 1 shortcut inside: eDOCIS Test App (shortcut to launch the Testing Application).

Testing Application Configuration

The testing application interface has two clearly separated areas:

  • Paramaters area: It includes several method tabs. Each one includes the field parameters needed to test the method.
  • Results area: In the bottom panel we can review the data returned by the method we are testing.

It is possible to save the connection parameters to reuse them in future sessions. Click on the  “Save settings” button to do that.

The connection parameters are saved in the “demo.ini” file, which can be accessed through the installation path. By default:

C:\Program Files\Genetsis Solutions\eDOCS IS – Testing App

The testing application interface is divided by the following parameters:

  • URI: Define base address for the endpoint exposed for our service.
  • Binding: Specifies a list of binding elements. By default, it is selected basicHttpBinding.
  • DM User: eDOCS user name.
  • Dm Password: password.
  • Dm Library: eDOCS library.
  • Default Form: It is the form used to profile documents into DM. It is needed in some methods.
  • Search Form: It is the form used to search into DM. It shouldn’t be the same as Default Form.
  • DB Schema: The SQL Server security schema of the DM Library. By default, ‘DOCSADM’.
  • Client: Optional parameter for the client code.
  • Project: Optional parameter for the project code.

Testing Application Tabs

Advanced Search Tab

On this tab it is possible to test searches based on profile properties. Following options are available:

  • Search form: The name of the form to be used in the search (this field is placed on the Configuration Tab).
  • Search criteria: The field used to provide the profile properties to be used in the document search.
  • Limit: The number of rows returned can be limited here. To do that, check on “Show only” checkbox and then select the number of records to be.
  • Return properties: If only some profile properties are needed, it is possible to improve the searching process by checking on the “Return only extra properties” radio button. Write the properties in “Extra properties” textbox.
  • Ordering: By default, the search results are ordered by the LAST_EDIT_DATE The most recent items appear first. However, it’s possible to use other field to change the order criteria. The new property used to order results must be one of the properties returned by the search.
  • Trustee Criteria: Used to set an additional filter by user or group:
    • In “Type”, we select the security entity to be used: user or
    • In “User or Group ID”, we set the DM user’s (or group)
    • In “Access Rights”, we can set the minimum access level that must have a user or group. By default, this value is set to 1.

Once the search parameters have been completed, the search can be executed by clicking  “Search” button. After search is completed the Results Window will display an XML file with all the results.

For more information about this method, see Advanced Search

Security Tab

On the Security tab, it is possible to test a method related with DM security, Document Trustees List.

This method provides information about which users and groups are associated with a document and what permissions they have on the document (Access Control List).


Docnumber
is a mandatory parameter. It is possible to retrieve the ACL for a set of documents. Use the semicolon (;) as separator for different document numbers. By clicking on “Get List” button we obtain an XML file with the ACL for each document.

Folder Tab

This method can be used to test folder creation.

To create a new folder, all mandatory properties must be written in “Folder Properties” textbox. APP_ID y TYPE_ID properties are automatically added with “FOLDER” value, so it is not necessary to write these values. The following example is valid for the legal standardlibrary.

Notes:

  • An easy way to know which properties must be provided is to force an error using a dummy string like “xxx, xxx” and looking at the results window. We will receive an error like that:
    ServerName: Not all required values supplied:  Property=DOCNAME:Property=AUTHOR_ID:…etc.
  • Some extra values such “Default Form”, “User”, etc., are required to create a folder. They must be completed in the configuration Tab.

For more information about this method, see Create Folder

Document Info Tab

On the “Document Info” tab, we can get the size of a document and the versions of a given document.

Document Size

Parameters:

  • Docnumber: Docnumber.
  • Versión Label: Version label(1, 2, 2A,2B, 3, 3A …).

For more information about this method, see GetDocumentSize

Get Folder Content Tab

It allows to retrieve information about documents and subfolders included in a specified root folder considering the access security level of the user sent as parameter.

By default only DISPLAYNAME and DOCNUMBER properties are included into the XML  file.

It is mandatory to provide the Root Document (Folder) number we want to retrieve content. We can combine different search options:

  • Check Show Trustees option: To include the ACL list in the returned.
  • Check Show Versions option: To include the versions of each returned.
  • Check Show Only Folders: To include only subfolders in the returned XML (if exists).
  • Check Show Extra Info: To include LAST_ACCESS_FULL_NAME and LAST_EDIT_FULL_NAME properties in the returned XML.
  • Levels Limit: Use this parameter to control the deep of the subfoldering search process. Use “0” for no.
  • Return Properties: We can add properties here to be included into the returned XML file such as:   …etc
  • Order by Properties: It is possible to order results based on the Return Properties. The order affects documents and folders as well.

For more information about this method, see Get Folder Content

Upload Document As Binary Tab

It is used to upload a new document to eDOCS into the library where the content is provided in Base64Binary.

For more information about this method, see Upload Document As Binary