Managing the repository > SA Encyclopedia Manager (SAEM) > SAEM menus > Tools menu > Encyclopedia schemas
  
Encyclopedia schemas
Encyclopedia schema overview
System Architect provides encyclopedia options, that to become enabled, require encyclopedia schemas to be changed. The sections below describe the standard schema, the workspace schema, and the Optimized XT Reader feature.
Standard schema
A standard schema is one that has not been enabled to use Workspaces. By default, new encyclopedias are created with the standard schema. Furthermore, new encyclopedias on SQL Server 2005 or SQL Server 2008 are created with the standard schema, and are enabled with the Optimized XT Reader feature, described further down.
Workspaces schema
The workspaces schema enables you to baseline an encyclopedia and create workspaces for it. A baseline encyclopedia becomes read-only. For information on working with workspaces, see Manage workspaces overview.
Optimized XT Reader
Encyclopedias enabled with the Optimized XT Reader feature enables System Architect to integrate with the System Architect Publishing Engine Document Studio by making encyclopedias available as data sources for that product. This is made possible through a REST API. This feature also increases the number of concurrent users that can login to System Architect XT with the 'Reader' mode.
By default, new encyclopedias you create on SQL Server 2005 or SQL Server 2008 are enabled with the Optimized XT Reader feature. SQL Server 2005 encyclopedias created with System Architect versions prior to V11.3.1 must be converted before they can be opened. A dialog informs you of this requirement and prompts you to enable the Optimized XT Reader. Choosing 'Yes' converts the encyclopedia, while choosing 'No' leaves the encyclopedia intact, but it will not be opened.
Changing encyclopedia schemas
Changing a schema is an administrative task that requires exclusive encyclopedia access that can only be performed through System Architect Encyclopedia Manager (SAEM).
You can enable the Optimized XT Reader option for encyclopedias configured with standard or with workspace schemas, as described below.
Enabling encyclopedias with Optimized XT Reader option
Enabling the Optimized XT Reader option requires exclusive encyclopedia access, and doing so can take a long time to complete on large encyclopedias. To change the encyclopedia schema for optimization proceed as follows:
1 Login to the server that the encyclopedia is on.
See Login to SQL Server.
2 Select the encyclopedia.
3 Click Tools, and then click Encyclopedia Schema.
4 Select Enable Optimized XT Reader, and then click OK.
A confirmation dialog prompts you to confirm or cancel the operation.
5 Click OK.
The Message Center window displays a “Starting System Architect” message, and then an “Opening the encyclopedia <Encyclopedia Name>” message. While the encyclopedia is being opened, if a dialog appears requiring you to respond, you need to respond for the process to complete. At the same time, the Set Optimized XT Reader Status dialog is displayed, listing the tasks that SAEM performs on the encyclopedia.
This graphic is described in the surrounding text.
6 Click Close.
The Message Center window now displays “Schema update complete.”
Limitations of the Optimized XT Reader option
Enabling encyclopedia with the Optimized XT Reader option has the following limitations:
The feature only works on SQL Server 2005 encyclopedias.
Certain keywords in reports have to be in a specific order to be parsed correctly.
Example 1: The “Partial” keyword has to be between select and where clauses.
Select Name PARTIAL Where class = Diagram
Example 2: The “Subreport” keyword has to be before Diagram keyword.
Select Name Where Identity =1234 SUBREPORT "Parent Diagram" { } Diagram
The Compare Models functionality in System Architect XT does not work on encyclopedias with the Optimized XT Reader option. To overcome this limitation, log into System Architect XT with the “Updater” role and perform the model comparisons.
Not all metrics are supported in optimized encyclopedias. The sections below list supported metrics and unsupported metrics. To retrieve unsupported metrics, log into System Architect XT with the “Updater” role and use all metrics.
Supported metrics
ANNOTATION
BOTTOM
CONNECTOR
WORD COUNT
LINE COUNT
ALL PROPS
USR PROPS
TOP
REFERENCE
CHAR COUNT
ICOMDEST
CHECKED OUT BY
CHECK OUT DATE
CHECK OUT TIME
DOORS PROPERTY
RELATION
RELATION NUMBER
TYPE
TYPE NUMBER
TO ASSOCIATION NUMBER
AUDIT
INITIAL AUDIT
ICOMSOURCE
Unsupported metrics
BALANCE
BALANCEMSPEC
CELLFILLCOLOR
CELLFILLLISTVALUE
CELLFONTCOLOR
CELLFONTLISTVALUE
CRUD
CURRENT
DEPTH
ELEMENTLIST
EXPRESSION
ICOMROLE
INPUT
INPUTLIST
KEYCOMPNBR
LEVELNUMBER
LEVELNUMBERSORT
NORMALIZE1
NORMALIZE23
OUTPUT
OUTPUTLIST
PARENTSLASHDATA
RULES
SELECTED
SEQINPARENTSLIST
STATETABLE
SYNCHRONIZE
UNMARKEDLIST
LOCK
UNCLE COUNT
SEQUENCE
QUALIFIED NAME
IS FOREIGN KEY
UPDATE USE (DEFINE COUNT)
Overriding the mandatory conversion for Optimized XT Reader
The mandatory requirement to optimize encyclopedias with the “XT Reader” feature can be overridden by a setting in the SA2001.INI file. This override also applies to new encyclopedias, for which Optimized XT Reader will not be enforced.
Note Applying the Optimized XT Reader feature in SAEM overrides the SA2001.INI setting described below.
To disable mandatory Optimized XT Reader conversion
1 Open the SA2001.INI file, located in this directory:
C:\Documents and Settings\<UserName>\Local Settings\Application Data\Telelogic\SystemArchitect
2 Create a heading named [SystemArchitect], if one does not exist already.
3 Add the following line under the [SystemArchitect] heading: OverrideOptimizedXTReader=Y
4 Save and close the SA2001.INI file.
The override will take effect the next time you start System Architect.
See also
Tools menu