Appendix B Intrinsic Quick Reference Tables
This appendix provides a listing of all System Dictionary intrinsics by
group, and includes the function and basic restrictions for each. A
complete description of each intrinsic, including a full explanation of
the restrictions for each, is located in Chapter 4 of this manual.
CONTROL INTRINSICS
-----------------------------------------------------------------------------------------------
| | | |
| Intrinsic | Function | Restriction(s) |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDOpen | Opens SYSDIC, establishes | Only the DA scope or a scope |
| | access path to dictionary. | with access to current domain, |
| | | in any mode which does not |
| | | conflict with an open mode |
| | | already in use. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDLock | Manually locks the dictionary | Any current scope, in either |
| | to protect data integrity. | Shared Read mode or Shared |
| | | Update mode. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDUnlock | Releases existing locks on the | Any current scope, in either |
| | dictionary that were set for a | Shared Read mode or Shared |
| | specified access path. | Update mode. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDSetControl | Sets the dictionary control | Only the DA scope, in |
| | functions. | Exclusive Customization mode. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDClose | Terminates access to the | Any scope, in any open mode. |
| | dictionary via the specified | |
| | access path. | |
| | | |
| | | |
| | Releases all locks set on the | Dictionary size limits cannot |
| | dictionary for the specified | be exceeded. |
| | access path. | |
| | | |
| | | |
| | Restructures the dictionary if | The terminal is not available |
| | closing from a session that | while restructuring in |
| | was opened in Exclusive | process, unless closing is |
| | Customization mode. | done in batch mode. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDError | Returns ASCII format error | None. |
| | messages to the calling | |
| | program from System Dictionary | |
| | or subsystems used by System | |
| | Dictionary. | |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDSwitchNameMode | Switches the user to another | None |
| | name mode. | |
| | | |
-----------------------------------------------------------------------------------------------
SECURITY INTRINSICS
-----------------------------------------------------------------------------------------------
| | | |
| Intrinsic | Function | Restriction(s) |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDCreateScope | Creates a scope. | DA scope or a scope with |
| | | Secure capability, in either |
| | | Shared Update mode or |
| | | Exclusive Update mode. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDDeleteScope | Deletes a scope. | Only the DA scope or owner |
| | | scope, in Exclusive Update |
| | | mode. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDModifyScope | Renames a scope. | Only the DA scope or owner |
| | | scope, in Exclusive Update |
| | Modifies scope rights. | mode. |
| | | |
| | Changes a scope password, or | |
| | its own password. | The current scope can change |
| | | its own password. |
| | Changes owner scope. | |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDSwitchScope | Switches the user to another | Any mode, but the scope must |
| | scope. | be either the DA scope or a |
| | | scope with access to the |
| | | current domain. The user must |
| | | have a valid password for the |
| | | new scope. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDAddDomainScope | Allows a scope access to a | Only the DA scope or the |
| | domain. | domain's owner scope, in |
| | | either Shared Update or |
| | | Exclusive Update mode. Any |
| SDDeleteDomainScope | Deletes a scope's access from | scope may, however, delete |
| | a domain. | access to itself. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDAddEntScope | Allows a scope access to | Only the DA scope or the |
| SDAddRelScope | entity or relationship | entity's or relationship's |
| | definitions. | owner scope, in Shared Update |
| | | mode or Exclusive Update mode. |
| SDDeleteEntScope | | Any scope, however, may delete |
| SDDeleteRelScope | Deletes a scope's access from | access to itself. |
| | entity or relationship | |
| | definitions. | |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDGetEntScopeList | Retrieves all scopes with | Only the DA scope or the |
| SDGetRelScopeList | associated access to an | entity's or relationship's |
| SDGetDomainScopeList | entity, relationship, or | owner scope, in Shared Read |
| | domain. | mode, Shared Read-Only mode, |
| | | Shared Update mode, or |
| | | Exclusive Update mode. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDGetScope | Retrieves information about a | Only the DA scope, the |
| | specified scope. | specified scope's owner scope, |
| | | or the specified scope itself. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDGetScopeList | Retrieves all scopes in a | Only the DA scope or a scope |
| | dictionary or all scopes owned | with Secure capability. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDGetEntScope | Retrieves a scope's access | Any scope, in Shared Read |
| SDGetRelScope | rights to an entity or | mode, Shared Read-Only mode, |
| | relationship. | Shared Update mode, or |
| | | Exclusive Update mode. |
| | | |
-----------------------------------------------------------------------------------------------
STRUCTURE INTRINSICS
-----------------------------------------------------------------------------------------------
| | | |
| Intrinsic | Function | Restriction(s) |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDCreateEntType | Creates entity types, | Only the DA scope or a scope |
| SDCreateRelType | relationship types, | with Extend capability, in |
| SDCreateRelClass | relationship classes, or | Exclusive Customization mode. |
| SDCreateAttr | attributes. | |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDDeleteEntType | Deletes entity types, | Only the DA scope or owner |
| SDDeleteRelType | relationship types, | scope, in Exclusive |
| SDDeleteRelClass | relationship classes, or | Customization mode. |
| SDDeleteAttr | attributes. | |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDModifyEntType | Renames entity types, | Only the DA scope or owner |
| SDModifyRelType | relationship classes, or | scope, in Exclusive |
| SDModifyRelClass | attributes. | Customization mode. |
| SDModifyAttr | | |
| | Changes owner scope of entity | |
| | types, relationship types, | |
| | relationship classes, or | |
| | attributes. Also changes an | |
| | attribute's length or edits. | |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDAddAttrEntType | Adds an attribute to entity | Only the DA scope or a scope |
| SDAddAttrRelType | type's or relationship type's | with Extend capability, in |
| | attribute list. | Exclusive Customization mode. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDDeleteAttrEntType | Deletes an attribute from | Only the DA scope or owner |
| SDDeleteAttrRelType | entity type's or relationship | scope of the entity type's or |
| | type's attribute list. | relationship type's attribute |
| | | association, in Exclusive |
| | | Customization mode. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDModifyAttrEntType | Modifies the scope owner of an | Only the DA scope or owner |
| SDModifyAttrRelType | entity type/attribute | scope of the entity type's or |
| | association or a relationship | relationship type's attribute |
| | type/attribute association. | association, in Exclusive |
| | | Customization mode. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDGetEntType SDGetRelType | Retrieves information on | Any scope, in any open mode. |
| SDGetRelClass | entity type, relationship | |
| SDGetAttr | type, relationship class, or | |
| | attribute parameters. | |
| | | |
| | | |
| SDGetEntTypeList | Retrieves all entity types, | |
| SDGetRelTypeList | relationship types per | |
| SDGetRelClassList | relationship class, | |
| SDGetAttrList | relationship classes, or | |
| | attributes defined in the | |
| | dictionary structure. | |
| | | |
| SDGetEntTypeAttrList | | |
| SDGetRelTypeAttrList | Retrieves entity type's or | |
| | relationship type's attribute | |
| | list. | |
| | | |
-----------------------------------------------------------------------------------------------
DOMAIN INTRINSICS
-----------------------------------------------------------------------------------------------
| | | |
| Intrinsic | Function | Restriction(s) |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDCreateDomain | Creates a domain. | Only the DA scope or a scope |
| | | with Domain capability, in |
| | | Exclusive Update mode or |
| | | Shared Update mode. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDDeleteDomain | Deletes a domain. | Only the DA scope or owner |
| | | scope, in Exclusive Update |
| | | mode. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDModifyDomain | Renames a domain, changes its | Only the DA scope or owner |
| | sensitivity, or changes its | scope, in Shared Update mode, |
| | owner scope. | or Exclusive Update mode. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDGetDomain | Retrieves information about a | Only the DA scope or a scope |
| | domain. | with Domain capability, in |
| | | Shared Read mode, Shared |
| | | Read-Only mode, Shared Update |
| SDGetDomainList | Retrieves all domains in the | mode, or Exclusive Update |
| | dictionary structure. | mode. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDSwitchDomain | Switch to another domain. | Only the DA scope or a scope |
| | | with access to the new domain, |
| | | in Shared Read mode, Shared |
| | | Read-Only mode, Shared Update |
| | | mode, or Exclusive Update |
| | | mode. |
| | | |
-----------------------------------------------------------------------------------------------
VERSION INTRINSICS
-----------------------------------------------------------------------------------------------
| | | |
| Intrinsic | Function | Restriction(s) |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDCreateVersion | Creates a version. | Only the DA scope or a scope |
| | | with Version capability, in |
| | | Exclusive Update mode or |
| | | Shared Update mode. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDDeleteVersion | Deletes a version. | Only the DA scope or owner |
| | | scope, in Exclusive Update |
| | | mode. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDModifyVersion | Renames a version. | Only the DA scope or owner |
| | | scope, in Exclusive Update |
| | | mode. |
| | Changes the owner scope of a | |
| | version. | |
| | | |
| | | |
| | Creates links to the common | |
| | version. | |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDGetVersion | Retrieves information about a | Any scope, in Shared Read |
| | version. | mode, Shared Read-Only mode, |
| | | Shared Update mode, or |
| | | Exclusive Update mode. |
| | Retrieves the list of versions | |
| SDGetVersionList | within the current domain. | |
| | | |
| | | |
| | Retrieves all status changes | |
| SDGetVersionHistory | of a version. | |
| | | |
| | | |
| SDGetStatusVersionList | Retrieves all the versions of | |
| | the specified status. | |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDSetVersionStatus | Sets a version of entities and | Only the DA scope or a scope |
| | relationships to a specified | with Version Control |
| | status. | capability, in Exclusive |
| | | Update mode. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDCopyVersion | Copies all entities and | Only the DA scope or a scope |
| | relationships of an existing | with Version Control |
| | version, and assigns them to a | capability, in Exclusive |
| | new version. | Update mode or Shared Update |
| | | mode. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDSwitchVersion | Switches to another version. | Any scope, in Shared Read |
| | | mode, Shared Read-Only mode, |
| | | Shared Update mode, or |
| | | Exclusive Update mode. |
| | | |
-----------------------------------------------------------------------------------------------
ENTITY INTRINSICS
-----------------------------------------------------------------------------------------------
| | | |
| Intrinsic | Function | Restriction(s) |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDCreateEnt | Creates an entity. | Only the DA scope or a scope |
| | | with Create capability, in |
| | | Exclusive Update mode or |
| | | Shared Update mode. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDCreateSynonym | Creates a synonym for an | Only the DA scope or the |
| | entity. | entity's owner scope, in |
| | | Exclusive Update mode or |
| | | Shared Update mode. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDCreateEntVarAttr | Creates text to variable | Only the DA scope or a scope |
| | length attribute of entity. | with Create capability and |
| | | Modify access to the entity, |
| | | in Exclusive Update mode or |
| | | Shared Update mode. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDDeleteEnt | Deletes an entity or a synonym | Only the DA scope or owner |
| SDDeleteSynonym | from an entity. | scope of the entity, in |
| | | Exclusive Update mode or |
| | | Shared Update mode. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDDeleteEntVarAttr | Deletes a variable length | Only the DA scope or a scope |
| | attribute value of an entity. | with Create capability and |
| | | Modify access to the entity, |
| | | in Shared Update mode or |
| | | Exclusive Update mode. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDModifyEnt | Changes the external primary | Only the DA scope or owner |
| | name. | scope, or a scope with Create |
| | | capability and Modify access |
| | Changes attribute values. | to the entity, in Exclusive |
| | | Update mode or Shared Update |
| | Changes a link to a common | mode. |
| | entity. | |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDGetEnt SDGetEntVarAttr | Retrieves entity's attributes | Only the DA scope or a scope |
| SDGetPrimaryName | and common link, variable | with Read capability and Read |
| SDGetSynonymList | length attribute value for an | access to the entity, in |
| SDGetEntVersionList | entity, primary name for an | Shared Read mode, Shared |
| | entity, all synonyms of an | Read-Only mode, Exclusive |
| | entity, all versions of | Update mode, or Shared Update |
| | entity. | mode. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDGetEntList | Retrieves all entities of a | Only the DA scope or a scope |
| | specified entity type, all | with Read capability, in |
| | entities of a specified entity | Shared Read mode, Shared |
| SDGetAliasEntList | type that use the input alias | Read-Only mode, Exclusive |
| | name of a specified alias type | Update mode, or Shared Update |
| | attribute. | mode. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDGetLocalEntList | Retrieves all local entities | Only the DA scope or a scope |
| | linked to specified common | with Read capability and Read |
| | entity. | access to the common entity, |
| | | in Shared Read mode, Shared |
| | | Read Only mode, Exclusive |
| | | Update mode, or Shared Update |
| | | mode. |
| | | |
-----------------------------------------------------------------------------------------------
RELATIONSHIP INTRINSICS
-----------------------------------------------------------------------------------------------
| | | |
| Intrinsic | Function | Restriction(s) |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDCreateRel | Creates a relationship. | Only the DA scope or a scope |
| | | with Create capability, in |
| | | Shared Update mode or |
| | | Exclusive Update mode. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDCreateRelVarAttr | Creates text to a variable | Only the DA scope or a scope |
| | length attribute of a | with Create capability and |
| | relationship. | Modify access to the |
| | | relationship, in Shared Update |
| | | mode or Exclusive Update mode. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDDeleteRel | Deletes a relationship. | Only the DA scope or the |
| | | relationship's owner scope, in |
| | | Shared Update mode or |
| | | Exclusive Update mode. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDDeleteRelVarAttr | Deletes a variable length | Only the DA scope or |
| | attribute value of a | associated scope with Create |
| | relationship. | capability and Modify access |
| | | to the relationship, in Shared |
| | | Update mode or Exclusive |
| | | Update mode. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDModifyRel | Changes attribute values. | Only the DA scope or owner |
| | | scope, or a scope with Create |
| | | capability and Modify access |
| | Changes a link to a common | to the relationship, in Shared |
| | relationship. | Update mode or Exclusive |
| | | Update mode. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDGetRel | Retrieves relationship's | Only the DA scope or a scope |
| SDGetRelVarAttr | attributes and common link, | with Read capability and Read |
| SDGetRelVersionList | variable length attribute | access to the relationship, in |
| | values for a relationship, all | Shared Read mode, Shared |
| | versions of a relationship. | Read-Only mode, Shared Update |
| | | mode, or Exclusive Update |
| | | mode. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDGetRelList | Retrieves all relationships of | Only the DA scope or a scope |
| | the specified relationship | with Read capability, in |
| | type, all of the relationships | Shared Read mode, Shared |
| SDGetAliasRelList | of the specified relationship | Read-Only mode, Shared Update |
| | type that use the input alias | mode, or Exclusive Update |
| | name of a specified alias type | mode. |
| | attribute. | |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDGetLocalRelList | Retrieves all local | Only the DA scope or a scope |
| | relationships linked to a | with Read capability and Read |
| | specified common relationship. | access to the common |
| | | relationship, in Shared Read |
| | | mode, Shared Read-Only mode, |
| | | Shared Update mode, or |
| | | Exclusive Update mode. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| SDFindRelList | Retrieves all relationships | Only the DA scope or a scope |
| | involving a specified set of | with Read capability, in |
| | entities. | Shared Read mode, Shared |
| | | Read-Only mode, Shared Update |
| | | mode, or Exclusive Update |
| | | mode. |
| | | |
-----------------------------------------------------------------------------------------------