Back to Bookshelf

• Encyclopedia API Reference Guide
• Legal Notices
• CA Technologies Product References
• Contact CA Technologies
• Introduction
  • Audience
  • Local and Remote Access Encyclopedia API
  • Workstation-Based Encyclopedia API
  • Related Documentation
  • Install the API and Demonstration Programs
  • Function Categories
    • Presentation Structure
  • Encyclopedia API Demo Program
    • Files Included in the Demo Program
    • Start the Demo Program on z/OS
    • Start the Demo Program on Windows or UNIX
    • Use Schema Functions
    • Use Other Functions
    • Use Workstation API Functions
    • All other menus
    • Execute the Model Functions Example
    • Close the API Demo
  • Requirements to Execute the Update Functions
    • Locks
    • Protected Objects
    • Commits
    • Recommendations
• Using Windows and UNIX APIs
  • Installed Code
  • API Header Files
  • Workstation API
    • Workstation API - Compile and Link
  • Windows Encyclopedia API
    • Windows Encyclopedia API - Compile and Link
    • Considerations for Remote Database Access
      • Remote Oracle Access
      • Remote DB2 Access
  • UNIX Encyclopedia API
• API Variable Types
  • Enum Definitions
  • Numeric Definitions
  • Character Array Definitions
  • Count and Array Functions
  • Inputs
  • Memory Calculations for Fetches
• Encyclopedia Information
  • EApiConnectToEncy
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiDisconnectEncy
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiCommit
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiCommitUpdate
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiUpRollback
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiLogonUserId
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchEncyInfo
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchEncyModelIds
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiPasswordValidate
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
    • How EApiPasswordValidate API Validates Password
• Model Information
  • EApiOpenModel
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Example
  • EApiFetchModelInfo
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchModelChkoutInfo
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchModelCreateInfo
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchModelLastUpdateInfo
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchModelParentInfo
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchModelByName
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
• Model Lock and Unlock
  • EApiLockModel
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiUnLockModel
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
• Object Information
  • EApiFetchAllModelObjects
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchAllModelTypeObjs
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchModelNameTypeObjs
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchModelObjListByNameType
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchObjectInfo
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchObjectCreateInfo
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchObjectAncestryInfo
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchObjectWithAncestry
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchObjChkoutParentInfo
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiAddObject
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiDelObject
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
• Association Information
  • EApiFetchCardOneAsc
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchCardOneAscWithObjInfo
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchCardManyAsc
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchCardManyAscWithObjInfo
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchOrderAscOccInfo
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchAscOccLastUpdInfo
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchParentAscOccChkoutInfo
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiAddAssoc
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiDelAssoc
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiReordrAssocAftr
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiReordrAssocBefr
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
• Property Information
  • EApiFetchSingleCharPrp
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchSingleNumericPrp
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchCharArrayPrp
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchPrpLastUpInfo
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchParentChkoutPrpInfo
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiUpCharArray
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiUpNumeric
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiUpSingleChar
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
• Subset Information
  • EApiFetchSubsetsInModel
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchSubsetInfo
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchSubsetCreateInfo
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchSubsetByName
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchSubsetScopingObjs
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchSubsetScopingObjInfo
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchSubsetChkoutInfo
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
• Checkout Information
  • EApiFetchChkoutsForObj
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchChkoutInfoForChkoutObj
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchChkoutChkdOutObjs
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchChkoutSubsetModelId
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
• User and Group Information
  • EApiFetchAllUsers
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchUserInfo
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchUserCreateInfo
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchAllGroups
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchGroupInfo
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchGroupCreateInfo
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchUsersInGroup
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchGroupsUsersIn
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
• Authorization Information
  • EApiFetchUsersGrpsModelAuth
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchModelAuthInfo
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchModelAuthCreateInfo
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchUsersGrpsSubsetAuth
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchSubsetAuthCreateInfo
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
• Schema Information
  • EApiFetchSchemaObjTypeInfo
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchSchemaObjTypeByMnem
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchSchemaPrpTypeInfo
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchSchemaCharPrpDflt
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchSchemaIntPrpDflt
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchSchemaPrpForObjType
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchSchemaAscTypeCodeInfo
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiFetchSchemaAscForObjType
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
• Count Information
  • EApiCountEncyModelIds
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiCountModelObjs
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiCountModelTypeObjs
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiCountModelNameTypeObjs
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiCountSubsetScopingObjs
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiCountChkoutChkdOutObjs
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiCountSubsetsInModel
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiCountChkoutsForObj
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiCountCardManyAsc
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiCountAllUsers
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiCountAllGroups
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiCountUsersInGroup
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiCountGroupsInUser
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiCountUsersGrpsModelAuth
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiCountUsersGrpsSubsetAuth
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiCountSchemaPrpForObjType
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
  • EApiCountSchemaAscForObjType
    • Description
    • Summary
    • Input
    • Output
    • Return
    • Related Functions
    • Example
• API Return Code Definitions
  • API Return Codes
• Metamodel Diagrams
  • CA Gen Models Stored in the Metamodel
  • Dialog Flow Diagram Objects
  • Dialog Modeling Diagram Objects
  • Technical Design Metamodel Definition Diagram
  • Data Structure List
  • Data Structure List Metamodel Occurrence Diagram
  • Data Store List Metamodel Occurrence Diagram
  • Activity Hierarchy Diagram
  • Activity Hierarchy Diagram Objects Metamodel Definition Diagram
  • Metamodel Occurrence Diagram Example 1
  • Metamodel Occurrence Diagram Example 2
  • Metamodel Occurrence Diagram Example 3
  • Metamodel Occurrence Diagram Example 4
  • Activity Dependency Diagram
  • Activity Dependency Diagram Objects Metamodel Definition Diagram
  • Active Dependency Diagram
  • Activity Dependency Diagram Metamodel Occurrence Diagram
  • Packaging Metamodel Definition Diagram Objects
  • Metamodel Occurrence Diagram - Batch Packaging
  • Metamodel Occurrence Diagram - Window Packaging
  • Metamodel Occurrence Diagram - Online Packaging
  • Packaging
• Encyclopedia and Workstation API Functions
  • List of Read API Functions
  • List of Update API Functions
• Object Name Validation Rules
  • List of Character Set Rules
    • Non-Construction Object Rule
    • Identifier Rule
    • TD Rule
    • No Underscore TD Rule
    • No NLS Rule
    • Mixed Case TD Rule
    • Oracle TD Rule
    • ODBC TD Rule
    • XML Rule
  • Planning Objects
  • Analysis Objects
  • Design Objects
  • Technical Design Objects
  • Construction Objects
• CA Gen Toolset Automation
  • Plug-ins
    • Plug-in Installation
    • Toolset Initialization
    • Plug-in Menu Item Selection
    • Plug-in Application Execution
    • Plug-in Application Registration
    • CA Gen Toolset Menu Hierarchy
    • Plug-in Application Parameters
    • Diagram Names
    • Using the Toolset Automation Object for Plug-ins
    • Caveats
    • Return Codes
  • Objects
    • OpenAPI Object
      • Properties
        • LastReturnCode
      • Methods
        • AddObject
        • Commit
        • CountModelNameTypeObjs
        • CountModelObjs
        • CountModelTypeObjs
        • FetchAllModelObjects
        • FetchAllModelTypeObjs
        • FetchModelInfo
        • FetchModelNameTypeObjs
        • FetchSchemaAscTypeByMnem
        • FetchSchemaObjTypeByMnem
        • FetchSchemaPrpTypeByMnem
        • GetMetaModelObject
        • Rollback
    • MetaModelObject
      • Properties
        • ID
        • ObjectTypeCode
        • LastReturnCode
      • Methods
        • AddAssoc
        • CountCardManyAsc
        • DelAssoc
        • DelObject
        • FetchCardManyAsc
        • FetchCardOneAsc
        • FetchCharArrayPrp
        • FetchSingleCharPrp
        • FetchSingleNumericPrp
        • ReordrAssocAftr
        • ReordrAssocBefr
        • UpCharArray
        • UpNumeric
        • UpSingleCharArray
    • MetaModelObjects
      • Properties
        • count
      • Methods
        • Item
    • Model Object
      • Properties
        • Active
        • ActiveWindow
        • FullName
        • Name
        • OpenAPI
        • Parent
        • Path
        • ReadOnly
        • Saved
        • Toolset
      • Methods
        • Tools
        • Windows
    • Models Object
      • Properties
        • _NewEnum
        • Toolset
        • Count
        • Parent
      • Methods
        • Add
        • CloseAll
        • Copy
        • Delete
        • Item
        • New
        • Open
        • SaveAll
    • CopyWithSubstitution Object
      • Properties
        • Toolset
        • Parent
        • Type
        • DestinationBusinessSystem
        • DestinationProcedure
        • SourceProcedure
        • IncludeAllWindows
      • Methods
        • GetDestinationBusinessSystems
        • GetSourceBusinessSystems
        • GetMatchedObject
        • GetObjectName
        • GetSourceProcedures
        • GetDestinationEntityTypes
        • GetSourceEntityTypes
        • Match
        • Copy
        • GetDestinationRelationships
        • GetSourceRelationships
        • GetDestinationAttributes
        • GetSourceAttributes
        • Unmatch
        • GetDestinationSubjectAreas
        • GetObjectTypeCode
        • GetSourceActionBlocks
        • GetRelationshipTo
        • GetRelationshipFrom
        • GetInverseRelationship
    • Tool Object
      • Properties
        • Toolset
        • Parent
        • Type
    • Tools Object
      • Properties
        • _NewEnum
        • Toolset
        • Count
        • Parent
      • Methods
        • Item
    • Toolset Object
      • Properties
        • ActiveWindow
        • AutoSave
        • BackgroundColor
        • FullName
        • Height
        • Left
        • ModelPath
        • Models
        • Name
        • OutputPath
        • Parent
        • Path
        • Toolbar
        • Top
        • TreeView
        • Version
        • Visible
        • Width
        • WindowState
        • WorkPath
      • Methods
        • Quit
        • Windows
    • View Object
      • Properties
        • Toolset
        • Parent
        • Type
    • Views Collection
      • Properties
        • _NewEnum
        • Toolset
        • Count
        • Parent
      • Methods
        • Item
    • Window Object
      • Properties
        • Active
        • Toolset
        • Caption
        • Height
        • Index
        • Left
        • Next
        • Parent
        • Previous
        • Top
        • Width
        • WindowState
      • Methods
        • Close
    • Windows Object
      • Properties
        • _NewEnum
        • Toolset
        • Count
        • Parent
      • Methods
        • Arrange
        • CloseAll
        • Item