Repository Class

The Repository is the main container of all structures such as models, Packages and elements. You can iteratively begin accessing the model using the Models collection. It also has some convenient methods to directly access the structures without having to locate them in the hierarchy first.

Associated table in .EAP file    <none>

Repository Attributes

Attribute

Type

Notes

See also

Authors

Collection

Read only

This is the system Authors collection. This contains 0 or more Author objects, each of which can be associated with, for example, elements or diagrams as the item author or owner.

Use AddNew (), Delete () and GetAt () to manage Authors.

 

Collection Class

BatchAppend

Boolean

Read/Write

Set this property to true when your automation client has to rapidly insert many elements, operations, attributes and/or operation parameters.

Set to false when work is complete.

This can result in 10- to 20-fold improvement in adding new elements in bulk.

 

 

Clients

Collection

Read only

A list of Clients associated with the project. You can modify, delete and add new Client objects using this collection.

 

Collection Class

ConnectionString

String

Read only

The filename/connection string of the current Repository.

For a connection string, the DBMS repository type is identified by "DBType=n;" where n is a number corresponding to the DBMS type, as follows:

0 - MYSQL
1 - SQLSVR
2 - ADOJET
3 - ORACLE
4 - POSTGRES
5 - ASA
7 - OPENEDGE
8 - ACCESS2007

 

 

Datatypes

Collection

Read only

The Datatypes collection. This contains a list of Datatype objects, each representing a data type definition for either data modeling or code generation purposes.

 

Collection Class

EAEdition

EAEditionTypes

Read only

Returns the current level of core licensed functionality available.

This property returns Corporate when the edition is Business and Software Engineering, Systems Engineering or Ultimate.

Use EAEditionEx to identify which of these extended editions is available.

 

EAEditionTypes

EAEditionEx

EAEditionTypes

Read only

Returns the current level of extended licensed functionality available.

 

EAEditionTypes

EnableCache

Boolean

Read/Write

An optimization for pre-loading Package objects when dealing with large sets of automation objects.

 

 

EnableUIUpdates

Boolean

Read/Write

Set this property to false to improve the performance of changes to the model; for example, bulk addition of elements to a Package. To reveal changes to the user, call Repository.RefreshModelView ().

 

 

FlagUpdate

Boolean

Read/Write

Instructs Enterprise Architect to update the Repository with the LastUpdate value.

 

 

InstanceGUID

String

Read only

The identifier string identifying the Enterprise Architect runtime session.

 

 

IsSecurityEnabled

Boolean

Read only

Checks whether User Security is enabled for the current repository.

 

 

Issues

Collection

Read only

The System Issues list. Contains ProjectIssues objects, each detailing a particular issue as it relates to the project as a whole.

 

Collection Class

LastUpdate

String

Read only

The identifier string identifying the Enterprise Architect runtime session and the timestamp for when it was set.

 

 

LibraryVersion

Long

Read only

The build number of the Enterprise Architect runtime.

 

 

Models

Collection of type Package

Read only

Models are of type Package and belong to a collection of Packages. This is the top level entry point to an Enterprise Architect project file. Each model is a root node in the Project Browser and can contain items such as Views and Packages.

A model is a special form of a Package; it has a ParentID of 0. By iterating through all models, you can access all the elements within the project hierarchy.

You can also use the AddNew () function to create a new model. A model can be deleted, but remember that everything contained in the model is deleted as well.

 

Collection Class

Package Class

ObjectType

ObjectType

Read only

Distinguishes objects referenced through the Dispatch interface.

 

ObjectType

ProjectGUID

String

Read only

Returns a unique ID for the project.

 

 

ProjectRoles

Collection

Read only

The system Roles collection. Contains 0 or more Role objects, each of which can be associated with, for example, elements or diagrams as the item author or owner.

Use AddNew (), Delete () and GetAt () to manage Roles.

 

Collection Class

PropertyTypes

Collection

Read only

Collection of Property Types available to the Repository.

 

Collection Class

Property Type Class

Resources

Collection

Read only

Contains available ProjectResource objects to assign to work items within the project.

Use the add new, modify and delete functions to manage resources.

 

Collection Class

Stereotypes

Collection

Read only

The Stereotype collection. A list of Stereotype objects that contain information on a stereotype and which elements it can be applied to.

 

Collection Class

Stereotype Class

SuppressEADialogs

Boolean

Read/Write

Set this property in the EA_OnPostNewElement broadcast event to control whether Enterprise Architect should suppress showing the default Properties dialog to the user when an element is created.

 

EA_OnPostNewElement

 

SuppressSecurityDialog

Boolean

Read/Write

Suppress the login prompt dialog that appears by default when username and password parameters passed to OpenFile2 are invalid.  For use by external automation clients only.

 

 

Tasks

Collection

Read only

A list of system tasks (to do list). Each entry is a Task Item; you can modify, delete and add new tasks.

 

Collection Class

Task Class

Terms

Collection

Read only

The project Glossary. Each Term object is an entry in the Glossary. Add, modify and delete Terms to maintain the Glossary.

 

Collection Class

Term Class

Repository Methods

Method

Type

Notes

See also

ActivateDiagram (
long DiagramID)

 

Activates an already open diagram (that is, makes it the active tab) in the main Enterprise Architect user interface.

Parameters:

·DiagramID: Long - the ID of the diagram to make active
 

 

ActivatePerspective (
string long)

 

Boolean

Deprecated - no longer in use.

 

ActivateTab (
string Name)

 

Activates an open Enterprise Architect tabbed view.

Parameters:

·Name: String - the name of the view to activate
 

 

ActivateTechnology (
string TechnologyID)

 

Activates an enabled MDG Technology.

Parameters:

·TechnologyID: String - the ID of the Technology to activate, as assigned in the MDG Technology Wizard
 

Create MDG Technology File

ActivateToolbox (
string Toolbox,
long Options)

Boolean

Activates a Toolbox page in the GUI.

The returned value is reserved for future use.

Parameters:

·Toolbox: String - the name of the Toolbox page to activate
·Options: Long - reserved for future use
 

 

AddDefinedSearches (
string sXML)

 

Enables you to enter a set of defined searches that last in Enterprise Architect for the life of the application; when Enterprise Architect loads again they must be inserted again by your Add-In.

Parameters:

·sXML: String - the XML of the defined searches; you can get this XML by performing an export of the searches from the Manage Searches dialog in Enterprise Architect
 

Define & Modify Searches

AddDocumentationPath(
string Name,
string Path,
long Type)

 

 

Provides an Add-In with the ability to insert a book path into the Enterprise Architect installation directory, to display Learning Center pages on user-authored subjects (such as use of the Add-In).

Parameters:

·Name: String - the top-level (root) name for the Learning Center documentation hierarchy for the Add-In (for example, Enterprise Architect)
·Path: String - the directory path to the folder to contain the Learning Center documentation structure (for example,
C:\Program Files (86)\Sparx Systems\EA\Books
·Type: Long - reserved for future use; set to 0
 

 

Learning Center

 

 

 

Create Learning Center Pages

AddPerspective (
string Perspective,
long Options)

 

Boolean

Deprecated - no longer in use.

 

AddTab (
string TabName,
string ControlID)

activeX custom control

Adds an ActiveX custom control as a tabbed window. Enterprise Architect creates a control and, if successful, returns its Unknown pointer, which can be used by the caller to manipulate the control.

Parameters:

·TabName: String - used as the tab caption
·ControlID: String - the ProgID of the control; for example, "CS_AddinFramework.UserControl1"
 

Create a Custom View

 

AddWindow (
string WindowName,
string ControlID)

activeX custom control

Adds an ActiveX custom control as a window to the Add-Ins docked window. Enterprise Architect creates a control and, if successful, returns its Unknown pointer, which can be used by the caller to manipulate the control.

Parameters:

·WindowName: String - used as the window title
·ControlID: String - the ProgID of the control; for example, "CS_AddinFramework.UserControl1"
 

Custom Docked Window

RemoveWindow

 

AdviseConnectorChange (
long ConnectorID)

 

Provides an Add-In or automation client with the ability to advise the Enterprise Architect user interface that a particular connector has changed and, if it is visible in any open diagram, to reload and refresh that connector for the user.

Parameters:

·ConnectorID: Long - the ID of the connector
 

 

AdviseElementChange (
long ObjectID)

 

Provides an Add-In or automation client with the ability to advise the Enterprise Architect user interface that a particular element has changed and, if it is visible in any open diagram, to reload and refresh that element for the user.

Parameters:

·ObjectID: Long - the ID of the element
 

 

ChangeLoginUser (
string Name,
string Password)

Boolean

Sets the currently logged on user to be that specified by a name and password; this logs the user into the repository when security is enabled.

If security is not enabled an exception (Security not enabled) is thrown.

Parameters:

·Name: String - the name of the user
·Password: String - the password of the user
 

 

ClearAuditLogs (
Object StartDateTime,
Object EndDateTime)

Boolean

Clears all Audit Logs from the model.

If StartDateTime and EndDateTime are not null then only log items that fall into this period are cleared.

Returns true for success, false for failure.

·This method cannot be undone. It is strongly advised that you call SaveAuditLogs first to backup the logs
·This method might fail if the user logged into the model does not have the correct access permission
 

Parameters:

·StartDateTime: Variant ( DateTime )  - the earliest date and time of log entries to clear
·EndDateTime; Variant ( DateTime )  - the latest date and time of log entries to clear
 

 

ClearOutput (
string Name)

 

Removes all the text from a tab in the Output window.

Parameters:

·Name: String - the name of the tab to remove text from
 

CreateOutputTab

EnsureOutput Visible

WriteOutput

CloseAddins ()

 

Called by automation controllers to ensure that Add-Ins created in .NET do not linger after all controller references to Enterprise Architect have been cleared.

 

 

CloseDiagram (
long DiagramID)

 

Closes a diagram in the current list of diagrams that Enterprise Architect has open.

Parameters:

·DiagramID: Long - the ID of the diagram to close
 

 

CloseFile ()

 

Closes any open file.

 

 

CreateDocumentGenerator()

Document Generator

 

Returns a pointer to the EA.DocumentGenerator interface.

Document Generator Interface Package

CreateModel (
CreateModelType CreateType,
string FilePath,
long ParentWnd)

Boolean

Creates a new .eap model file based on the standard Enterprise Architect Base model, or a shortcut .eap based on a provided SQL connection.

Returns true when the new file is created, otherwise returns false.

Parameters:

·CreateType: CreateModelType - Specify whether to make a new copy of the EABase.eap model, or create a .eap file shortcut to a DBMS repository; the latter option requires a dialog to be opened for the user to provide SQL connection details
·FilePath: String - Destination for new .eap file
·ParentWnd: Long - Window handle to act as the parent for the SQL connection dialog; only required when using cmEAPFromSQLRepository
 

CreateModelType

CreateOutputTab (
string Name)

 

Creates a tab in the Output window.

Parameters:

·Name: String - the name of the tab to create
 

CreateOutputTab

EnsureOutput Visible

WriteOutput

 

DeletePerspective (
string Perspective,
long Options)

 

Boolean

Deprecated - no longer in use.

 

DeleteTechnology (
string ID)

Boolean

Removes a specified MDG Technology resource from the repository.

Returns true, if the technology is successfully removed from the model. Returns false otherwise.

·This applies to technologies imported into pre-7.0 versions of Enterprise Architect (imported technologies), not to technologies referenced in version 7.0 and later (referenced technologies)
 

Parameters:

·ID: String - the ID of the technology
 

Deploy an MDG Technology

EnsureOutputVisible (
string Name)

 

Ensures that a specified tab in the Output window is visible to the user. The Output window is made visible if it is hidden.

Parameters:

·Name: String - the name of the tab to make visible
 

CreateOutputTab

EnsureOutput Visible

WriteOutput

ExecutePackageBuildScript (
long ScriptOptions,
string PackageGuid)

 

Enables you to run the active Package build script based on your current selection in the Project Browser. You can also run a script by passing in the Package GUID.

Parameters:

·ScriptOptions: Long - the script type; can be any one of these numerical values:

1 = Build

2 = Test

3 = Run

4 = Create Workbench Instance

5 = Debug
 

·PackageGuid: String - the ID of the Package for which to run the script
 

 

Exit

 

Shuts down Enterprise Architect immediately. Used by .NET programmers where the garbage collector does not immediately release all referenced COM objects.
 

 

GetActivePerspective ()

String

Deprecated - no longer in use.

 

 

GetAttributeByGuid (
string Guid)

Attribute

Returns a pointer to an attribute in the repository, located by its GUID.This is usually found using the AttributeGUID property of an attribute.

Parameters:

·Guid: String - the GUID of the attribute to locate
 

Attribute Class

GetAttributeByID (
string Id)

Attribute

Returns a pointer to an attribute in the repository, located by its ID. This is usually found using the AttributeID property of an attribute.

Parameters:

·Id: String - the ID of the attribute to locate
 

Attribute Class

GetConnectorByGuid (
string Guid)

Connector

Returns a pointer to a connector in the repository, located by its GUID. This is usually found using the ConnectorGUID property of a connector.

Parameters:

·Guid: String - the GUID of the connector to locate

 

Connector Class

GetConnectorByID (
long ConnectorID)

Connector

Searches the repository for a connector with a specific ID.

Parameters:

·ConnectorID: Long - the ID of the connector to locate

 

Connector Class

GetContextItem (
object Item)

ObjectType

Sets a pointer to an item in context within Enterprise Architect.

Also returns the corresponding ObjectType.

For additional information about ContextItems and the supported ObjectTypes see the GetContextItemType method (below).

Parameters:

·Item: Object - the item to point to
 

ObjectType

GetContextItemType ()

ObjectType

Returns the ObjectType of an item in context within Enterprise Architect. A ContextItem is defined as an item selected anywhere within the Enterprise Architect GUI including:

·An item selected in the Project Browser
·An item selected in an open diagram
·An item selected in certain dialogs, such as the attribute Properties dialog
 

The supported ObjectTypes can be any one of the following values:

·otElement
·otPackage
·otDiagram
·otAttribute
·otMethod
·otConnector
 

ObjectType

GetContextObject ()

Object

Returns the current context Object.

 

 

GetCounts ()

String

Returns a set of counts from a number of tables within the base Enterprise Architect repository. These can be used to determine whether records have been added or deleted from the tables for which information is retrieved.

 

 

GetCurrentDiagram ()

Diagram

Returns a selected diagram.

 

Diagram Class

GetCurrentLoginUser (
boolean GetGuid)

String

If security is not enabled in the repository, an error is generated.

If GetGuid is True, a GUID generated by Enterprise Architect representing the user is returned; otherwise the text as entered in System Users/User Details/Login is returned.

 

 

GetDiagramByGuid (
string Guid)

Diagram

Returns a pointer to a diagram using the global reference ID (global ID). This is usually found using the diagram GUID property of an element, and stored for later use to open an diagram without using the collection GetAt() function.

Parameters:

·Guid: String - the GUID of the diagram to locate
 

Diagram Class

GetDiagramByID (
long DiagramID)

Diagram

Gets a pointer to a diagram using an absolute reference number (local ID). This is usually found using the DiagramID property of an element, and stored for later use to open a diagram without using the collection GetAt() function.

Parameters:

·DiagramID: Long - the ID of the diagram to locate
 

Diagram Class

GetElementByGuid (
string Guid)

Element

Returns a pointer to an element in the repository, using the element's GUID reference number (global ID). This is usually found using the ElementGUID property of an element, and stored for later use to open an element without using the collection GetAt () function.

Parameters:

·Guid: String - the GUID of the element to locate
 

Element Class

GetElementByID (
long ElementID)

Element

Gets a pointer to an element using an absolute reference number (local ID). This is usually found using the ElementID property of an element, and stored for later use to open an element without using the collection GetAt () function.

Parameters:

·ElementID: Long - the ID of the element to locate
 

Element Class

GetElementsByQuery (
string QueryName,
string SearchTerm)

Collection (of type Element)

Enables the user to run a search in Enterprise Architect, returning the result as a collection.

For example GetElementsByQuery('Simple','Class1'), where results contain elements with Class1 in the Name and Notes fields.

Parameters:

·QueryName: String - the name of the search to run, for example 'Simple'
·SearchTerm: String - the term to search for
 

Collection Class

Element Class

GetElementSet (
string IDList,
long Options)

Collection
(of type Element)

Returns a set of elements as a collection based on a comma-separated list of ElementID values. By default, if no values are provided in the IDList parameter, all objects for the entire project are returned.

Parameters

·IDList: String - a comma-separated list of ElementID values
·Options: Long - modifies default behaviour of this method
·1 - Returns empty collection when empty IDList parameter is given
·2 - Use IDList string as an SQL query to populate this collection
 

Collection Class

Element Class

GetFieldFromFormat (
string Format,
string Text)

String

Converts a field from your preferred format to Enterprise Architect's internal format; returns the field in that format.

Parameters:

·Format: String - The format to convert the field from; valid formats are:
·HTML - Full HTML
·RTF - Rich Text Format
·TXT - Plain text
 
·Text: String - The field to be converted
 

 

GetFormatFromField (
string Format,
string Text)

String

After accessing a field that contains formatting, use this method to convert it to your preferred format; returns the field in the format specified.

Parameters:

·Format: String - The format to convert the field to; valid formats are:
·HTML - Full HTML
·RTF - Rich Text Format
·TXT - Plain text
 
·Text: String - The field to be converted
 

 

GetGapAnalysisMatrix ()

String

Read Only.

Returns all Gap Analyses as an XML document.

 

Gap Analysis Matrix

GetLastError ()

String

Returns a string value describing the most recent error that occurred in relation to this object.

 

 

GetMailInterface()

MailInterface

Returns an instance of the EA.MailIinterface; use this interface to automate the process of creating and sending model mail messages.

 

MailInterface Package

GetMethodByGuid (
string Guid)

Method

Returns a pointer to a method in the repository; this is usually found using the MethodGUID property of a method.

Parameters:

·Guid: String - the GUID of the method to look for
 

Method Class

GetMethodById (
string Id)

Method

Returns a pointer to a method in the repository; this is usually found using the MethodID property of a method.

Parameters:

·Id: String - the ID of the method to look for
 

Method Class

GetPackageByGuid (
string Guid)

Package

Returns a pointer to a Package in the repository using the Package's GUID reference number (global ID). This is usually found using the PackageGUID property of the Package.

Each Package in the model also has an associated element with the same GUID, so if you have an element with Type="Package" then you can load the Package by calling:

              GetPackageByGuid(Element.ElementGUID)

Parameters:

·Guid: String - the GUID of the Package to look for
 

Package Class

GetPackageByID (
long PackageID)

Package

Get a pointer to a Package using an absolute reference number (local ID). This is usually found using the PackageID property of an Package, and stored for later use to open a Package without using the collection GetAt () function.

Parameters:

·PackageID: Long - the ID of the Package to locate
 

Package Class

GetProjectInterface ()

Project

Return a pointer to the EA.Project interface (the XML-based automation server for Enterprise Architect). Use this interface to work with Enterprise Architect using XML, and also to access utility functions for loading diagrams, running reports and so on.

 

EA.Project interface

Project Class

GetReferenceList (
string Type)

Reference

Uses the list type to get a pointer to a Reference List object.

Parameters:

·Type: String - specifies the list type to get; valid list types are:
 
Diagram
Element
Constraint
Requirement
Connector
Status
Cardinality
Effort
Metric
Scenario
Status
Test
List:DifficultyType
List:PriorityType
List:TestStatusType
List:ConstStatusType
 

Reference Class

GetRelationshipMatrix()

String

Returns all Relationship Matrices as an XML document.

 

Relationship Matrix

GetTechnologyVersion (
string ID)

String

Returns the version of a specified MDG Technology resource.

Parameters:

·ID: String - the specified technology ID

 

 

GetTreeSelectedElements()

Collection

Returns the set of elements currently selected in the Project Browser as a collection.

 

Collection Class

GetTreeSelectedItem (
object SelectedItem)

ObjectType

Gets an object variable and type corresponding to the currently selected item in the tree view.

To use this function, create a generic object variable and pass this as the parameter. Depending on the return type, cast it to a more specific type.

The object passed back through the parameter can be a Package, element, diagram, attribute or operation object.

Parameters:

·SelectedItem: Object - the object to get the variable and type for
 

ObjectType

GetTreeSelectedItemType ()

ObjectType

Returns the type of the object currently selected in the tree. One of:

·otDiagram
·otElement
·otPackage
·otAttribute
·otMethod
 

 

GetTreeSelectedObject ()

Object

The related method GetTreeSelectedItem () has an output parameter that is inaccessible by some scripting languages. As an alternative, this method provides the selected item through the return value.

 

GetTreeSelectedItem

GetTreeSelectedPackage ()

Package

Returns the Package in which the currently selected tree view object is contained.

 

Package Class

HasPerspective (
string Perspective)

 

String

Deprecated - no longer in use.

 

HideAddinWindow ()

 

Hides the docked Add-In window.

 

AddWindow

Custom Docked Window

RemoveWindow

 

ImportPackageBuildScripts (
string PackageGuid,
string BuildScriptXML)

 

Imports build scripts into a Package in Enterprise Architect.

Parameters:

·PackageGuid: String - the GUID of the Package into which to import the build scripts
·BuildScriptXML: String - the build script XML data, which you can export from within Enterprise Architect
 

 

ImportTechnology (
string Technology)

Boolean

Installs a given MDG Technology resource into the repository.

Returns True, if the technology is successfully loaded into the model. Otherwise returns False.

This applies to technologies imported into pre-7.0 versions of Enterprise Architect (imported technologies), not to technologies referenced in version 7.0 and later (referenced technologies).

Parameters:

·Technology: String - the contents of the technology resource file
 

Deploy an MDG Technology

InvokeConstructPicker (
string ElementFilter)

String

Invokes the Select <Item> dialog with filters on the object type and, optionally, stereotype. Returns the ElementID of the selected object, or 0 if no object was selected when the dialog was closed.

For example:

elementid=Repository.InvokeConstructPicker( "IncludedTypes=Class,Component;StereoType=foo,bar"  )

In this example, the Select <item> dialog will allow the user to select any Class or Component element in the model that has a stereotype of foo or bar.

Parameters:

·ElementFilter: String - specifies which elements or Packages are to be made available for selection, based on element types and stereotypes identified by the IncludedTypes and StereoType filters
·IncludedTypes - (mandatory) comma separated list of element types that can be selected in this dialog; example: Package, Class, Component
·StereoType - (optional) comma separated list of stereotypes that can be selected in this dialog

 

·The IncludedTypes and StereoType filters are separated by a semi-colon
·Do not use leading or trailing spaces between element type or stereotype values
·StereoType and IncludedTypes must be written with the correct case; element type names are also case sensitive

 

Select <Item> Dialog

InvokeFileDialog (
string FilterString,
long Filterindex,
long Flags)

 

String

Opens a standard Open File Dialog and returns a string containing the full path to the selected file on success.  Returns an empty string if the dialog was canceled.

Parameters:

·FilterString: String - list of file type filters.
·Filterindex: Long - One-based index of the filter to be used by default
·Flags: Long - additional bit flags used to initialize the file dialog.  See OPENFILENAME structure in MSDN documentation for accepted values.

 

Project.GetFileNameDialog()

IsTabOpen (
string TabName)

String

Checks whether a named Enterprise Architect tabbed view is open and active. This includes open diagram windows or custom controls added using Repository.AddTab ().

Returns:

·2 to indicate that a tab is open and active (top-most)
·1 to indicate that it is open but not top-most, or
·0 to indicate that it is not visible at all
 

Parameters:

·TabName: String - the name of the tab to check for; TabName is case sensitive
 

Repository.AddTab()

IsTechnologyEnabled (
string ID)

Boolean

Checks whether a specified technology is enabled in Enterprise Architect.

Returns True if the MDG Technology resource is enabled. Otherwise returns False.

Parameters:

·ID: String - the technology ID to check for, from:
 
id="UML2" name="Basic UML 2 Technology"
id="EAExtended" name="Core Extensions"
id="262139" name="MDG Technology Builder"
id="DatabaseEngineering" name="Database Engineering"
id="ArcGIS" name="ArcGIS"
id="BRM" name="Business Rule Model"
id="CODEENG" name="CodeEngineering"
id="ERD" name="Entity Relationship Diagram"
id="GML" name="GML"
id="SoaML" name="SoaML"
id="SysML1.1" name="SysML 1.1"
id="SysML1.2" name="SysML 1.2"
id="SysML1.3" name="SysML 1.3"
id="SYSENG" name="System Engineering"
id="Win32UI" name="Win32 User Interface Modelling"
 

 

IsTechnologyLoaded (
string ID)

Boolean

Checks whether a specified technology is loaded into the repository.

Returns True if the MDG Technology resource is loaded into the repository. Otherwise returns False.

Parameters:

·ID: String - the technology ID to check for
 

 

LoadAddins ()

 

Loads all Add-Ins from a repository when Enterprise Architect is opened from automation.

 

 

OpenDiagram (
long DiagramID)

 

Provides a method for an automation client or Add-In to open a diagram. The diagram is added to the tabbed list of open diagrams in the main Enterprise Architect view.

Parameters:

·DiagramID: Long - the ID of the diagram to open
 

 

OpenFile (
string Filename)

Boolean

This is the main point for opening an Enterprise Architect project file from an automation client, and working with the contained objects.

If the required project is a DBMS repository, and you have created a shortcut .EAP file containing the database connection string, you can call this shortcut file to access the DBMS repository.

You can also connect to a SQL database by passing in the connection string itself instead of a filename. A valid connection string can be obtained from the Open Project dialog by selecting a recently opened SQL repository.

Parameters:

·Filename: String - the filename of the Enterprise Architect project to open
 

Open a Project

OpenFile2 (
string FilePath,
string Username,
string Password)

Boolean

As for OpenFile () except this enables the specification of a password.

Parameters:

·Filepath: String - the file path of the Enterprise Architect project to open
·Username: String - the user login ID
·Password: String - the user password
 

 

RefreshModelView (
long PackageID)

 

Reloads a Package or the entire model, updating the user interface.

Parameters:

·PackageID: Long - the ID of the Package to reload: if 0, the entire model is reloaded; if a valid Package ID, only that Package is reloaded
 

 

RefreshOpenDiagrams (
boolean FullReload)

 

Reloads the diagram contents for all open diagrams from the repository.

Parameters:

·FullReload: Boolean - if false only the contents of element compartments are reloaded; if true the full content of each  diagram is reloaded
 

 

ReloadDiagram (
long DiagramID)

 

Reloads a specified diagram. This would commonly be used to refresh a visible diagram after code import/export or other batch process where the diagram requires complete refreshing.

·Calling this method within a call to EA_OnNotifyContextItemModified is not supported

 

Parameters:

·DiagramID: Long - the ID of the diagram to be reloaded
 

EA_OnNotifyContextItemModified

RemoveOutputTab (
string Name)

 

Removes a specified tab from the Output window.

Parameters:

·Name: String - the name of the tab to be removed
 

 

RemoveWindow (
string WindowName)

Boolean

Removes an Add-In window that matches the specified WindowName.

Parameters:

·WindowName: String - the name of the window to remove

 

AddWindow

 

RepositoryType ()

String

Returns the currently open database/repository type.

May return one of the following values:

·JET  ( .EAP file, MS Access 97 to 2003 format )
·ACCESS2007  ( .accdb file, MS Access 2007+ format )
·ASA  ( Sybase SQL Anywhere )
·SQLSVR  ( Microsoft SQL Server )
·MYSQL  ( MySQL )
·ORACLE  ( Oracle )
·POSTGRES  ( PostgreSQL )

 

 

RunModelSearch (
string sQueryName,
string sSearchTerm,
string sSearchOptions,
string sSearchData)

 

Runs a search, displaying the results in Enterprise Architect's Model Search window.

Parameters:

·sQueryName: String - the name of the search to run, for example Simple
·sSearchTerm: String - the term to search for
·sSearchOptions: String - currently not being used
·sSearchData: String - enables you to supply a list of results in the form of XML, which is appended onto the result list in Enterprise Architect - see XML Format; this parameter is not mandatory so pass in an empty string to run the search as per normal
 

XML Format

Project Class (a different call to Run Model Search)

SaveAllDiagrams ()

 

Saves all open diagrams.

 

 

SaveAuditLogs (
string FilePath,
object StartDateTime,
object EndDateTime)

Boolean

Saves the Audit Logs contained within a model to a specified file.

If StartDateTime and EndDateTime are not null then only log items that fall into this period are saved.

Returns true for success, false for failure.

·This might fail if the user logged into the model does not have the correct access permission
 

Parameters:

·FilePath: String - the file to save the Audit Logs to
·StartDateTime: Variant ( DateTime )  - the earliest date and time of log entries to save
·EndDateTime; Variant ( DateTime )  - the latest date and time of log entries to save
 

 

SaveDiagram (
long DiagramID)

 

Saves an open diagram; assumes the diagram is open in the main user interface Tab list.

Parameters:

·DiagramID: Long - the ID of the diagram to save
 

 

ScanXMIAndReconcile ()

 

Scans the Package XMI files associated with each of the project's controlled Packages and restores any diagram objects or cross-references that are detected as missing from the project.

This function is useful in team environments where each user maintains their own private copy of the model database (i.e. multiple private EAP files) and model updates are propagated through the use of controlled Packages; it provides no benefit when the model is hosted in a single shared database that is accessed by all team members.

Each controlled Package is compared with its associated XMI file and, if the cross-reference information in the model does not match the XMI, Enterprise Architect updates the model with the information from the XMI and records the update in the Output window.

You can roll back such updates by right-clicking on the entry in the Output window and selecting the context menu option Rollback Update (or Rollback Selected Updates if multiple entries are selected).

Closing the model clears the entries in the Output window; an entry in the Output window is also cleared as and when you roll-back the update for it.

This functionality is invoked automatically as part of the Get All Latest operation.

When working in an environment that uses a Private Model deployment and your model contains a significant number of cross-Package references, it is recommended that you invoke this function from time to time, following the re-importation of controlled Packages - for example, after using Get Latest to update a number of Packages, or after performing a number of Package check-outs.

·As a general rule, avoid running this function while you have uncommitted changes in your model
·Generally, you should:
·Check-out a number of Packages
·Invoke ScanXMIAndReconcile
·Make your modifications
·Commit any outstanding changes before you check-out more Packages and run ScanXMIAndReconcile again
 

 

ShowAddinWindow (
string TabName)

Boolean

Shows the docked Add-In window on the specified page. Returns true if a tab of the specified name is now displayed.

Parameters

·TabName: String - specifies the tab page
 

AddWindow

Custom Docked Window

RemoveWindow

 

ShowDynamicHelp (
string Topic)

 

Shows a help topic as a view.

Parameters:

·Topic: String - specifies the help topic
 

 

ShowInProjectView (
object Item)

 

Selects a specified object in the Project Browser.

Accepted object types are Package, Element, Diagram, Attribute, and Method; an exception is thrown if the object is of an invalid type.

Parameters:

·Item: Object - the object to highlight
 

 

ShowWindow (
long Show)

 

Shows or hides Enterprise Architect.

Parameters:

·Show: Long
 

 

SQLQuery (
string SQL)

String

Enables execution of a SQL select statement against the current repository.

Returns an XML formatted string value of the resulting recordset.

Parameters:

·SQL: String - contains the SQL Select statement
 

 

SynchProfile (
string Profile,
string Stereotype)

Boolean

Synchronizes Tagged Values and constraints of a UML Profile item using the Synch Profiled Elements dialog.

Parameters:

·Profile: String - the name of the profile that contains the stereotype
·Stereotype: String - the name of the profile stereotype for which the default tags and constraints are to be synchronized
 

Synchronize Tagged Values and Constraints

VersionControlResynchPkgStatuses (boolean ClearSettings)

 

Synchronizes the version control status of each version controlled Package within the current model with the status reported by your version control provider.

Parameters:

·ClearSettings: Boolean
 
- if true, clear the version control settings from Packages that are reported by the version control provider as uncontrolled
 
- if false, leave the version control settings  unchanged for Packages reported as uncontrolled
 

Resynchronize the Status of Version Controlled Packages

WriteOutput (
string Name,
string Output,
long ID)

 

Writes text to a specified tab in the Output window, and associates the text with an ID.

Parameters:

·Name: String - specifies the tab on which to display the text
·Output: String - specifies the text to display
·ID: Long - specifies a numeric ID value to associate with this output item for further handling by Add-Ins; can be set to 0 if no handling is required
 

ClearOutput

CreateOutputTab

EnsureOutput Visible

 

EA_OnOutputItemClicked

EA_OnOutputItemDoubleClicked