Instance Configuration (WS)

Enable Protocol

Checkbox

Allows you to enable or disable the Protocol Writer.

Checked → Protocol Writer is enabled

Unchecked → Protocol Writer is disabled

Protocol Alias

Textbox

Allows you to configure an alias which will be used while logging requests via Protocol Writer.

Example: tia-ContentServer-Repo-FI

UseSecurity

Checkbox

Allows you to activate or deactivate security features.

Checked → Security features is enabled

Unchecked → Security features is disabled

Certificate

List

The selected certificate will be used to send signed HTTP requests to the configured Content Server.

PublicStoreAlias

Textbox

Configured alias in the keystopre will be used to verify signed text. Pa-rameter UseSecurity should be activated as well for this function.

PrivateStoreAlias

Textbox

Configured alias will be used to generate CSR.

serverinfo

Checkbox

Option indicates whether serverinfo-requests are to be forwarded to Content Server.

Checked → serverinfo-requests will be forwarded.

Unchecked → serverinfo-requests will not be forwarded.

create

Checkbox

Option indicates whether create-requests are to be forwarded to Content Server.

Checked → create-requests will be forwarded.

Unchecked → create-requests will not be forwarded.

delete

Checkbox

Option indicates whether delete-requests are to be forwarded to Content Server.

Checked → delete-requests will be forwarded.

Unchecked → delete-requests will not be forwarded.

get

Checkbox

Option indicates whether get-requests are to be forwarded to Content Server.

Checked → get-requests will be forwarded.

Unchecked → get-requests will not be forwarded.

getAll

Checkbox

Option indicates whether getAll-requests are to be forwarded to Content Server.

Checked → getAll-requests will be forwarded.

Unchecked → getAll-requests will not be forwarded.

CsrCN

Textbox

Option which specifies the Common Name (CN) attribute for the CSR request.

Example: neocortex.kgs-software.net

CsrOU

Textbox

Option which specifies the Organization Unit (OU) attribute for the CSR request.

Example: DevOps

CsrO

Textbox

Option which specifies the Organization (O) at-tribute for the CSR request.

Example: KGS Software

CsrL

Textbox

Option which specifies the Locality (L) attribute for the CSR request.

Example: Neu-Isenburg

CsrS

Textbox

Option which specifies the State (S) attribute for the CSR request.

Example: Hessen

CsrC

Textbox

Option which specifies the country (Country) at-tribute for the CSR request.

Example: Germany

CsrEmail

Textbox

Option which specifies e-mail attribute for the CSR request.

Example: devops-department.kgs-software.net

CNOverride

Textbox

Option which allows the instance to use another certificate according to the Common Name (CN). PublicStoreAlias should also be configured accordingly.

Example: If a certifi-cate with CN: neocortex.kgs-software.net is to be used for the application “NeoCortex”and the certificate is mapped against an alias “test”, PublicStoreAlias: test CNOverride: test

ActivatorConnection

List

In case you’re using Activator and defined Activator instances you may choose from the list of the Activator instances the instance, which serves your needs.

ContentServer URL

Textbox

Within this field you may enter the URL to the Content Server.

Example: http://localcontentserver-kgs-software.net/KGSAdmin-CS/contentserver

Repository

Textbox

Here you may enter the repository which will receive all requests.

Example: FI

HistoricalContentServer

Textbox

In case some of your documents are located on an old Content Server you may enter here the URL pointing to the former Content Server.

Example: http://local-old-contentserver-kgs-software.net/SAPALink/ContentServer

HistoricalRepository

Textbox

In case your scenario requires the usages of a historical content server and the documents had been stored historically in a different repository than the one specified in the Repository-field, you may enter the name of the former repository here.

Example: HR

Async Directory

Textbox

Documents received for the create requests will be stored at the directory specified by this option.

Example: /usr/local/asnyDir

AsyncData Prefix

Textbox

Documents received for the create requests will be stored with the speci-fied prefix at the directory specified by Async Directory.

Example: async_

Working Directory

Textbox

Working directory for the web services’ instance.

Example: /tmp/

HTTP Timeout

Textbox

Timeout (seconds) for HTTP requests sent to the tia Content Server(s).

Override Mime-Types

Checkbox

Option indicates whether a certain mime-type is to be used specified in MimeType Path

Checked → MimeType-Override activated.

Unchecked → MimeType-Override deactivated.

Start Automatically

Checkbox

Option indicates whether a Web Service instance shall be started atomatically if the web server or the Web Service application is restarted.

Checked → Instance will start automatically after restart.

Unchecked → Instance will not start automatically after restart.

DocIdCreate

Textbox

Indicates which format of Document ID (DOCID) is allowed. Document ID should always be between 32 and 40 characters. Special characters such as ü, ö, ä,+ are not allowed.

Examples:

• [A-Za-z0-9]+
  (allows alphanumeric characters)

• [A-Za-z0-9-]+
  (allows alphanu-meric and hypen (-) character)

• [A-Za-z0-9_]+
  (allows alphanumeric and underscore (_) character)

DocIdACreate

Textbox

Indicates which format of Document ID (DOCID) for asynchronous request is allowed. Doc-ument ID should always be between 32 and 40 characters. Special characters such as ü, ö, ä,+ are not allowed.

Examples:

• [A-Za-z0-9]+
  (allows alphanumeric characters)

• [A-Za-z0-9-]+
  (allows alphanumeric and hypen (-) character)

• [A-Za-z0-9_]+
  (allows alphanumeric and underscore (_) character)

DocIdDel

Textbox

Indicates which format of Document ID (DO-CID) for delete request is allowed. Special char-acters such as ü, ö, ä,+ are not allowed.

Examples:

• [A-Za-z0-9]+
  (allows alphanumeric characters)

• [A-Za-z0-9-]+
  (allows alphanumeric and hypen (-) character)

• [A-Za-z0-9_]+
  (allows alphanumeric and underscore (_) character)

DocIdGet

Textbox

Indicates which format of Document ID (DOCID) for get request is allowed. Special characters such as ü, ö, ä,+ are not allowed.

Examples:

• [A-Za-z0-9]+
  (allows alphanumeric characters)

• [A-Za-z0-9-]+
  (allows alphanumeric and hypen (-) character)

• [A-Za-z0-9_]+
  (allows alphanumeric and underscore (_) character)

DocIdInfo

Textbox

Indicates which format of Document ID (DOCID) for document info request is allowed. Special characters such as ü, ö, ä,+ are not allowed.

Examples:

• [A-Za-z0-9]+
  (allows alphanumeric characters)

• [A-Za-z0-9-]+
  (allows alphanumeric and hypen (-) character)

• [A-Za-z0-9_]+
  (allows alphanumeric and underscore (_) character)

IndexFileExtension

Textbox

Option which indicates if an (empty) index file should be created along with the data in the specified ‘Async Direc-tory’ for asynchronous requests.

Example: *.rdy