00197458-01_UG_EDM_V2.2_en.pdf - 第67页

EDM V2.2 / U ser Guid e Ausgabe 10/2013 E dition 67 6.2.5 Role Configuration The Role Configurati on con sists of a "< roles >" section containi ng a list of "< role >" entries . Each entr…

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

6.2.3 Comment Categories

All entries consist of a value and an optional index (used to determine the display order)

A comment category entry has to fulfil these criteria:

1. It must be unique

2. It should not be empty or consist of only whitespace characters (spaces tabs etc.)

3. Its value should not contain new lines.

A sample Comment-Config file:

<configurationInfo name="Comment categories" comment="Sample" version="2.0.0.0"

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

</commentCategories>

</configuration>

6.2.4 Request Configuration

All entries consist of a name (key) and a value:

There is one entry for each of the services provided by the Master Server. These settings should

only be changed by the developer since they depend on the implementation of the Master Server,

and improper settings can affect the integrity and operation of the system as a whole.

A request command entry has to fulfil these criteria:

1. The key must be unique

2. The key cannot be empty or consist of only whitespace characters (spaces tabs etc.)

3. The key cannot contain new lines

4. The value should point to an existing class

5. The value has to point to a class that can be loaded by EDM (.Net Framework ≤ 4.0; x86)

Sample excerpt from a Request-Config file:

<configurationInfo name="Request Sample" comment="Demo" version="2.0.0.0"

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

<add key="objectData"

value="Siemens.SiplacePro.EDM.DataExchange.Commands.RequestDataCommand,DataExchange" />

</requestCommandConfig>

</configuration>

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