Your Browser is not longer supported

Please use Google Chrome, Mozilla Firefox or Microsoft Edge to view the page correctly
Loading...

{{viewport.spaceProperty.prod}}

obj_type=KC_OSI_LPAP

This operation relates to an OSI-LPAP partner, i.e. to the logical properties of an OSI TP partner application or to the connection to this partner application.

In the identification area you must specify the name of the associated OSI-LPAP partner (field kc_name8 of the union kc_id_area). The name is defined during KDCDEF generation in the OSI-LPAP statement for the partner application.

In the data area you must pass the data structure kc_osi_lpap_str with the new values of the properties.


Possible modifications

If the OSI-LPAP is the master LPAP of an OSI-LPAP bundle, you can only modify the state field.

  • Disable an OSI-LPAP partner or release a disabled OSI-LPAP partner.

    It is not possible to make a connection to the partner application via a disabled OSI-LPAP partner.

    Specify the following in the data structure kc_osi_lpap_str:

    Field name     

    Meaning

    state='N'

    The OSI-LPAP partner is to be disabled.
    There must be no current connection to the partner application at the time of the disable operation. You must shut down existing connections before disabling the partner, using a separate call with connect_number='0' or quiet_connect='Y'.
    You cannot shut down the connection and disable the OSI-LPAP partner in a single transaction.

    state='Y'

    The OSI-LPAP partner is to be released, i.e. there is a lock in existence which is to be cancelled.

    Period of validity / transaction management: type GPD ("KC_MODIFY_OBJECT - Modify object properties and application parameters")

  • Increase or reduce the number of connections to the partner application which UTM automatically establishes when the application starts.

    In automatic connection setup, UTM attempts to establish the required number of connections to the partner application whenever the application starts.

    If automatic connection setup is defined in both applications (the local application and the partner application), the connection between the two of them is established automatically as soon as both applications are available.

    Specify the following in the data structure kc_osi_lpap_str:

    Field name                        

    Meaning

    auto_connect_number

    Specify in auto_connect_number the number of connections to the partner application which UTM is to establish automatically when the application next (and subsequently) starts.
    The OSI-LPAP partner via which the partner application connects must not be disabled.
    If you specify auto_connect_number = '0', automatic connection setup does not occur when the application next starts.
    If a number is specified that is greater than the generated maximum number of parallel connections (see field associations in kc_osi_lpap_str), then, on the next start, UTM attempts to establish all generated parallel connections (= number in associations). The value specified in auto_connect_number must, however be less than or equal to '32767'.

    Minimum value: '0'.
    Maximum value: generated maximum number of parallel connections (associations)

    Period of validity / transaction management: type GPD ("KC_MODIFY_OBJECT - Modify object properties and application parameters")

  • Increase or decrease the number of parallel connections that should currently exist between the UTM application and the partner application; i.e. additional connections can be established or some of the existing connections can be shut down. Setting up additional connections is only possible if the maximum number of parallel connections to the partner application generated with KDCDEF has not already been established.

    Specify the following in the data structure kc_osi_lpap_str:

    Field name                

    Meaning

    connect_number

    Specify in connect_number the total number of connections to the partner application that should exist. The effect of the call is thus determined by what is specified for connect_number. Distinctions must be drawn between the following situations:

    • If you specify a number in connect_number which is less than the number of parallel connections that are currently established, UTM shuts down connections to the partner application until only connect_number connections are in existence.
      To begin with, UTM shuts down any connections that are not currently reserved by jobs. When this has been done, if there are still more connections open than the number specified in connect_number, then UTM begins to also shut down connections that are reserved by jobs.
      Any currently active services or conversations are aborted when this happens.
      If you specify connect_number = '0', UTM shuts down all connections to the partner application.

    • If you specify a number in connect_number which is greater than the number of parallel connections that are currently established, UTM attempts to establish further connections to the partner application until a total of connect_number connections are in existence. However, the maximum number of parallel connections which UTM will establish to the partner application is that established during KDCDEF generation for the OSI-LPAP partner belonging to the partner application. This maximum number is returned when information is requested in the associations field of kc_osi_lpap_str.
      In other words, if connect_number > associations, then UTM only establishes the generated maximum number of connections.

    If connections are to be established to a disabled OSI-LPAP partner, you must re-enable this partner beforehand (see state field). The OSI-LPAP partner must be released in a separate KC_MODIFY_OBJECT.
    connect_number and quiet_connect cannot be specified together in a single KC_MODIFY_OBJECT call. Likewise, connect_number must not be specified together with state='N'.

    Minimum value: '0'
    Maximum value: the number returned by UTM in associations; a numeric value greater than '32767' will be rejected.

    Period of validity / transaction management: type A ("KC_MODIFY_OBJECT - Modify object properties and application parameters")

  • Shut down all parallel connections to the partner application.

    You can instruct UTM to shut down all connections immediately or to assign the property QUIET to the connections. QUIET means that UTM shuts down the connection to the partner application as soon as the partner application is no longer occupied by jobs (dialog or asynchronous jobs). No further new dialog jobs are accepted. New asynchronous jobs are accepted, but no longer sent; they remain in the output queue.

    Field name                      

    Meaning

    connect_number='0'

    If you specify connect_number = '0', UTM shuts down all connections to the partner application.
    The connections are shut down even if there are active services or conversations on the connection. These are aborted. It is thus better to shut down connections with quiet_connect = 'Y'.

    Period of validity / transaction management: type A ("KC_MODIFY_OBJECT - Modify object properties and application parameters")

    Field name                  

    Meaning

    quiet_connect='Y'

    The property QUIET is set for the connections to the partner application.
    The property QUIET can be reset with connect_number > '0'.

    Period of validity / transaction management: type IR ("KC_MODIFY_OBJECT - Modify object properties and application parameters")

    connect_number and quiet_connect cannot be set concurrently within a single KC_MODIFY_OBJECT call.

  • Modify the period of time for which the idle state of the UTM application association to the partner application is monitored. In other words, if the association is not occupied by a job, UTM waits for this period of time before UTM shuts down the connection.

    Specify the following in the data structure kc_osi_lpap_str:

    Field name               

    Meaning

    idletime_sec[5]

    Specify in idletime_sec the time in seconds for which UTM is to monitor the idle state of an association to the partner application.
    idletime_sec = '0' means that the idle state it not monitored.
    Maximum value: '32767'
    Minimum value: '0',
    In the case of values that are smaller than 60 but not equal to 0 then the value 60 is used.

    Period of validity / transaction management: type GPD ("KC_MODIFY_OBJECT - Modify object properties and application parameters")

    The modification of the timer takes effect when the association next reaches the idle state, but not before the end of the program unit run (PEND) in which the call is processed.

  • Enables/disables the saving of asynchronous messages in the dead letter queue for this OSI-LPAP partner. This can prevent the loss of messages for this LPAP partner in case of permanent errors.

    Specify the following in the data structure kc_osi_lpap_str:

    Field name                   

    Meaning

    dead_letter_q='Y'

    Asynchronous messages to this OSI-LPAP partner which could not be sent because of a permanent error are saved in the dead letter queue, as long as (in case of message complexes) no negative confirmation job was defined.

    dead_letter_q='N'

    Asynchronous messages to this OSI-LPAP partner which could not be sent because of a permanent error are not saved in the dead letter queue but deleted.

    Period of validity / transaction management: type GPD ("KC_MODIFY_OBJECT - Modify object properties and application parameters")