REPORT ENTITY [ HP SYSTEM DICTIONARY XL SDMAIN ] MPE/iX 5.0 Documentation
HP SYSTEM DICTIONARY XL SDMAIN
REPORT ENTITY
Reports on one or more entities.
Syntax
REP[ORT] E[NTITY] [entity-name]
;E[NTITY-]T[YPE] = entity-type-name
[;A[TTRIBUTE-]L[IST]=([ attribute-name1=[attribute-value1]]
[,attribute-name2=[attribute-value2]]
.
.
.
[,attribute-nameN=[attribute-valueN]])]
[;C[OMMON]= [common-entity-name]]
[;ALL ]
[;NAME[-ONLY] ]
[;L[IST] = information-list]
[;NO[SORT]]
[;SUB[-REPORT] = (nested-execute1
[ [,] nested-execute2]
.
.
.
[ [,] nested-executeN])]
Parameters
entity-name Name of the entity to be reported.
entity-type-name Name of the type of the entity to be reported. No
selection criteria are allowed.
attribute-name(N) Attribute of the specified entity type. No
selection criteria are allowed. For any attribute
whose name is not included here, there is no
qualification on the value of the attribute.
You cannot quality variable length attributes,
therefore, you cannot specify them here.
attribute-value(N) Value for the attribute of the entity to be
reported. If you omit attribute-value(N), there is
no qualification on the value for the corresponding
attribute (as if the attribute-name was not
specified at all).
common-entity-name If in a local domain, it is the name of the common
domain entity linked to the local domain entity to
be reported. If in the common domain, it is the
name of the local domain entity linked to the
entity in the common domain to be reported.
Specifying COMMON without a keyword value requests
a match to all entities that do not have a common
link.
ALL Reports all information about the entity that the
scope capabilities and sensitivity allow.
NAME-ONLY Reports only the name of the entities.
information-list A list of the information about the entity that is
desired. You can specify each piece of information
available in the ALL option individually so you can
tailor the information returned. You can specify
one or more of the following items:
name Reports the name of the entity
(the name is always printed
even if this choice is omitted)
attribute(1) Reports the value of the
specified attribute that is
linked to the entity type. The
names are listed if a subset of
the attributes is desired.
attribute(N)
attributes Reports the value of all
attributes linked to the entity
type. If this option is
chosen, any specific attribute
name that has been listed is
ignored.
scope-access Reports the access the current
scope has to the entity.
primary Reports the primary name of the
entity.
common If in a local domain, common
reports the name of the entity
in the common domain to which
this entity is linked. If in a
common domain, common reports
all entities in a local domain
linked to this entity in the
common domain.
synonyms Lists all of the synonyms for
the entity.
versions Lists all of the versions
having a copy of the entity.
scopes Lists all of the scopes having
access to the entity.
relationdata Reports the name and attribute
values of the relationship
followed for a nested report.
This option is chosen in the
nested report, and is ignored
if specified in the top level
of a report.
relationships List all the relationships
involving the entity.
The above information is listed if the scope
capabilities and the sensitivity of the entity
allow the necessary access. If the capabilities or
sensitivity do not allow access to some piece of
information, then that information is skipped and
processing continues with the next piece.
This clause with LIST = name, attributes is the
default if you do not specify any of the three
listing options (ALL, LIST, or NAME-ONLY).
NOSORT Reports on the entities in the unsorted order in
which they are retrieved from the dictionary.
Otherwise, the entities are sorted alphabetically
by the entity name.
nested-execute(N) This parameter allows a nested EXECUTE command that
produces a sub-report to the report being generated
by this command. (See the syntax for the Nested
EXECUTE in this chapter for a more detailed
description of this capability.)
Description
Do not specify an entity-name if this command is being saved (i.e., is
inside a START/SAVE pair). If specified within a START/SAVE pair, the
entity-name will be ignored.
Remember, you can use selection criteria (see "Selection Criteria" in
Chapter 3) in most fields to qualify the entities that are retrieved.
Open Mode: Read-only, shared-update, or exclusive-update
Scope: DA scope or any scope with read access to the entity
Example
The following example produces a report that lists information on the
image-database named info-network-division. The information reported was
limited to a specific subset including the values of several attributes,
the access the current scope has to the entity, and the names of other
scopes that have access.
>REPORT ENTITY info-network-division;
>>ENTITY-TYPE = image-database;
>>LIST = name, scope-access, sensitivity, id-number, image-database-type
>>scopes, date-created, scope-owner.
INFO-NETWORK-DIVISION
Scope-Access : OWNER
DATE-CREATED : 11/11/84 6:25 PM
SCOPE-OWNER : DA
SENSITIVITY : PRIVATE
ID-NUMBER : 0
IMAGE-DATABASE-TYPE : IMAGE
Scopes : PERSONNEL, SALES
1 Entity(ies) Retrieved
>
Example
The following example lists the names of all entities of the entity type
element that have the name p-no as the image alias.
>REPORT ENTITY;
>>ENTITY-TYPE=element;
>>ATTRIBUTE-LIST=(image-alias=p-no);
>>NAME-ONLY.
0 Entity(ies) Retrieved
>
MPE/iX 5.0 Documentation