DRAWbridge for Webtop - Configuration Guide

Transcription

DRAWbridge
For Documentum Webtop,
Configuration Guide,
July 2012
Integrates CAD drawings within a
Documentum repository.
`
1
DRAWbridge for Webtop
July 2012
Page 1
Table of Contents
1
About this guide ..................................................................................................................................... 4
1.1
Organization of the manual ........................................................................................................... 4
1.2
Conventions ................................................................................................................................... 4
1.3
Intended Audience ......................................................................................................................... 4
1.4
Associated Documents ................................................................................................................... 4
2
DRAWbridge Configuration .................................................................................................................... 5
2.1
Overview ........................................................................................................................................ 5
2.2
XML Rules....................................................................................................................................... 6
3
2.2.1
DRAWbridge ........................................................................................................................... 6
2.2.2
Formats .................................................................................................................................. 6
2.2.3
Format .................................................................................................................................... 6
2.2.4
AutoCAD ................................................................................................................................. 6
2.2.5
MicroStation........................................................................................................................... 7
2.2.6
SmartSketch ........................................................................................................................... 7
2.2.7
IrasB ....................................................................................................................................... 7
2.2.8
Native ..................................................................................................................................... 7
2.2.9
Raster ..................................................................................................................................... 8
2.2.10
Block ....................................................................................................................................... 8
2.2.11
Cell ......................................................................................................................................... 8
2.2.12
Symbol ................................................................................................................................... 9
Title Block Update Configuration ......................................................................................................... 10
3.1
Overview ...................................................................................................................................... 10
2
July 2012
Page 2
3.2
XML Rules..................................................................................................................................... 12
3.2.1
BLCbridge ............................................................................................................................. 12
3.2.2
Formats ................................................................................................................................ 12
3.2.3
Definition ............................................................................................................................. 12
3.2.4
“Package Name”................................................................................................................... 12
3.2.5
Blocks ................................................................................................................................... 13
3.2.6
Block ..................................................................................................................................... 13
3.2.7
General ................................................................................................................................. 13
3.2.8
DocumentType ..................................................................................................................... 13
3.2.9
Attribute ............................................................................................................................... 15
3.2.10
DQL....................................................................................................................................... 17
Appendix A.
Format Qualifiers ................................................................................................................. 18
I.
Date / Time Formats ........................................................................................................................ 18
II.
Numeric Formats ............................................................................................................................. 20
3
July 2012
Page 3
1
About this guide
1.1 Organization of the manual
This document describes how to configure DRAWbridge.
This includes:
DRAWbridge Configuration.
Title Block/Properties Update Configuration


1.2 Conventions
Indicates a tip
Indicates a warning
Indicates a Mandatory warning
[…]
<root_dir>
Courier Text
Indicates a note
The values between brackets are optional
replace with real values
shows an example for the usage of the describe element/ attributes
1.3 Intended Audience
This document is intended for use by Administrators who are setting up and configuring
DRAWbridge.
1.4 Associated Documents
The following documents should be read / available in conjunction with this document.
Document Tile
Version
Date
4
July 2012
Page 4
2
DRAWbridge Configuration
2.1 Overview
It is necessary, to obtain the best performances possible, that DRAWbridge does not process
documents that can’t have references. e.g. Microsoft Office documents, are not processed by
DRAWbridge when manipulating them.
All settings related to DRAWbridge are stored in the Repository in: /System/BTM Software
Europe/DRAWbridge/DRAWbridge_xml
When editing the XML configuration sheet, the associated DTD schema must be at the
same location than the XML file. The DTD schema can be found in /System/BTM Software
Europe/DRAWbridge/DRAWbridge_dtd. It is therefore recommended to check it out with the
XML configuration sheet.
In order for the DRAWbridge caching mechanism to function properly, it is very important
to ALWAYS check any XML configuration file as a new version.
Also to ensure the validity of information passed to the CAD packages supported, e.g.:
ensuring that a DGN is returned when attaching a reference file and no other format, a
section of the XML configuration sheet is dedicated to each CAD package supported. This
section allows defining what formats are native to the CAD package for referencing, Raster
formats supported for raster referencing. All formats not defined in this section can be
associated to another document but not as a native (raster) reference or xRef.
5
July 2012
Page 5
2.2 XML Rules
This section describes the rules applied to the DRAWbridge XML configuration sheet.
The XML technology is case sensitive therefore; make sure to follow the XML rules as
defined below.
2.2.1 DRAWbridge
Quantity
exactly once
Description
Root-element of the XML-file.
Parent Element(s) N/A
Child Element(s) Formats, AutoCAD, MicroStation, SmartSketch, IrasB
Attributes
N/A
<DRAWbridge> ... </DRAWbridge>
Example
2.2.2 Formats
Quantity
Description
Parent Element(s)
Child Element(s)
Attributes
Example
exactly once
Root-element for the definition of supported formats
DRAWbridge
Format
N/A
<Formats> ... </Formats>
2.2.3 Format
Quantity
Description
Parent Element(s)
Child Element(s)
Attributes
Example
Zero or more
Definition of a format to be supported
Formats, Native, Raster, IrasB, Block, Cell, Symbol
N/A
Documentum_Format: (single, required) Name of the format
<Format Documentum_Format=”ustn”/>
2.2.4 AutoCAD
Quantity
Description
Parent Element(s)
Child Element(s)
Attributes
Example
Zero or One
Definition of a formats to be supported in AutoCAD
DRAWbridge
Native, Raster, Block
N/A
<AutoCAD> ... </AutoCAD>
6
July 2012
Page 6
2.2.5 MicroStation
Quantity
Zero or One
Description
Definition of a formats to be supported in MicroStation
Parent Element(s) DRAWbridge
Child Element(s) Native, Raster, Cell
Attributes
N/A
<MicroStation> ... </MicroStation>
Example
2.2.6 SmartSketch
Quantity
Zero or One
Description
Definition of a formats to be supported in SmartSketch
Parent Element(s) DRAWbridge
Child Element(s) Native, Raster, Symbol
Attributes
N/A
<SmartSketch> ... </SmartSketch>
Example
2.2.7 IrasB
Quantity
Description
Parent Element(s)
Child Element(s)
Attributes
Example
Comments
2.2.8 Native
Quantity
Description
Parent Element(s)
Child Element(s)
Attributes
Example
Zero or One
Definition of a formats to be supported in IRAS/B
DRAWbridge
Format
N/A
<IrasB> ... </IrasB>
Formats defined in this section can also be defined in the Raster
section of the MicroStation configuration since IRAS/B also handles
raster reference file attachments.
Zero or One
Definition of a native formats to be supported
AutoCAD, MicroStation, SmartSketch
Format
N/A
<Native> ... </Native>
7
July 2012
Page 7
2.2.9 Raster
Quantity
Description
Zero or One
Definition of a raster formats to be supported by the calling
application
Parent Element(s) AutoCAD, MicroStation, SmartSketch
Child Element(s) Format
Attributes
N/A
<Raster> ... </Raster>
Example
2.2.10 Block1
Quantity
Description
Zero or One
Definition of formats to be supported when inserting a block from the
repository in AutoCAD
Parent Element(s) AutoCAD
Attributes
N/A
<Block>
Example
<Format Documentum_Format="acad" />
</Block>
2.2.11 Cell2
Quantity
Description
Zero or One
Definition of the cell library formats to be attached from the
repository into MicroStation
Parent Element(s) MicroStation
Attributes
N/A
< Cell>
Example
<Format Documentum_Format="cel" />
</Cell>
1
2
New in version 2.7
New in version 2.7
8
July 2012
Page 8
2.2.12 Symbol1
Quantity
Description
Zero or One
Definition of a raster formats to be supported by the calling
application
Parent Element(s) SmartSketch
Attributes
N/A
<Symbol>
Example
<Format Documentum_Format="symbol" />
</Symbol>
1
New in version 2.7
9
July 2012
Page 9
3
Title Block Update Configuration
3.1 Overview
The title block synchronisation in DRAWbridge is a 2 way process. A user can update the title
block within the CAD document from its repository properties or update the repository
properties from the drawing’s title block.
Due to the many different ways of handling dates and booleans, updating the repository
properties of a document from its title block is only effective on integers, doubles and strings.
The title block configuration is done in a separate XML configuration sheet because it is the
same configuration used by BLCbridge 1
DRAWbridge can handle two different types of Property Mappings:
Type specific mappings. Those mappings apply ONLY to the given object type.
High level mappings applying to dm_document objects and sub-types. Obviously, no
other than dm_document properties should be defined in this section.


Those mappings are defined per application (CAD package) and can be different per
packages.
All settings related to the title block update are stored in the Docbase in:
/System/BTM Software Europe/BLCbridge/BLCbridge_xml
When editing the XML configuration sheet, the associated DTD schema must be at the
same location than the XML file. The DTD schema can be found in /System/BTM Software
Europe/BLCbridge/BLCbridge_dtd. It is therefore recommended to check it out with the XML
configuration sheet.
1
BLCbridge is a BTM Software product that ensures effective synchronisation of the attributes
of CAD-files as they are stored in the Documentum Repository with their attribute values
stored in the title block of the drawing.
10
July 2012
Page 10
In order for the DRAWbridge caching mechanism to function properly, it is very important
to ALWAYS check any XML configuration file as a new version.
On setting up the property mappings, the following rules have to be followed:



The Target of the mapping is the name of the custom document property.
The Source of the mappings is the name of the Documentum attribute.
The Targets have to be unique for the document type independent mapping, as well as
in each document type specific mapping.
If a Target is defined in the independent mappings and in the specific mappings for a
document type, the definition of the specific mapping overrides the independent mapping for
this single document type.

If wildcards are to be used, define these mappings using wildcards at the end of the
independent / document type specific mappings.
Wildcards in a Source can only be used, if a wildcard is also used in the Target.
There can only be 1 wildcard in a definition.
11
July 2012
Page 11
3.2 XML Rules
3.2.1 BLCbridge
Quantity
Description
Parent Element(s)
Child Element(s)
Attributes
Example
exactly once
Root-element of the XML-file.
N/A
Formats, “Package Name”
N/A
<BLCbridge> ... </BLCbridge>
3.2.2 Formats
Quantity
Description
Parent Element(s)
Child Element(s)
Attributes
Example
exactly once
Root-element of the packages definitions
BLCbridge
Definition
N/A
<Formats> ... </Formats>
3.2.3 Definition
Quantity
Description
Parent Element(s)
Child Element(s)
Attributes
Example
One or more
Definition of a format to be supported by the application
Formats
N/A
DctmFormat (single, required): defines the Documentum format to be associated
with a package
Package (single, required): defines the package (attribute mapping definition) to
be used for the given Documentum format. Valid values are AutoCAD,
MicroStation and SmartSketch
<Definition DctmFormat="SmartSketch" Package="SmartSketch"/>
3.2.4 “Package Name”
Quantity
One or more
Description
Definition of the attribute mapping for the file’s custom properties
Parent Element(s) BLCbridge
Child Element(s) Blocks, General, DocumentType
Attributes
N/A
Example
12
July 2012
Page 12
3.2.5 Blocks1
Quantity
Description
Zero or 1
Defines the list of AutoCAD blocks supported for the title block
synchronization (both ways)
If not defined the synchronisation will process ALL blocks
Parent Element(s) “Package Name”
Child Element(s) Block
Attributes
N/A
<Blocks> ... </Blocks>
Example
3.2.6 Block
Quantity
Description
Parent Element(s)
Child Element(s)
Attributes
Example
3.2.7 General
Quantity
Description
Parent Element(s)
Child Element(s)
Attributes
Example
One or more
Defines a block to be used in the title block synchronisation in
AutoCAD
Blocks
N/A
N/A
<AutoCAD>
<Blocks>
<Block Name="My Block 1" />
<Block Name="my other block" />
</Blocks>
...
</AutoCAD>
Exactly One
Root element for the document type independent mappings
“Package Name”
Attribute
AuditTrail (single, required): Not used by DRAWbridge2. Valid
values are True or False
<General> ... </General>
3.2.8 DocumentType
Quantity
Zero or more
Description
Root element for a document type specific mapping.
1
AutoCAD only
This attribute is however used by BLCbridge with which DRAWbridge shares this XML
configuration sheet
2
13
July 2012
Page 13
Parent Element(s) “Package Name”
Child Element(s) Attribute
Name (single, required): Name of the document type
Attributes
Example
AuditTrail (single, required): Not used by DRAWbridge. Valid values
are True or False
14
July 2012
Page 14
3.2.9 Attribute
Quantity
Description
Parent Element(s)
Child Element(s)
Zero or more
Definition of a property mapping.
General, DocumentType
DQL
Target (single, required): Name custom document property.
Source (single, required): Name of the Documentum attribute or
special source. Special sources are:
 xBlank – An empty string will be written to the custom
document property.
 xLifecycleState – The name of the current lifecycle state of
the document will be written to the custom document
property
 xLifecycleName – The name of the current lifecycle of the
document will be written to the custom document property
 xDocBase – The name of the Docbase, in which the
document is stored is written to the custom document
property
 xFolderpath – The (first) folder path of the document is
written to the custom document property
Attributes
RepeatingIndex (single, optional): Defines, which value of the
repeating attribute should be used. Possible values are:
 None – used for single attributes
 First – for the first value of the repeating attribute
 Last – for the last value of the repeating attribute
 All – for all values of the repeating attribute (comma
separated)
Value (single, optional): If Value is set to a not empty string, this
string will be written as fixed value to the custom document property
Format (single, optional): Format definition, which should be used to
display the value (e.g. for date values). A description of the format
description features can be found in Appendix A Format Qualifiers of
this document.
useMappedValue (single, optional): If set to True, DRAWbridge will
ALWAYS used the value mappings instead of the stored value,
meaning that if it is set to true but no mappings are defined, the
return will ALWAYS be an empty string.
15
July 2012
Page 15
Example
Direction (String, Optional): Defines if the title block or the
Documentum properties are to be modified.
Valid values are
 All – Attribute definition used both for updating the title block
and updating the properties. This is the default behaviour if
the Direction attribute not defined.
 Title – The attribute definition is used ONLY when updating
the title block
 Meta – The attribute definition is used ONLY when updating
the document’s properties from the title block
<Attribute
Target=”dctm_object_name”
..Source=”object_name” Direction=”Title” />
<Attribute
Target=”dctm_version”
Source=”r_version_label”
RepeatingIndex=”First”/>
<Attribute
Target=”Status”
Source=”xLifecycleState”/>
<Attribute
useMappedValue=”True”
Target=”Discipline”
Source=”discipline_code” Direction=”Meta” />
<Attribute
Target=”dctm_creation_date”
Source=”r_creation_date”
Format=”dd-mmm-yyyy”/>
16
July 2012
Page 16
3.2.10 DQL
Quantity
Exactly once
Definition of the DQL statement to be executed to retrieve values from other
Description
objects than the document being processed.
Parent Element(s) Attribute
Child Element(s) N/A
Type (String, Required): Object type to be queried
Attributes
Property (String, Required): Specifies the attribute to be returned by the DQL
statement.
Clause (String, Required): Specifies the WHERE statement.
Example
<Attribute Target="OWNER_EMAIL" Source="xDQL">
<DQL
Type="dm_user"
Property="user_address"
Clause="user_name='$value(owner_name)'"
/>
</Attribute>
Note the usage of the (only) keyword allowed: $value(<property_name>). Using this
keyword will fetch the value of the property for the document being processed, to be used in
the DQL statement as demonstrated in the example above.
17
July 2012
Page 17
Appendix A.
I.
Format Qualifiers
Date / Time Formats
The following table identifies characters you can use to create user-defined date/time formats:
Character
(:)
(/)
c
d
dd
ddd
dddd
ddddd
dddddd
w
ww
m
mm
mmm
mmmm
q
y
yy
yyyy
h
Description
Time separator. In some locales, other characters may be used to represent the time
separator. The time separator separates hours, minutes, and seconds when time values
are formatted. The actual character used as the time separator in formatted output is
determined by your system settings.
Date separator. In some locales, other characters may be used to represent the date
separator. The date separator separates the day, month, and year when date values are
formatted. The actual character used as the date separator in formatted output is
Display the date as ddddd and display the time as ttttt, in that order. Display only date
information if there is no fractional part to the date serial number; display only time
information if there is no integer portion.
Display the day as a number without a leading zero (1 – 31).
Display the day as a number with a leading zero (01 – 31).
Display the day as an abbreviation (Sun – Sat).
Display the day as a full name (Sunday – Saturday).
Display the date as a complete date (including day, month, and year), formatted
according to your system's short date format setting. The default short date format is
m/d/yy.
Display a date serial number as a complete date (including day, month, and year)
formatted according to the long date setting recognized by your system. The default long
date format is mmmm dd, yyyy.
Display the day of the week as a number (1 for Sunday through 7 for Saturday).
Display the week of the year as a number (1 – 54).
Display the month as a number without a leading zero (1 – 12). If m immediately follows h
or hh, the minute rather than the month is displayed.
Display the month as a number with a leading zero (01 – 12). If m immediately follows h
or hh, the minute rather than the month is displayed.
Display the month as an abbreviation (Jan – Dec).
Display the month as a full month name (January – December).
Display the quarter of the year as a number (1 – 4).
Display the day of the year as a number (1 – 366).
Display the year as a 2-digit number (00 – 99).
Display the year as a 4-digit number (100 – 9999).
Display the hour as a number without leading zeros (0 – 23).
18
July 2012
Page 18
Character
Hh
N
Nn
S
Ss
ttttt
AM/PM
am/pm
A/P
a/p
AMPM
Description
Display the hour as a number with leading zeros (00 – 23).
Display the minute as a number without leading zeros (0 – 59).
Display the minute as a number with leading zeros (00 – 59).
Display the second as a number without leading zeros (0 – 59).
Display the second as a number with leading zeros (00 – 59).
Display a time as a complete time (including hour, minute, and second), formatted using
the time separator defined by the time format recognized by your system. A leading zero
is displayed if the leading zero option is selected and the time is before 10:00 A.M. or
P.M. The default time format is h:mm:ss.
Use the 12-hour clock and display an uppercase AM with any hour before noon; display
an uppercase PM with any hour between noon and 11:59 P.M.
Use the 12-hour clock and display a lowercase AM with any hour before noon; display a
lowercase PM with any hour between noon and 11:59 P.M.
Use the 12-hour clock and display an uppercase A with any hour before noon; display an
uppercase P with any hour between noon and 11:59 P.M.
Use the 12-hour clock and display a lowercase A with any hour before noon; display a
lowercase P with any hour between noon and 11:59 P.M.
Use the 12-hour clock and display the AM string literal as defined by your system with
any hour before noon; display the PM string literal as defined by your system with any
hour between noon and 11:59 P.M. AMPM can be either uppercase or lowercase, but the
case of the string displayed matches the string as defined by your system settings. The
default format is AM/PM.
Examples:
Format string
dd.mm.yyyy
dd. mmm yyyy
dd. mmmm yyyy Hh:Nn
Output
28.04.2003
28. Apr 2003
28. April 2003 16:53
19
July 2012
Page 19
II.
Numeric Formats
Character
None
(0)
(#)
(.)
(%)
(,)
Description
Display the number with no formatting.
Digit placeholder. Display a digit or a zero. If the expression has a digit in the position
where the 0 appears in the format string, display it; otherwise, display a zero in that
position. If the number has fewer digits than there are zeros (on either side of the
decimal) in the format expression, display leading or trailing zeros. If the number has
more digits to the right of the decimal separator than there are zeros to the right of the
decimal separator in the format expression, round the number to as many decimal
places as there are zeros. If the number has more digits to the left of the decimal
separator than there are zeros to the left of the decimal separator in the format
expression, display the extra digits without modification.
Digit placeholder. Display a digit or nothing. If the expression has a digit in the position
where the # appears in the format string, display it; otherwise, display nothing in that
position. This symbol works like the 0 digit placeholder, except that leading and trailing
zeros aren't displayed if the number has the same or fewer digits than there are #
characters on either side of the decimal separator in the format expression.
Decimal placeholder. In some locales, a comma is used as the decimal separator. The
decimal placeholder determines how many digits are displayed to the left and right of
the decimal separator. If the format expression contains only number signs to the left
of this symbol, numbers smaller than 1 begin with a decimal separator. To display a
leading zero displayed with fractional numbers, use 0 as the first digit placeholder to
the left of the decimal separator. The actual character used as a decimal placeholder
in the formatted output depends on the Number Format recognized by your system.
Percentage placeholder. The expression is multiplied by 100. The percent character
(%) is inserted in the position where it appears in the format string.
Thousand separator. In some locales, a period is used as a thousand separator. The
thousand separator separates thousands from hundreds within a number that has four
or more places to the left of the decimal separator. Standard use of the thousand
separator is specified if the format contains a thousand separator surrounded by digit
placeholders (0 or #). Two adjacent thousand separators or a thousand separator
immediately to the left of the decimal separator (whether or not a decimal is specified)
means "scale the number by dividing it by 1000, rounding as needed." For example,
you can use the format string "##0,," to represent 100 million as 100. Numbers smaller
than 1 million are displayed as 0. Two adjacent thousand separators in any position
other than immediately to the left of the decimal separator are treated simply as
specifying the use of a thousand separator. The actual character used as the
thousand separator in the formatted output depends on the Number Format
recognized by your system.
20
July 2012
Page 20
Character
(:)
(/)
(E- E+ e- e+)
-+$()
(\)
("ABC")
Description
Time separator. In some locales, other characters may be used to represent the time
separator. The time separator separates hours, minutes, and seconds when time
values are formatted. The actual character used as the time separator in formatted
output is determined by your system settings.
Date separator. In some locales, other characters may be used to represent the date
separator. The date separator separates the day, month, and year when date values
are formatted. The actual character used as the date separator in formatted output is
Scientific format. If the format expression contains at least one digit placeholder (0 or
#) to the right of E-, E+, e-, or e+, the number is displayed in scientific format and E or
e is inserted between the number and its exponent. The number of digit placeholders
to the right determines the number of digits in the exponent. Use E- or e- to place a
minus sign next to negative exponents. Use E+ or e+ to place a minus sign next to
negative exponents and a plus sign next to positive exponents.
Display a literal character. To display a character other than one of those listed,
precede it with a backslash (\) or enclose it in double quotation marks (" ").
Display the next character in the format string. To display a character that has special
meaning as a literal character, precede it with a backslash (\). The backslash itself isn't
displayed. Using a backslash is the same as enclosing the next character in double
quotation marks. To display a backslash, use two backslashes (\\).Examples of
characters that can't be displayed as literal characters are the date-formatting and
time-formatting characters (a, c, d, h, m, n, p, q, s, t, w, y, / and :), the numericformatting characters (#, 0, %, E, e, comma, and period), and the string-formatting
characters (@, &, <, >, and !).
Display the string inside the double quotation marks (" "). To include a string in format
from within code, you must use Chr(34) to enclose the text (34 is the character code
for a quotation mark (")).
Examples:
Value
12345
12345,67
12345,00
123
12345,67
Format string
#.###
#.###,00
#.###,00
00000
#.###,00 “€”
Output
12.345
12.345,67
12.345,00
00123
12.345,67 €
21
July 2012
Page 21
EHQ - BTM Software Europe B.V.
Arem 3
2151 RE Nieuw Vennep
The Netherlands
Tel. +31 (0) 252 683 550
Fax. +31 (0) 252 684 611
www.BTMSoftware.eu
22
July 2012
Page 22

DRAWbridge for Webtop - Configuration Guide

Transcription

Similar documents

Drawbridge - San Francisco Bay Wildlife Society

here - San Francisco Bay Wildlife Society

chhs drawbridge 1 - Castle Hill High School

Step 11: To create the towers, cut out 8 strips of paper, 2cm x 19cm

Evolving ImzML and mzML to an authentic open data format

Lakos SandMasterPlus Install Operation Manual

Hydraulic HGV Ball Joint Separator Hydraulic Ball Joint

HD Front.ai

15ppm BILGE SEPARATOR