Atributo

Tipo

Notas  

Models

Colección de tipo Paquete

De sólo lectura. Los modelos de tipo package y pertenecientes a una colección de packages. Es el punto de entrada de más alto nivel en un archivo de proyecto de EA. Cada modelo es un Nodo Raíz en el Explorador de Proyectos y puede contener vistas/paquetes/ etc. Un Modelo es una forma especial de Paquete -tiene un ParentID de '0'-. Al iterar a través de los modelos se puede acceder a todos los elementos dentro de la jerarquía del proyecto. También puede utilizar la función AddNew para crear un nuevo Modelo. Un Modelo también se puede eliminar, pero recuerde que todo lo contenido en el Modelo también se eliminará!  

Terms

Collection

Sólo lectura. El Glosario del proyecto. Cada Término es una entrada en el glosario. Agrega, modifica y elimina Términos para mantener el Glosario.  

Issues

Collection

Sólo lectura. La lista de las Incidencias del Sistema. Contiene los objetos Incidencia, cada uno detallando una incidencia en particular relacionadas al proyecto como un todo.  

Authors

Collection

Sólo lectura. La colección de los Autores del sistema. Contiene 0 o más objetos Autor, cada uno de los que se puede asociar con los elementos, diagramas, etc. como el autor o dueño del ítem. Use AddNew, Delete y GetAt para administrar los Autores.

Clients

Collection

Sólo lectura. Una lista de los Clientes asociados con el proyecto. Puede agregar uno nuevo, modificar y eliminar objetos del Cliente usando esta colección.  

Tasks

Collection

Sólo lectura. Una lista de tareas del sistema (lista para hacer). Cada entrada es un ítem de Tarea; puede agregar una nueva, modificar y eliminar Tareas.  

Datatypes

Collection

Sólo lectura. La colección de Tipos de Datos. Contiene una lista de objetos Tipo de Datos; cada uno de los que representa una definición de tipo de datos para propósitos de modelado o de generación de código.  

Resources

Collection

Sólo lectura. Una lista de los recursos disponibles para asignar a ítems de trabajo dentro del proyecto. Use las funciones agregar nuevo, modificar y eliminar para administrar los Recursos.  

Stereotypes

Collection

Sólo lectura. La colección de estereotipos. Una lista de los objetos del Estereotipo que contienen información en un estereotipo y a que elementos se los puede aplicar.

PropertyTypes

Collection

Sólo lectura. Colección de los Tipos de Propiedades disponibles en el Repository.

LibraryVersion

Long

Sólo lectura. El número de compilación de la ejecución de EA. 

LastUpdate

String

Sólo lectura. La cadena de caracteres identificadora que identifica la sesión de ejecución de EA y la marca de tiempo que se estableció. 

FlagUpdate

Boolean

Lectura/Escritura. Instruye a EA para actualizar el Repository con el valor de la Última Actualización (LastUpdate). 

InstanceGUID

String

Sólo lectura: La cadena de caracteres identificadora que identifica la sesión de ejecución de EA. 

ConnectionString

String

Sólo lectura. La cadena de caracteres de nombre de archivo/conexión del Repository actual

ObjectType

ObjectType

Sólo lectura. Distingue los objetos referenciados a través de la interfaz de Despacho 

EnableUIUpdates

Booleano

Lectura/Escritura. Configurar esta propiedad a falso para mejorar la realización de cambios al modelo, ej. El volumen de adición de los elementos a un paquete. Para revelar los cambios al usuario, llamar al Repository.  RefreshModelView().

BatchAppend

Booleano

Lectura/Escritura. Configurar esta propiedad a verdadero cuando su cliente de automatización necesita insertar rápidamente muchos elementos, operaciones, atributos y/o parámetros de la operación. Configurar a falso cuando el trabajo este completo.

Esto puede resultar en 10 a 20 mejoras al agregar elementos en volumen.

SuppressEADialogs

Booleano

Lectura/Escritura. Configura esta propiedad en los eventos de transmisión EA OnPostNewElement o EA_OnPostNewConnector para controlar si EA debería suprimir/mostrar las ventanas de Propiedades predeterminadas al usuario cuando un Elemento o Conector nuevo se crea.  

ProyectGUID

String

Solo lectura: Retorna un ID único para el proyecto.

EnableCache

Boolean

Lectura/Escritura: Una optimización para pre-cargar los objetos del paquete cuando tratamos con grandes conjuntos de objetos de automatización.

Método

Tipo

Notas  

OpenFile (String filename)

Boolean

parámetro: Nombre de archivo [ String - in ] 

El nombre de archivo del proyecto de Enterprise Architect que se abrirá. Es el principal punto de apertura de un archivo del proyecto de Enterprise Architect desde un cliente de automatización. Provee el nombre de archivo de un proyecto de Enterprise Architect válido, y llamarlo para abrirlo y trabajar con los objetos contenidos.

Si el proyecto requerido es un repositorio DBMS, y ha creado un archivo .EAP de acceso rápido que contiene el string de conexión de base de datos, puede  llamar a este archivo de acceso rápido para acceder el repositorio DBMS.

Si puede también conectar a una base de datos SQL pasando el string de conexión en lugar de un nombre de archivo. Una string de conexión válida se puede obtener desde la ventana Abrir proyecto seleccionado un repositorio SQL abierto recientemente.     

[Open Project] == link to "open_a_project.htm" help page

GetElementByID (Long PackageID)

Element

parámetro: ElementID [ Long - in ]

Obtiene un puntero a un Elemento usando un número de referencia absoluta (ID local). Usualmente se lo encuentra usando la propiedad ElementID de un elemento, y se almacena para un uso futuro cuando desee abrir un Elemento sin usar la función GetAt() de colección. 

  GetPackageByID (Long)

Package

parámetro: PackageID [ Long - in ]

Obtiene un puntero a un Paquete usando un número de referencia absoluto (ID local). Usualmente se lo encuentra usando la propiedad PackageID de un paquete, y se almacena para un uso futuro cuando desee abrir un Paquete sin emplear la función GetAt() de colección.

GetPackageByGUID (String GUID)

Package

Retorna un punto en un paquete en el repositorio usando el número de referencia de GUID del paquete (ID global). Este normalmente se encuentra usando la propiedad PackageGUID del paquete. Cada paquete en el modelo también tiene un Elemento asociado con el mismo GUID, de esta forma si tiene un elemento con Type="Package" luego puede cargar el paquete llamando:

GetPackageByGuid(Element.ElementGUID).

GetLastError ()

String

Devuelve un valor de cadena de caracteres describiendo el error que ocurrió más recientemente en relación a este objeto.

Esta función se utiliza raramente debido a que se disparará una excepción cuando ocurra un error. 

GetDiagramByID (Long)

Diagram

parámetro: DiagramID [ Long - in ] 

Obtiene un puntero a un Diagrama utilizando un número de referencia absoluta (ID local). Usualmente se lo encuentra usando la propiedad DiagramID de un elemento, y se almacena para un uso futuro cuando desee abrir un Diagrama sin emplear la función GetAt() de colección.  

GetReferenceList (String)

Reference

parámetro: Type [ String - in ] 

El tipo de listas para obtener un puntero a un objeto de la Lista de Referencias. El parámetro especifica el tipo de lista a obtener. Listas válidas son: Diagram, Element, Restriction, Requirement, Connector, status, Cardinality, Effort, Metric, Scenery, Test. 

GetProjectInterface ()

Project

Devuelve un puntero a la interfaz del Proyecto de EA - el servidor de automatización basado en XML para EA. Use esta interfaz para trabajar con EA usando XML, y también acceder a las funciones de utilidad para descargar diagramas, reportes ejecutables, etc.

Exit

Cierra EA inmediatamente. Es usado por programadores de .NET donde el recolector de basura no libera inmediatamente todas las referencias a los objetos COM. 

OpenFile2(string FilePath,string Username, string Password)

Boolean

Igual que OpenFile() excepto que permite la especificación de una clave de acceso. 

ShowWindow(long Show)

Muestra u oculta EA.

GetCurrentDiagram()

Diagram

Devuelve el diagrama seleccionado

GetConnectorByID (long ConnectorID)

Connector

Busca en el repository un conector con el que coincida el ID. 

GetTreeSelectedItem (Object SelectedItem)

ObjectType

Se usa para obtener una variable y un tipo de objeto correspondientes al ítem actualmente seleccionado en la vista de árbol. 

Para usar esta función cree una variable de objeto genérica y pásela como parámetro. Dependiendo del tipo de respuesta, ajústela a un tipo más específico. 

Este objeto pasado de regreso a través del parámetro puede ser un objeto paquete, elemento, diagrama, atributo u operación. 

GetTreeSelectedPackage()

Package

Devuelve el paquete en el que está contenido el objeto de la vista de árbol actualmente seleccionado. 

CloseAddins()

Es llamado por los controladores de automatización para asegurarse de que los Add-ins que se crearon en .NET no persisten después de que todas las referencias de los controladores a EA se hayan eliminado. 

AdviseObjectChange()

Boolean

parámetro: ObjectID [ long - in ]

Provee un Add-In o un cliente de automatización con la capacidad de avisar a la interfaz de usuario de EA que un elemento particular cambió y si es visible en cualquier diagrama abierto, cargar de nuevo y refrescar ese elemento para el usuario.  

AdviseConnectorChange()

Boolean

parámetro: ConnectorID [ long - in ]

Provee un Add-In o un cliente de automatización con la capacidad de avisar a la interfaz de usuario de EA que un conector particular cambió y si es visible en cualquier diagrama abierto, cargar de nuevo y refrescar ese conector para el usuario.  

OpenDiagram(long DiagramID)

Boolean

parámetro: DiagramID [ long - in ]

Provee un método para un cliente de automatización o Add-In para abrir un diagrama por su ID. El diagrama se agregará a la lista de pestañas de diagramas abiertos en la vista principal de EA. 

CloseDiagram(long DiagramID)

Boolean

parámetro: DiagramID [ long - in ]

Provee un método para cerrar un diagrama (si está abierto) por su ID en la lista actual de diagramas que tiene abiertos EA.  

ActivateDiagram(long DiagramID)

Boolean

parámetro: DiagramID [ long - in ]

Provee los medios para activar un diagrama que está actualmente abierto (ej. para hacerlo la pestaña activa) en la interfaz de usuario de EA principal.  

SaveDiagram(long DiagramID)

Boolean

parámetro: DiagramID [ long - in ]

Se llama a ésta para guardar un diagrama abierto por medio de su número de ID. Asume que el diagrama estará abierto en la lista de Pestañas de la interfaz de usuario principal.  

ReloadDiagram(long DiagramID)

Boolean

parámetro: DiagramID [ long - in

Carga nuevamente el diagrama especificado por el valor de ID. Comúnmente esto se utilizaría para refrescar un diagrama visible después de importación/exportación de código u otros procesos por lote donde el diagrama requiera una actualización completa. 

CloseFile()

Cierra cualquier archivo abierto

GetTreeSelectedItemType()

ObjectType

parámetro: ninguno 

Devuelve el tipo de objeto seleccionado actualmente en el árbol.  Uno de: 

GetTechnologyVersion(string ID)

String

parámetro: ID [ string ]  

Devuelve la versión del recurso de Tecnología MDG con el ID de tecnología que se especificó. 

IsTechnologyLoaded(string ID)

Boolean

parámetro: ID [ string ] 

Devuelve a Verdadero, si el recurso de Tecnología MDG con el ID de tecnología que se especificó está cargado en el repository. De otra forma, devuelve a False. 

ImportTechnology(string Technology)

Boolean

parámetro: Technology [ string ]

Instala el recurso de Tecnología MDG en el repository. El parámetro de Tecnología representa los contenidos del archivo de recursos de Tecnología.

Devuelve a Verdadero, si la tecnología se cargó exitosamente en el modelo. De otra forma, devuelve a Falso.

GetCounts()

Devuelve un conjunto de cuentas desde varias tablas dentro del repository de EA base. Esto se puede usar para determinar si los registros se agregaron o se eliminaron de las tablas para las que se recuperó la información. 

GetElementSet()

Collection

Devuelve un conjunto de elementos como una colección basada en una entrada de números de ID de elementos en formato separado por comas; ej. GetElementSet("34,56,21,5") 

DeleteTechnology(string ID)

Boolean

parámetro: ID [ string ] 

Elimina el recurso de Tecnología MDG con el ID de tecnología que se especificó del repository. 

Devuelve a Verdadero, si la tecnología se eliminó exitosamente del modelo. De otro modo devuelve a Falso. 

AddTab(string TabName, string ControlID)

activeX custom control

parámetro: TabName [String - in]

  parámetro: ControlID [String - in] 

Permite que un control personalizado ActiveX se agregue como una ventana con pestañas. 

Se usa TabName como la etiqueta de la pestaña. 

ControlID es el ProgID del control; ej. Project1.UserControl1 

EA crea un control y si tiene éxito, devuelve el puntero IUnknown que puede ser empleado por el invocador para manipular el control.

CreateOutputTab (string Name)

param: Name [String in] Crea una etiqueta en la ventana de Salida con el nombre especificado.

RemoveOutputTab (string Name)

param: Name [String in]  Elimina la etiqueta en la ventana de Salida con el nombre especificado.      

WriteOutput (string Name, string String, long ID)

param: Name [String in]

param: String [String in]

param: ID [long in]

Escribe el texto en String en la etiqueta en la ventana de Salida con el nombre especificado. Ve el ID especificado.

ClearOutput(string Name)

param: Name [String in]

Elimina todo el texto en la etiqueta en la ventana de Salida con el nombre especificado.

EnsureOutputVisible(string Name)

param: Name [String in]

Asegura que la etiqueta en la ventana de Salida con el nombre especificado es visible al usuario. La Vista de Salida será visible si esta oculta.

RefreshModelView(long PackageID)

param: PackageID [Long in]

Recarga el modelo completo, actualizando la interfaz del usuario. Si PackageID es 0, se recarga el modelo completo. Si PackageID representa un PackageID válido, solo ese paquete se recargará.

GetElementByGuid(string Guid)

Element

param: Guid [String - in]

Devuelve un indicador a un Elemento en el repository usando el número de referencia GUID del Elemento (ID global). Esto usualmente se encuentra usando la propiedad de Element oGUID de un elemento - y guardado para usarlo posteriormente cuando desee abrir un Elemento sin usar la función GetAt() de colección.

GetConnectorByGuid(string Guid)

Connector

param: Guid [String - in]

Devuelve un indicador a un Conector en el repository con un GUID correspondiente. Esto usualmente se encuentra usando la propiedad ConnectorGUID de un conector.

ShowDynamicHelp(string Topic)

param: Topic [String - in]

Muestra el tema Ayuda; especificado por el tema parámetro, como una pestaña de vista.

GetContextItemType()

ObjectType

Devuelve el ObjectType de un ítem en contexto dentro de EA. Un ítem Contextual se define como el ítem seleccionado en cualquier lugar dentro del gui de EA incluyendo:

Los ObjectTypes soportados puede ser cualquiera de los siguientes valores:

GetContextItem(Object Item)

ObjectType

param: Item [ Object - out ]

Configura el Ítem como un indicador al item en contexto dentro de EA. tanto como su ObjectType correspondiente como un valor de retorno.

Para información adicional acerca de los ítems contextuales y los ObjectTypes soportados se refieren a el método GetContextItemType.

ActivateTab(string Name)

param: Name [String - in]

Activa la vista de EA con el nombre correspondiente.

GetDiagramByGuid(string Guid)

Diagram

param: Guid [ String - in ]

Devuelve un indicador a un Diagrama usando un ID de referencia global (ID global). Esto usualmente se encuentra usando la propiedad del GUID del Diagrama de un elemento - y guardado para usarlo cuando desee abrir un Diagrama sin usar la función GetAt() de colección.

GetCurrentLoginUser(boolean GetGuid = false)

String

Si la seguridad no se activo en el repository, se genera un error.

Si GetGuid es Verdadero, un Guid generado por EA representando el usuario se devuelve, de otra manera el texto como se registro en el Sistema del Ususario/Detalles del Usuario/Ingresar se devuelve.

ChangeLoginUser(string Name, string Password)

Boolean

param: Name [ String - in ]

param: Password [ String - in ]

Establece el usuario actualmente registrado para ser especificado por el parámetro Nombre, con el valor de la Clave provista. Esto registra al usuario en el repository cuando la seguridad se habilita. Si la seguridad no se habilita una excepción ("Security not enabled") se emitirá.

GetTreeSelectedObject()

Object

El método no relacionado GetTreeSelectedItem() tiene un parámetro out que es inaccesible por algunos lenguajes. Como alternativa, este método provee el ítem seleccionado a través del valor de retorno.

ShowProfileToolbox(string Technology, string Profile, boolean Show)

param: Technology [ String - in ]

param: Profile [ String - in ]

param: Show [ Boolean - in ]

Muestra/Oculta los contenidos de la tecnología o perfil especificado en la caja de herramientas de EA. Para mostrar/ocultar un perfil en la caja de herramientas, especifique el valor de ID del perfil en el parámetro del perfil y configure el parámetro de tecnología a un string nulo.

Para mostrar/ocultar una tecnología en la caja de herramientas, especifique el ID de la tecnología en el parámetro de tecnología y configure el parámetro del Perfil a un string nulo.

ActivatePerspective(string Perspective, long Options)

Boolean

param: Perspective [ String - in ]

param: Options [ long - in ]

Activa la perspectiva, especificada por su nombre en el parámetro Perspectiva.

El parámetro Opciones se invierte para un uso futuro.

AddPerspective(string Perspective, long Options)

Boolean

param: Perspective [ String - in ]

param: Options [ long - in ]

Agrega la perspectiva, especificada por su nombre en el parámetro Perspectiva, al repository.

El parámetro Opciones se invierte para un uso futuro.

DeletePerspective(string Perspective, long Options)

Boolean

param: Perspective [ String - in ]

param: Options [ long - in ]

Elimina la perspectiva, especificada por su nombre en el parámetro perspectiva.

El parámetro Opciones se invierte para un uso futuro.

GetActivePerspective()

String

Devuelve el nombre de la perspectiva actualmente activa.

HasPerspective(string Perspective)

String

param: Perspective [ String - in ]

Devuelve "1" o "0" dependiendo de si una perspectiva especificada por su nombre en el parámetro Perspectiva, esta disponible en el repositor o no.

IsTabOpen()

String

param: TabName [ String - in ]

Devuelve 2 para indicar que la pestaña se abierta y activa  (top-most), 1 indica que esta abierto pero no top-most, 0 para indicar que no es visible.

Tenga en cuenta que TabName es case-sensitive.

GetAttributeByGuid(string Guid)

Attribute

param: Guid [String - in]

Devuelve un indicador a un Atributo en el repository con un Guid correspondiente. Esto usualmente se encuentra usando la propiedad  AttributeGUID de un Atributo.

GetMethodByGuid(string Guid)

Method

param: Guid [String - in]

Devuelve un indicador a un Método en el repository con un Guid correspondiente. Esto usualmente se encuentra usando la propiedad  MethodGUID de un Atributo.

ShowInProyectView (Object Item)

param: Item [Object - in]

Seleccionar el objeto referenciado por el parámetro que se provee en la ventana en la Vista del Proyecto. Tipos de objetos aceptados son Paquete, Elemento, Diagrama, Atributo, y Método. Una excepción se emitirá si el objeto es de un tipo inválido.  

AddDefinedSearches(string sXML)

param:sXML [string - in]

Permite ingresar un conjunto de búsquedas definidas que perdurarán en EA por la vida de la aplicación.  Cuando EA descargue nuevamente necesitarán ser ingresados nuevamente por su Add-In. Puede obtener esto xml exportando las búsquedas desde la ventana de búsqueda del modelo en EA - (Ctrl F luego presionar el botón avanzado)      

GetElementsByQuery(string QueryName, string SearchTerm)

param: QueryName[string - in]

param: SearchTerm[string - in]

Permite ejecutar una búsqueda en EA retornando el resultado  como una colección. QueryName será el nombre de la búsqueda para ejecutar, por ejemplo 'Simple'. SearchTerm será lo que esta buscando, Por ejempo

GetElementByQuery('Simple', 'Class1'). Donde los resultados contendrán elementos con 'Class1'en el campo Nombre y Notas.    

RunModelSearch(string 'QueryName', string 'SearchTerm', string 'SearchOptions', string 'SearchData')

param: sQueryame[string - in]

param: sSearchTerm[string - in]

param: sSearchOptions[string - in]

param: sSearchData[string - in]

Ejecuta una búsqueda mostrando los resultados en la ventana de búsqueda de EA. QueryName será el nombre de la búsqueda a ejecutar, por ejemplo 'Simple'.

SearchTerm será lo que esta buscando.

SearchOptions se usa actualmente. El parámetro SearchData permite proveer una lista de resultados en la forma de xml que será referenciado en la lista de resultado de EA. Vea Formato XML, este parámetro no se requiere entonces pase cualquier string vacío para ejecutar la búsqueda como es normal.    

ExecutePackageBuildScript(long ScriptOptions, string PackageGuid)

param: ScriptOptions, [long - in]

param: PackageGuid [string - in]

Permite que ejecute el script de compilación del paquete activo basado en su selección actual en la ventana del Explorador de proyecto. También puede ejecutar un script pasando el Guid del paquete.

Las Opciones de Script puede ser cualquiera de estos valores: 1,2,3,4,5;

1 = compilar; 2 = Probar; 3 = Ejecutar; 4 = Crear instancias del banco de trabajo; 5 = Depurar

ActivateToolbox(string Toolbox, long Options)

Boolean

param: Toolbox [ String - in ]

param: Options [ long - in ]

Activa la página en el GUI, especificado por su nombre en el parámetro de la caja de herramientas. Retorna a verdadero si el parámetro de la caja de herramientas especificada se activo exitosamente, de otra forma es falso.

El parámetro Opciones se invierte para un uso futuro.

ImportPackageBuildScripts(string PackageGuid, string BuildScriptXML)

String

param: PackageGuid [string - in]

param: BuildScriptXML [string - in]

Permite que importe los scripts de compilación en un paquete en Enterprise Architect. Puede importar sus scripts de compilación del paquete reemplazando un GUID del paquete y el dato xml el cual puede exportar en Enterprise Architect.

RefreshOpenDiagrams(Boolean FullReload)

Boolean

param: FullReload [ Boolean - in ]

Actualiza el contenido del diagrama para todos los diagramas abiertos en  Enterprise Architect.

Si FullReload es falso los contenidos abiertos de los elemento y conectores se actualizan en cada diagrama. Si FullReload es verdadero cada uno de los diagramas son completamente recargados desde el repositorio.

SaveAuditLogs(string FilePath, Object StartDateTime, Object EndDateTime)

Boolean

param: FilePath [string - in]

param: StartDateTime [Variant [DateTime] - in]

param: EndDateTime [Variant [DateTime] - in]

Guarda los registros de auditoria contenidos dentro del modelo al archivo especificado por el parámetro FilePath.

Si StartDateTime y EndDateTime no son nulos luego solo se guardan los items de registro que are caen en este periodo.

Retorna a verdadero en caso de logro, y a falso en caso de fracaso.

Tenga en cuenta; Este puede fallar si el usuario registrado en el modelo no tiene los permisos de accesos correctos.

ClearAuditLogs(Object StartDateTime, Object EndDateTime)

Boolean

param: StartDateTime [Variant [DateTime] - in]

param: EndDateTime [Variant [DateTime] - in]

Elimina todos los registros de auditoria desde el modelo.

Si StartDateTime y EndDateTime no son nulos luego solo los items que caen en este periodo se eliminan.

Tenga en cuenta: Esto no se puede deshacer. Se advierte fuertemente que primero llame SaveAuditLogs para realizar una copia de seguridad de los registros.

Retorna a verdadero en caso de logro, y a falso en caso de fracaso.

Tenga en cuenta: Este puede fallar si el usuario registrado en el modelo no tiene los permisos de accesos correctos.

SaveAllDiagrams()

Llame esto para guardar todos los diagramas abiertos.