OpenTP1 Version 7 System Definition

[Contents][Index][Back][Next]

mcfaalcap (Application attribute definition)

Format

mcfaalcap -n "name=application-name|MCF-event-name
             [kind=user|mcf]
             [type=ans|noans|cont]
             [aplihold=m|a|s]
             [msgcnt=maximum-storable-input-message-count]
             [lname=logical-terminal-name]
             [cname=internal-communication-path-name]
             [tempsize=continuous-inquiry-response-temporary-data-
                       storage-area-size]
             [trnmode=trn|nontrn]
             [errevt=yes|no]"
         [-N  "modelname=model-application-name|model-MCF-event-name"]
          -g "servgrpn=service-group-name
             [quegrpid=queue-group-ID]
             [quekind=memory|disk]
             [type=MHP|SPP]
             [srvghold=m|s]
             [recvmsg=e|r]"
          -v "servname=service-name
             [servhold=m|a|s]
             [ntmetim=nontransaction-MHP-expiration-time]"
         [-d "[holdlimit=maximum-application-abnormal-termination-
                         count]
              [holdlmtyp=sum|cont]"]
         [-j "[ij=yes|no]
              [oj=yes|no]
              [gj=yes|no]"]
         [-e "evtlogout=yes|no"]

Function

This command defines the attributes of an application.

Options

-n

(Operands)

name=application-name|MCF-event-name~<1-8 character identifier>
Specify the name of the application or MCF event. Each name specified with each name operand of all mcfaalcap commands within each kind of application as specified with the following kind operand, must be unique.
To start up the MHP directly with the mcfuevt command, specify UCMDEVT.
To throw some ERREVT2 events and all ERREVT3 events, an application startup process is required. To accomplish this, create an MCF communication configuration definition for the application startup process.

kind=user|mcf~<<user>>
Specify the kind of application. It cannot be specified if SPP is specified in the type operand of the -g option:
user
User application
mcf
MCF event
To start up the MHP directly with the mcfuevt command, specify user or omit specification. If this operand is incorrectly specified, the MCF definition object generation utility startup command (mcfapli command) displays the KFCA11513-E message and terminates the system abnormally.

type=ans|noans|cont~<<noans>>
Specify the type of application. It cannot be specified if SPP is specified in the type operand of the -g option.
ans
Response type.
noans
No-response type.
cont
Continuous inquiry-response type.
This operand need not be specified if MCF event name is specified with the above name operand.
MCF automatically sets the format as follows:
  1. For ERREVT1 (MCF event that reports detection of an invalid application-name), MCF sets the format to correspond to the terminal type of the logical terminal making the request, that is, to ans for reply type logical terminals and to noans for non-reply type logical terminals.
  2. For ERREVT2 (MCF event that reports the discarding of a message), ERREVT3 (MCF event that reports UAP abnormal termination), or ERREVT4 (MCF event that reports the discarding of a timer-start message), continues the type of the application causing the event,
  3. For all other MCF events, sets the type as noans.
    Should an abnormality occur, the MCF event corresponding to the started communication process will be activated. An event will also be activated for the first process of multiple MCF application definitions started using the application startup function.
    Should an application be started from SPP, but there is no started communication process, an MCF event corresponding to the application startup process will be activated.
    To start up the MHP directly with the mcfuevt command, specify noans or omit specification. If this operand is incorrectly specified, the MCF definition object generation utility startup command (mcfapli command) displays the KFCA11513-E message and terminates the system abnormally.

aplihold=m|a|s~<<m>>
Specify action of the application should it terminate abnormally.
It cannot be specified if SPP is specified in the type operand of the -g option.
m
Application is not shut down.
a
Application is shut down. Further input and scheduling is prohibited.
s
Application is shut down. Further scheduling is prohibited.

msgcnt=maximum-storable-input-message-count~<unsigned integer> ((0-65535)) <<0>>
Specify the maximum storable number of input messages. It cannot be specified if SPP is specified in the type operand of the -g option. Specify 0 for an indefinite number of messages to be stored in memory or on disk.

lname=logical-terminal-name~<1-8 character identifier>
Specify the name of the logical terminal on the internal communication path, if using the application startup function. This operand can be specified only in the following cases:
  • noans is specified for the type operand with the -n option
  • SPP is specified for the type operand with the -g option
Use the name registered with the mcftalcle command of the MCF communication configuration definition corresponding to the application startup process. Specify only a send type logical terminal.
The logical terminal specified here is used to exchange messages when starting one application from another application.
For the definition method when the application start function is used, see the description of the cname operand.

cname=internal-communication-path-name~<1-8 character identifier>
Specify the name of the internal communication path, if using the application startup function, but only if ans or cont was specified for the type operand. It cannot be specified if SPP is specified in the type operand of the -g option.
Use the name registered with the mcftpsvr command of the MCF communication configuration definition.
Messages will be exchanged using an appropriate inquiry-type logical terminal on this path, if starting this application from another application. Accordingly, one or more inquiry-type logical terminals must be defined with the logical terminal definition.
Table 5-1 shows the definition method when the application start function is used.

Table 5-1 Definition method when the application start function is used

Start-source application program Start-destination application program
noans type MHP ans type MHP cont type MHP SPP
noans type MHP LNAME N N LNAME
ans type MHP LNAME CNAME N LNAME
cont type MHP LNAME N CNAME LNAME
SPP LNAME N N LNAME

Legend:
LNAME: Specify the send type logical terminal name on the internal communication path for the lname operand of the mcfaalcap definition command at the start destination.
CNAME: Specify an internal communication path name for which at least one request type logical terminal is defined, for the cname operand of the mcfaalcap definition command at the start destination.
N: Cannot be specified because the application start function cannot be used.

tempsize=continuous-inquiry-response-temporary-data-storage-area-size~ <unsigned integer> ((1-32000)) <<4096>> (Unit: bytes)
Specify the size of the area for temporary data storage used with continuous inquiry-response operation.
This operand is valid only if cont is specified with the type operand. It cannot be specified if SPP is specified in the type operand of the -g option.

trnmode=trn|nontrn~<<trn>>
Specify the transaction attribute of an application. This cannot be specified if SPP is specified in the type operand of the -g option.
trn
The MHP process is managed as a transaction.
When you specify trn, specify Y in the atomic_update operand of the user service definition of the MHP.
nontrn
The MHP process is not managed as a transaction.
The memory queue is used for reception and transmission.

errevt=yes|no~<<no>>
If you discard a communication event is received or if the MHP for handling communication events is abnormally terminated, you can be notified of an error event (by using the facility for reporting a communication error event).
yes
Notifies you of an error event.
no
Does not notify you of an error event.
This operand takes effect when you specify a communication event in the name operand. If you specify an error event (ERREVT1, ERREVT2, ERREVT3, ERREVT4 or ERREVTA) in the name operand, this operand is ignored. You cannot specify this operand if you specify SPP in the type operand of the -g option, if you do not specify the kind operand in the -n option, or if you specify user in the kind operand of the -n option.

-N

(Operands)

modelname=model-application-name|model-MCF-event-name ~<1-to-8-character identifier>
Specify the name of the application or MCF event whose application attribute definition contains the attributes to be reused to create the new application attribute definition. Note that the application attribute definition for the specified application or MCF event must have been specified before the new application attribute definition is specified.
When you specify the modelname operand, you can omit options and operands other than the name operand in the -n option.
When you omit options and operands, the corresponding options and operands in the application attribute definition for the application or MCF event specified in the modelname operand are reused.
The options and operands that you do not omit use the values you specify.
Note that you can specify this operand only once. Also note that the specified model application or MCF event might conflict with the entries that are not omitted. If there are conflicts, the correlation check reports errors. To ensure that the application attribute definition you are creating has no conflicts, do not specify the following operands with values different from the values of the corresponding operands in the model definition:
  • The type operand in the -n option
  • The type operand in the -g option
  • The quekind operand in the -g option

-g

(Operands)

servgrpn=service-group-name~<1-31 character identifier>
Specify the name of the service group corresponding to the application name. Use the name specified with the user service definition.
For application attribute definitions that have different UAP types (indicated by the value specified for the type operand with the -g option) under one MCF application definition, specify service group names that are unique.
Definition examples follow:
[Valid definition example]
mcfaalcap -g  "servgrpn   =sg01        \
               type        =MHP"       \
          -v  "servname   =sv01"
 
mcfaalcap -g  "servgrpn   =sg01        \
               type        =MHP"       \
          -v  "servname   =sv02"
In this example, identical service group names can be specified because all UAPs are of the same type.
[Invalid definition example]
mcfaalcap -g  "servgrpn   =sg01        \
               type        =MHP"       \
          -v  "servname   =sv01"
 
mcfaalcap -g  "servgrpn   =sg01        \
               type        =SPP"       \
          -v  "servname   =sv02"
This is an example of invalid specification because identical service group names are used even though application attribute definitions have different UAP types.

quegrpid=queue-group-ID~<1-8 character identifier>
Specify the ID of the queue group for received messages. Use one of the IDs (queue kind is itq) specified with the mcfmqgid command of the MCF manager definition. It cannot be specified if SPP is specified in the type operand of the -g option.
This operand can only be specified if disk is specified with the quekind operand.
Note:
You cannot define different queue groups for one service group. If you do so, the KFCA11008-W message is output. If you attempt to do so, the service group is redefined as the queue group that was already defined at MCF startup.

quekind=memory|disk~<<memory>>
Specify the allocation destination (memory queue or disk queue) for the received messages. It cannot be specified if SPP is specified in the type operand of the -g option.
memory
Messages are allocated to the memory queue.
disk
Messages are allocated to the disk queue. For this, the quegrpid operand must be specified.
If disk is specified to start up the MHP directly with the mcfuevt command, UCMDEVT may be re-scheduled after rerun. If nontrn is specified in the trnmode operand of the -n option, disk cannot be specified.

type=MHP|SPP~<<MHP>>
Specify the type of the UAP that corresponds to the specified service group.
Specify the same type that is specified in the user service definition or the user service default definition.
MHP
The UAP type is MHP.
SPP
The UAP type is SPP.
If SPP is specified, some of the operands of the application definition cannot be specified. Table 5-2 shows the operands of the application definition that can or cannot be specified at SPP startup.

Table 5-2 Operands of application definition that can be or cannot be specified at SPP startup

Option Operand Specification
-n name Y
kind --
type --
aplihold --
msgcnt --
lname Y
cname --
tempsize --
trnmode --
errevt --
-g servgrpn Y
quegrpid --
quekind --
type Y
srvghold --
recvmsg --
-v servname Y
servhold --
ntmetim --
-d holdlimit --
holdlmtyp --
-j ij --
oj --
gj --
-e evtlogout --

Legend:
Y: Item that can be specified with SPP specified in the type operand of the -g option.
--: Item that cannot be specified with SPP specified in the type operand of the -g option.

srvghold=m|s~<<m>>
Specify the disposal of the service group if the application terminates abnormally. This operand cannot be specified if SPP is specified in the type operand of the -g option.
If the user service ends abnormally before the applicable application starts, the service group may be shut down according to the value specified in the term_watch_time operand in the user service definition or the user service default definition.
m
Service group is not shut down.
s
Service group is shut down. Further scheduling is prohibited.

recvmsg=e|r~<<e>>
Specify how to handle the receive message of the abnormally terminated UAP.
This operand cannot be specified if SPP is specified in the type operand of the -g option. This operand is valid when the service group, for which s is specified in the srvghold operand, is shut down.
e
The messages output during processing are replaced with error events.
r
At automatic shutdown, the message being processed is re-registered in the beginning of the schedule queue and waits to be scheduled. However, this operand is valid only when disk is specified in the quekind operand of the -g option. When memory is specified, the message is scheduled as ERREVT2, which occurs at shutdown.
This operand does not guarantee the correct sequence of the schedule.

-v

(Operands)

servname=service-name~<1-31 character identifier>
Specify the name of the service corresponding to the application name. Use the service name specified in the user service definition.
For application attribute definitions that have different UAP types (indicated by the value specified for the type operand with the -g option) under one MCF application definition, specify service names that are unique regardless of what service group names are specified.
Definition examples follow:
[Valid definition example]
mcfaalcap -g  "servgrpn   =sg01        \
               type        =MHP"       \
          -v  "servname   =sv01"
 
mcfaalcap -g  "servgrpn   =sg02        \
               type        =MHP"       \
          -v  "servname   =sv01"
In this example, identical service group names can be specified because all UAPs are of the same type.
[Invalid definition example]
mcfaalcap -g  "servgrpn   =sg01        \
               type        =MHP"       \
          -v  "servname   =sv01"
 
mcfaalcap -g  "servgrpn   =sg02        \
               type        =SPP"       \
          -v  "servname   =sv01"
This is an example of invalid specification because same service names are used when application attribute definitions have different UAP types.

servhold=m|a|s~<<m>>
Specify the action of the service should the application terminate abnormally. It cannot be specified if SPP is specified in the type operand of the -g option.
m
Service is not shut down.
a
Service is shut down. Further input and scheduling is prohibited.
s
Service is shut down. Further scheduling is prohibited.

ntmetim=nontransaction-MHP-expiration-time~<unsigned integer> ((0-65535)) (Unit: seconds)
To monitor a nontransaction MHP process for looping and hanging-up, the ntmetim operand specifies the maximum expiration time for the process.
If 0 is specified, no time monitoring is performed.
If the nontransaction MHP process does not terminate within the specified expiration time, it is terminated abnormally.
If this operand is omitted, the value of the ntmetim operand of the mcfmuap command of MCF manager definition is assumed.
The operand is valid with nontrn specified in the trnmode operand of -n option. It cannot be specified if SPP is specified in the type operand of the -g option.

-d

(Operands)

holdlimit=maximum-application-abnormal-termination-count~<unsigned integer> ((1-65535)) <<1>> (Unit: times)
Specify the maximum number of abnormal terminations of an application. If the number of abnormal terminations reaches the value specified by this operand, the application, service, or service group is shut down. This operand is valid only when the aplihold operand of the -n option or the servhold operand of the -v option specifies a or s, or when the srvghold operand of the -g option specifies s. This operand cannot be specified if SPP is specified in the type operand of the -g option.

holdlmtyp=sum|cont~<<cont>>
Specify the method for counting the number of abnormal terminations of an application as specified in the holdlimit operand. It cannot be specified if SPP is specified in the type operand of the -g option.
sum
The cumulative number of abnormal terminations of an application is counted.
The counter is reset at the following times:#
  • When the mcfaactap command is executed
  • When the mcfaclcap command is executed
  • When OpenTP1 is terminated or started
cont
The number of consecutive abnormal terminations of an application is counted.
The counter is reset at the following times:#
  • When the mcfaactap command is executed
  • When a shutdown is caused by the mcfaalcap definition
  • When the mcfaclcap command is executed
  • When the MHP service function has terminated normally
  • When OpenTP1 is terminated or started
#
The counter is not reset by the dcsvstop command, the dcsvstart command, or a shutdown release command.

-j

(Operands)

ij=yes|no~<<no>>
Specify whether historical data (IJ) should be collected if messages received from another system are registered in the input queue. It cannot be specified if SPP is specified in the type operand of the -g option. This operand is invalid if mcf is specified with the kind operand of the -n option.
The messages received by the synchronous transmission function (dc_mcf_sendrecv function) not via the input queue are not collected as historical data.
yes
Historical data is collected.
no
Historical data is not collected.

oj=yes|no~<<no>>
Specify whether historical data (OJ) should be collected if a SEND request is received from an UAP. It cannot be specified if SPP is specified in the type operand of the -g option. This operand is invalid if mcf is specified with the kind operand of the -n option.
yes
Historical data is collected.
no
Historical data is not collected.

gj=yes|no~<<no>>
Specify whether historical data (GJ) should be collected if a RECEIVE request is received from an UAP. It cannot be specified if SPP is specified in the type operand of the -g option. This operand is invalid if mcf is specified with the kind operand of the -n option.
The messages sent by the synchronous transmission function (dc_mcf_sendrecv function) not via the output queue are not collected as historical data.
yes
Historical data is collected.
no
Historical data is not collected.

-e

evtlogout=yes|no~<<no>>
Specify whether to output a log message when generating ERREVT1 to ERREVT4.
You cannot specify this operand when SPP is specified in the type operand of the -g option.
This operand takes effect only when mcf is specified in the kind operand of the -n option and ERREVT1 to ERREVT4 is specified in the name operand of the -n option.
yes
Outputs a log message.
The following items are output in the log message as well as the KFCA11194-I message:
  • MCF identifier
  • Error event name
  • Reason code
  • Name of the application that caused the generation of the error event
For details about the KFCA11194-I message, see the manual OpenTP1 Messages.
If you specify trn in the trnmode operand, Hitachi recommends that you use the trn_rollback_information_put operand in the user service definition to specify that rollback reason log information is to be acquired. This information may be necessary to determine why ERREVT3 has occurred.
no
Does not output a log message.