Change Object Description (OMQCHGOB)
This Application Program Interface command enables you to
manipulate the OMS database. This can be done from a command line
or from within your own programs.
The command enables you to perform all allowed actions on an
object.
Error Messages
| Message Identifier | Text | Cause | Recovery | Severity |
| CPF0006 | Errors occurred in command. | | | |
| OMQ6001 | Application code &1 does not exist. | You have entered an application code which does not exist. | Enter a valid application code and try your request again. | 10 |
| OMQ5007 | Environment code &1 does not exist in application &2 | Environment &1 does not exist in application &2. | Correct the errors and try your request again. | 10 |
| OMQ101D | IFS-object &2 cannot belong to environment &1. | IFS-Object &3 does not start with a directory that is part of environment &1 | Specify a different directory and try your request again | 30 |
| OMQ100C | Object &2/&1 type &3 not found. | The requested action for object &2/&1 type &3 could not be done because the object was not found. | Add the object and try your request again. If type has the value *IFSOBJ, see the previous messages to determine why the IFS-object could not be found. | 30 |
| OMQ1009 | Object library &3 is not a part of environment &2 in application &1 | Your request has been denied because the object library &3 does not belong to environment &2 in application &1 | Change the object library to a library which belongs to environment &2 in application &1 or change the application- and environment code. | 20 |
| OMQ400E | Solution &3, type &4 not found in fix &2, application &1 | Your request for solution &3, type &4 and detail &5 in fix &2 of application &1 has not been processed because it was not found | Change the parameters and try your request again. | 10 |
Parameters
Action code (ACTC)
Specify the action to be performed on the object. The possible
values are:
*ADD
Use this action code to add a new object to the OMS database.
*CHANGE
Use this action code to change one or more object attributes.
*CLOSE
Use this action code to close the object database and to
perform last record processing. This option enables you to keep
the interface to the object database open until you explicitly
close it. This will make the interface faster.
*DELETE
Use this action code to remove the description from the OMS
object database. You are also able to delete the related object
and source.
*JOBREL
Use this action code to process pending relationship requests
for a certain job. Requests are also queued to build the
relationship database if objects are added to the OMS database.
These requests are processed in batches to make the
relationship search faster.
Example: Three programs are added to the OMS object database.
These programs are called PGMA, PGMB and PGMC. PGMA calls both
PGMB and PGMC. If PGMA is added to the database, a relationship
request is queued for it and the next object (PGMB) is added.
PGMB also places a relationship request in the queue and the
same steps are performed for PGMC. The function now sees that
there are no more objects to be added and starts dequeueing the
relationship requests.
If the relationships of PGMA were determined when the object
was added to the database, both PGMB and PGMC would not yet
exist. This would cause error reporting. This action code
dequeues all requests and starts building the relationships.
*OBJREL
Use this action code to request a relationship rebuild for the
specified object.
*REFILL
Use this action code to request a refresh of the specified
object. If the object was not found in the database it will be
added, or it will be changed according to the user
specifications or the new attributes of the object.
Object code (OBJC)
The object code is the i5/OS system name of an object. The length
is 10 characters for normal objects and 12 for document library
objects.
If the name contains a tilde (ü), it is the short name for an
object in the Integrated File System. You can also have short
name's if your application contains LANSA objects. The details for
the entry show the full name of the object.
*IFSOBJ
Use this value if you want to register an object from the
integrated file system (IFS) instead of the normal OS/400
library structure.
character-value
Specify the object code of the object.
Object Library (OBJL)
The Object Library is the library which contains the object. The
object library can be an i5/OS system library or a logical library.
A logical library is the logical representation of another place
holder, e.g. a folder or a 4GL storage location.
Object type (OBJT)
The object type specifies the type of object. Program objects are
of the type *PGM, file objects are of the type *FILE, etc. Refer to
the IBM i5/OS reference quide for more information.
IFS Object code (IFSOBJ)
IFS Full Path Name
The IFS Full Path Name is a complete reference to an IFS object.
This includes the directory and the object.
*OBJC
Use this value if you want to register an object from the
OS/400 library structure instead of the integrated file system
(IFS).
path-name
Specify a full path name to the object.
Application (APPL)
Specify the application code of the object. The possible values are: *SAME
The application code of the object does not change. This value
is not allowed if an object is first added to the object
database.
application-code
Specify the application code of the object.
Environment (ENVC)
Specify the environment code where the object resides. OMS will
check if the library of the object is defined in the definition of
the specified environment. The possible values are:
*SAME
The environment code of the object does not change. This value
is not allowed if an object is first added to the object
database.
environment-code
Specify the environment code of the object.
Fix number (FIX)
The fix number attribute of the object is not the fix the object is
currently connected to, but the fix which caused the object to be
placed in this environment. The possible values are:
*SAME
The fix number in the object does not change.
*NONE
The solution database is not searched for the fix by which the
object could have been placed in this environment.
*ACTIVE
The solution database is searched and the last fix to which
this object was connected is used as the fix number for this
object. However, if the fix number in the object is already
filled then the fix number does not change.
fix-number
Specify the fix number to be used as the fix number in the
object file. If a fix is specified, it must exist in the OMS
database and the object must be connected to it.
Object description (OBJD)
Specify the description of the object. The possible values are:
*SAME
The description of the object does not change. When the object
is first added to the OMS database the description is taken
from the object's header. This value is not allowed when adding
temporary objects.
*OBJD
The object description is retrieved from the object's header.
This value is not allowed for temporary objects.
object-description
Specify the object's description.
User ID (USID)
Specify the user who created the object. The possible values are:
*SAME
The user does not change. The value is retrieved from the
header of the object if objects are added to the database. This
value is not allowed when adding temporary objects.
*OBJD
The user who created the object is taken from the header of the
object. This value is not allowed for temporary objects.
user ID
Specify a valid AS/400 user ID.
User defined (USDF)
Specify whether the object is added by the user or retrieved by
automated OMS functions as "fill object file" (STRFOF). The
possible values are:
*SAME
The value of the field does not change. If *SAME is used when
the object is first added, the value *YES is assumed.
*YES
The object was added manually.
*NO
The object was not added manually.
Temporary or virtual object (TOVI)
Specify whether the object is a virtual or temporary object or if
it is a real object. The possible values are:
*SAME
The value of the element does not change. If *SAME is used when
the object is first added, the value *NO is assumed.
*NO
The object is not temporary nor virtual. OMS can expect to find
the object in the indicated location. If the object cannot be
found in this location an error is reported.
*YES
The object is virtual or temporary. A temporary object can be a
work file to which programs relate but only exist for the
duration of a job. Virtual objects are mostly used to represent
a real object like a printer or a terminal.
*STUB
The object is not temporary nor virtual but OMS will not look
for the object on disk. This means that you will have to supply
all the attributes just as if this was a virtual object but the
virtual flag is not actually set in the database.
This can be used for creating a stub for an object that will
exist later on like when creating new objects in development.
Object attribute (OBJA)
Specify the attribute of the object. The possible values are:
*SAME
The value of the element does not change. If *SAME is used when
the object is first added, then the attribute is retrieved from
the object's description. This value is not allowed for
temporary objects.
*OBJD
The attribute is retrieved from the object's object
description. This value is not allowed when adding a temporary
object.
attribute
Specify the object attribute. The value you specify here is
only used for temporary objects.
Object class (OCLS)
Specify the class of the object. The class is always determined by
OMS unless the object is temporary. The possible values are:
*SAME
The value of the element does not change. If *SAME is used when
the object is first added, then the class is determined by OMS.
*OS400
The object is an OS/400 object.
*GL4
The object is an object from a fourth generation language.
*HFSOBJ
The object is an object from a hierarchical file system. This
can be a PC object or a document from an AS/400 folder.
Source file (SRCF)
Specify the name of the source file. The possible values are:
*SAME
The value of the element does not change. If *SAME is used when
the object is first added then the source file and library are
determined by OMS.
*NONE
The object does not have a source or the object has a source
but the source is not available. OMS will not try to search for
the object's source if it transfers the object.
*OBJD
The object is initially taken from the object's object
description. OMS will try to locate a better source if one is
available.
source-file-name
Specify the name of the source file.
*SAME
The value of the element does not change. If *SAME is used when
the object is first added then the library is determined by
OMS.
*BEST
OMS will search for the best logical source location and will
issue a report with possible source conflicts.
*OBJD
The library is initially taken from the object's object
description. OMS will try to locate a better source library if
one is available.
source-library-name
Specify the name of the source library.
Source member (SRCM)
Specify the name of the source member. The possible values are:
*SAME
The value of the element does not change. If *SAME is used when
the object is first added then the member is determined by OMS.
*OBJD
The member is initially taken from the object's object
description. OMS will try to locate a better source member if
one is available.
source-member-name
Specify the name of the source member.
Close API indicator (EOPI)
Specify whether the API must close all files and free storage upon
completion of the requested action. The possible values are:
*YES
The files are closed and storage is freed by the API upon
completion of the requested action. Subsequent actions must
open the needed files and programs again.
*NO
The state of the API was left when the requested action was
completed. Files remain open and relationship updates are
postponed. Subsequent calls to the API are considerably faster
and storage is not freed.
Note: Keep in mind that the last action of a series should
close the API in order to close spooled files and do
are used on the data of the queued relationship requests.
Use this value when you are adding more than one object to the
object database and want to postpone the load of the
inter-object relationships until a later time.
*CHANGED
This value is equal to the *DELAYED value but is even more
effective in the sense that the relationship request is only
performed if the object was changed after the last update of
the OMS database.
Note: The *CHANGED and *DELAYED values are by far the most
efficient ways of relationship processing.
Relations indicator (RELI)
Indicate if and how the object's relationships should be (re)build.
The possible values are:
*NO
The relationships are not processed for the indicated object.
This value has no meaning if the action code is one of the
relation processing action codes.
*IMMED
Do an immediate update of the object's relationships. This
value is useful when only one object is added to the object
file.
*DELAYED
The rebuild of the relationships is not done when this value is
used and if the end processing indicator (EOPI) is set to *NO.
Instead the relationship rebuild requests are queued and
processed when either the *CLOSE action code is used, the
command is used again but now with the EOPI indicator set to
*YES or when the relationship action codes *JOBREL and *OBJREL
*ALL
Everything is printed.
Print Indicator (PRTI)
Specify the amount of data to print if a request is made to the
API. The possible values are:
*YES
Indicates that conflicts are reported when they arise.
Successful requests are not printed.
*NO
Nothing is printed.
relationship processing.
Delete object indicator (DLTI)
Specify if the object and the source are also deleted if deletion
of the object in the OMS database is requested.
*NO
The object and the source are not deleted.
*YES
The object will be deleted. The source will only be deleted if
it is not referred to by any other object.
Rebuild relationships job number (JOB)
Specify the job number for which queued relationships must be
processed with action code *JOBREL. Relationship request are queued
in file OMO001W4 in your OMS library. The possible values are:
*CURRENT
The relationship requests placed in the current job are
processed.
job-number
Specify a job number from which the relationships must be
processed.
Print Mutations (PR2I)
Specify if a mutation report must be printed. A mutation is a
difference between the OMS database and the object in the library.
If the time stamps in the OMS database differs from the timestamps
in the actual object description, or the object was removed from
the library or the object was added to the library then a line is
printed on the report. The possible values are:
*NO
The mutations are not printed.
*YES
Mutations are printed.
Include 4GL generated objects (GENI)
Specify, for 4GL objects, if the generated objects also have to be
processed. The possible values are:
*NO
Generated objects are not processed.
*YES
Generated objects are processed.
