00197458-01_UG_EDM_V2.2_en - 第68页

EDM V2.2 / U ser Guid e Ausgabe 10/2013 E dition 68 6.2.6 System Configuration The perm itted k eys used ar e described in brief in T able 6-8 . T he individ ual entrie s are specif ied in detail s tar ting with sect ion…

EDM V2.2 / User Guide Ausgabe 10/2013 Edition

6.2.5 Role Configuration

The Role Configuration consists of a "<roles>" section containing a list of "<role>" entries. Each

entry has the following attributes:

● id: Id of the role

● line: Pattern to match against the 'Line-Alias' (or the Host-Name if no alias is configured)

● application: Pattern to match against the name of the EDM Application (e.g. EdmClient))

● spiUser: Pattern to match against the SIPLACE user name (currently always "System" as EDM

does not support any User Management).

● windowsUser: Pattern to match against the Windows user name running the EDM Application

(Note: the EDM service normally runs as "SYSTEM" user).

● lineServerRole: Pattern to match against the "server type" of the EDM Application

(e.g. "LINE")

● edmVersion: Pattern to match against the EDM version

● pattern: Specified the pattern matching algorithm to use. Supported values:

"regex" (or "regularexpression") to use Regular-Expressions.

"" (or omitting the attribute) to use simple case insensitive string comparison.

● index: used to define the priority of the roles (highest index => lowest priority).

The following rules apply:

1. The "id" of each entry must be unique.

2. Currently the recognized pattern value is "regex" (otherwise a case insensitive string

comparison is used).

3. The "pattern" attribute changes the comparison of all values.

4. The first match (by index) is used. This implies the "default" configuration has to have the

highest "index" otherwise all following entries are ignored.

5. If no matching entry is found the standard EDM Configuration

[ConfigDir]\EdmConfiguration.xml will be used.

6. The referenced configuration file has to exist and has to be a valid EdmConfigurationSet

(Otherwise the default EDM configuration file (see above) will be used - which could lead to

unexpected behaviour).

7. The path of the configuration file is relative to the EDM configuration directory (not to the

location of the role configuration file).

Sample Role-Config file:

<configurationInfo name=" Role mapping" version="2.0.0.0" comment="Sample"

type="Siemens.SiplacePro.EDM.Common.Configuration.RoleConfig" />

<roles>

<role id="NPI"

line="NPI-Line_.*"

application=""

configuration="Edm-NPI-Configuration.xml"

spiUser=""

windowsUser="EdmNpi"

lineServerRole=""

pattern="regex"

index="0" />

<!—- Fallback configuration for all other lines -->

<role id="Default" application="" line="" spiUser="" windowsUser=""

configuration="EdmConfiguration.xml" index="1" />

</roles>

</configuration>

EDM V2.2 / User Guide Ausgabe 10/2013 Edition

6.2.6 System Configuration

The permitted keys used are described in brief in Table 6-8. The individual entries are specified in

detail starting with section 6.2.6.1 (some values might not have a detailed description).

For purposes of legibility, abbreviations are used in the table. The abbreviations are explained in

Table 6-7.

Table entry Meaning

Enum Enumeration type. The ordinals valid for each key are shown in the

corresponding explanation.

String Character string

Boolean String value of "true" or "false"

Integer String value describing a number

Time Time specification in the format "

P0Y0M0DT0H15M0S

" (short form: "

PT15M"

)

Class .NET class in the format

[ClassName][,Assembly]

Path Windows path specification

File Windows file specification

Endpoint Communication endpoint. The exact format depends on the transfer protocol.

Section Subsection with several values. The entries valid for each key are shown in the

corresponding explanation.

C Valid for: Clearing Pool

L Valid for: Line Server

M Valid for: Master Server

T Valid for: EDM Tool

S Valid for: Configuration Server

F Valid for: Configuration Manager

P Valid for: Data Transfer Manager (Push)

All Valid for: All EDM Applications that use the configuration (short for CLMTSFP)

R Required

D Default value. Input is only necessary if a different setting is desired.

Table 6-7: Legend

EDM V2.2 / User Guide Ausgabe 10/2013 Edition

Example: The basic structure of the EDM SystemConfig.xml file

<!- - This is a comment - - >

</appSettings>

<! - - This is a configuration parameter of the type "Section" - ->

</endpointConfig>

<add key="

notificationDistributorConfiguratorClass"

value=

"Siemens.SiplacePro.EDM.UserInterface.EmailConfigurator,UserInterface" />

</configuration>

The keys and sections permitted are listed in the following table:

Key Format

(Default)

Type Contents

communicationTimeout Time

(PT10M)

All

Timeout for communication between

line and Master Server (6.2.6.16).

compressionType Enum

(Zip)

All

Compression for data transfer

(6.2.6.20).

DataTransferApiHttpPort Integer

(9006)

The HTTP Port of the EDM Data

Transfer (Push) API.

DataTransferApiTcpPort

Integer

(9005)

The TCP Port of the EDM Data

Transfer (Push) API.

edmToolEndPoint Endpoint L;M;T;P;R End point for messages to the EDM

tool (6.2.6.14).

EnableDataTransferApi Boolean

(true)

Activates/deativates the EDM Data

Transfer (Push) API

endpointConfig Section M;R Endpoint configuration for the

exchange of data (6.2.6.15).

helpDirectory Path All;D Path for help files (6.2.6.2).

incomingClearingPoolRequests Endpoint M;C;R Endpoint for incoming queries to the

Clearing Pool (6.2.6.13).

incomingNotifications Endpoint M;R Endpoint for incoming change

notifications to the master (6.2.6.12).

incomingRequests Endpoint M;R Endpoint for incoming queries to the

master (6.2.6.11).

masterNotifications Endpoint L;R Destination for change notifications

(6.2.6.10).

masterRequests Endpoint A;R Requests to the EDM Service (6.2.6.9).

masterServer String L;M;C;P;R Network identification of the Master

Server (6.2.6.7).

Endpoint

Key

Value

Class

Section

Time