Skip to end of metadata
Go to start of metadata

csdAdd()  

Description:  Add a group to a list in the CSD.

This method is currently not supported and will be supported in a future release of HostBridge. 

Properties:

NameTypeMaximum LengthInput/Output
afterstring8Input
beforestring8Input
groupstring8Input
liststring8Input

Corresponding CICS Command Level API command reference:  EXEC CICS CSD ADD

Example: 

// to be generated 

csdAlter()  

Description:  Change the attributes of an existing resource definition in the CSD.

This method is currently not supported and will be supported in a future release of HostBridge. 

Properties:

NameTypeMaximum LengthInput/Output
attributesstring1024Input
attrlennumericfullword binaryInput
compatmodeCVDA
Input
groupstring8Input
residstring8Input
restypeCVDA
Input

attributes and attrlen are required fields even if there are no attributes to specify; in that event, specify a one byte blank value for attributes and a value of 0 for attrlen. 

There are special rules for the returned value eibresp2 for this method.  See the example below for how to properly expose this value.


Corresponding CICS Command Level API command reference:  EXEC CICS CSD ALTER

Example: 

// to be generated 

Here are the valid CVDA values for the fields above:

compatmode - COMPAT (107)
                         NOCOMPAT (108) (default)

restype - ATOMSERVICE (1179)
               BUNDLE (1180)
               CONNECTION (755)
               CORBASERVER (1141)
               DB2CONN (1142)
               DB2ENTRY (1143)
               DB2TRAN (1184)
               DJAR (1189)
               DOCTEMPLATE (1145)
               ENQMODEL (1188)
               FILE (238)
               IPCONN (1176)
               JOURNALMODEL (1185)
               JVMSERVER (1193)
               LIBRARY (1177)
               LSRPOOL (1152)
               MAPSET (155)
               MQCONN (1175)
               PARTITIONSET (156)
               PARTNER (1182)
               PIPELINE (1124)
               PROCESSTYPE (1190)
               PROFILE (157)
               PROGRAM (154)
               REQUESTMODEL (1157)
               SESSIONS (1187)
               TCPIPSERVICE (1166)
               TDQUEUE (767)
               TERMINAL (213)
               TRANCLASS (1169)
               TRANSACTION (1171)
               TSMODEL (1183)
               TYPETERM (1186)
               URIMAP (1173)
               WEBSERVICE (1174)

csdCopy()  

Description:  Copy a resource definition in a group to a different group, or copy an entire group.

This method is currently not supported and will be supported in a future release of HostBridge. 

Properties:

NameTypeMaximum LengthInput/Output
asstring8Input
dupactionCVDA
Input
groupstring8Input
residstring8Input
restypeCVDA
Input
tostring8Input

Corresponding CICS Command Level API command reference:  EXEC CICS CSD COPY

Example: 

// to be generated 

Here are the valid CVDA values for the fields above:

dupaction - DUPERROR (106) (Default)
                    DUPNOREPLACE (105)
                    DUPREPLACE (104)

restype - ATOMSERVICE (1179)
               BUNDLE (1180)
               CONNECTION (755)
               CORBASERVER (1141)
               DB2CONN (1142)
               DB2ENTRY (1143)
               DB2TRAN (1184)
               DJAR (1189)
               DOCTEMPLATE (1145)
               ENQMODEL (1188)
               FILE (238)
               IPCONN (1176)
               JOURNALMODEL (1185)
               JVMSERVER (1193)
               LIBRARY (1177)
               LSRPOOL (1152)
               MAPSET (155)
               MQCONN (1175)
               PARTITIONSET (156)
               PARTNER (1182)
               PIPELINE (1124)
               PROCESSTYPE (1190)
               PROFILE (157)
               PROGRAM (154)
               REQUESTMODEL (1157)
               SESSIONS (1187)
               TCPIPSERVICE (1166)
               TDQUEUE (767)
               TERMINAL (213)
               TRANCLASS (1169)
               TRANSACTION (1171)
               TSMODEL (1183)
               TYPETERM (1186)
               URIMAP (1173)
               WEBSERVICE (1174)


csdDefine()  

Description:  Create a new resource definition in the CSD.

Properties:

NameTypeMaximum LengthInput/Output
attributesstring1024Input
attrlennumericfullword binaryInput
compatmodeCVDA
Input
groupstring8Input
residstring8Input
restypeCVDA
Input

attributes and attrlen are required fields even if there are no attributes to specify; in that event, specify a one byte blank value for attributes and a value of 0 for attrlen. 

There are special rules for the returned value eibresp2 for this method.  See the example below for how to properly expose this value.


Corresponding CICS Command Level API command reference:  EXEC CICS CSD DEFINE

Example: 

var cics = new Cics();
var csdDefine = new Object();
var common = require('common', 'hbutils');
var debugging = require('debugging', 'hbutils');
var leadzero = '00000000';  // needed to get exactly an 8 character hex field with leading zeroes for eibresp2
/*
 * Set up input  
 */
var csdDefine =
    {       
		restype : 154,
		resid : 'JHBTEST1',
		group : 'UNITTEST',
		attributes : 'LANGUAGE(COBOL)',
		attrlen : 15
    }    
/* 
 * Try to define the program
 */
try
{
	cics.exec.csdDefine ( csdDefine ) ;  
}
 
catch ( e )  // the following will display any return codes that are returned from the call, which equate to the EIBRESP and EIBRESP2 values returned from the request
{
    writeln(debugging.object(e, 'Error Object'));
}
/*
 * Iterate over all of the properties
 */  
for (var prop in csdDefine) {
    writeln('\t', prop, ' = ', csdDefine[prop]);
}
workfield1 = cics.eib.eibresp2;                      // get special eibresp2 field for CSD define construct
workfield2 = workfield1.toString(16);                // convert it to hex string	
workfield3 = leadzero.concat(workfield2);            // add enough leading zeroes in front to ensure at least 8 characters (4 bytes)
workfield4 = workfield3.slice(-8);                   // take only last 8 characters
workfield5 = workfield4.substring(0,4);              // split the string...
workfield6 = workfield4.substring(4,8);              // ...into 2 4 character fields
eibresp2Part1 = parseInt(workfield5,16);             // this is first two bytes of eibresp2
eibresp2Part2 = parseInt(workfield6,16);             // this is second two bytes of eibresp2
writeln('Eibresp2 field part 1 ', eibresp2Part1);
writeln('Eibresp2 field part 2 ', eibresp2Part2); 

Here are the valid CVDA values for the fields above:

compatmode - COMPAT (107)
                         NOCOMPAT (108) (default)

restype - ATOMSERVICE (1179)
               BUNDLE (1180)
               CONNECTION (755)
               CORBASERVER (1141)
               DB2CONN (1142)
               DB2ENTRY (1143)
               DB2TRAN (1184)
               DJAR (1189)
               DOCTEMPLATE (1145)
               ENQMODEL (1188)
               FILE (238)
               IPCONN (1176)
               JOURNALMODEL (1185)
               JVMSERVER (1193)
               LIBRARY (1177)
               LSRPOOL (1152)
               MAPSET (155)
               MQCONN (1175)
               PARTITIONSET (156)
               PARTNER (1182)
               PIPELINE (1124)
               PROCESSTYPE (1190)
               PROFILE (157)
               PROGRAM (154)
               REQUESTMODEL (1157)
               SESSIONS (1187)
               TCPIPSERVICE (1166)
               TDQUEUE (767)
               TERMINAL (213)
               TRANCLASS (1169)
               TRANSACTION (1171)
               TSMODEL (1183)
               TYPETERM (1186)
               URIMAP (1173)
               WEBSERVICE (1174)

csdDelete()  

Description:  Delete a member from a group in the CSD.

Properties:

NameTypeMaximum LengthInput/Output
groupstring8Input
listactionCVDA
Input
residstring8Input
restypeCVDA
Input


Corresponding CICS Command Level API command reference:  EXEC CICS CSD DELETE

Example: 

var cics = new Cics();
var csdDelete = new Object();
var common = require('common', 'hbutils');
var debugging = require('debugging', 'hbutils');
/*
 * Set up input  
 */
var csdDelete =
    {       
		restype : 154,
		resid : 'JHBTEST1',
		group : 'UNITTEST',
		listaction: 276
    }    
/* 
 * Try to delete the program
 */
try
{
	cics.exec.csdDelete ( csdDelete ) ;  
}
 
catch ( e )  // the following will display any return codes that are returned from the call, which equate to the RESP and RESP2 values returned from the request
{
    writeln(debugging.object(e, 'Error Object'));
}
/*
 * Iterate over all of the properties
 */  
for (var prop in csdDelete) {
    writeln('\t', prop, ' = ', csdDelete[prop]);
}

Here are the valid CVDA values for the fields above:

listaction - REMOVE (276)

restype - ATOMSERVICE (1179)
               BUNDLE (1180)
               CONNECTION (755)
               CORBASERVER (1141)
               DB2CONN (1142)
               DB2ENTRY (1143)
               DB2TRAN (1184)
               DJAR (1189)
               DOCTEMPLATE (1145)
               ENQMODEL (1188)
               FILE (238)
               IPCONN (1176)
               JOURNALMODEL (1185)
               JVMSERVER (1193)
               LIBRARY (1177)
               LSRPOOL (1152)
               MAPSET (155)
               MQCONN (1175)
               PARTITIONSET (156)
               PARTNER (1182)
               PIPELINE (1124)
               PROCESSTYPE (1190)
               PROFILE (157)
               PROGRAM (154)
               REQUESTMODEL (1157)
               SESSIONS (1187)
               TCPIPSERVICE (1166)
               TDQUEUE (767)
               TERMINAL (213)
               TRANCLASS (1169)
               TRANSACTION (1171)
               TSMODEL (1183)
               TYPETERM (1186)
               URIMAP (1173)
               WEBSERVICE (1174)

csdInstall()  

Description:  Install a group, or a single resource definition in a group, from the CSD. 

Properties:

NameTypeMaximum LengthInput/Output
groupstring8Input
liststring8Input
residstring8Input
restypeCVDA
Input
There are special rules for the returned value eibresp2 for this method.  See the example below for how to properly expose this value.

Corresponding CICS Command Level API command reference:  EXEC CICS CSD INSTALL

Example: 

var cics = new Cics();
var csdInstall = new Object();
var common = require('common', 'hbutils');
var debugging = require('debugging', 'hbutils');
var leadzero = '00000000';  // needed to get exactly an 8 character hex field with leading zeroes for eibresp2
/*
 * Set up input  
 */
var csdInstall =
    {       
		restype : 154,
		resid : 'JHBTEST1',
		group : 'UNITTEST'
	}    
/* 
 * Try to install the program
 */
try
{
	cics.exec.csdInstall ( csdInstall ) ;  
}
 
catch ( e )  // the following will display any return codes that are returned from the call, which equate to the RESP and RESP2 values returned from the request
{
    writeln(debugging.object(e, 'Error Object'));
}
/*
 * Iterate over all of the properties
 */  
for (var prop in csdInstall) {
    writeln('\t', prop, ' = ', csdInstall[prop]);
}
workfield1 = cics.eib.eibresp2;                      // get special eibresp2 field for CSD define construct
workfield2 = workfield1.toString(16);                // convert it to hex string	
workfield3 = leadzero.concat(workfield2);            // add enough leading zeroes in front to ensure at least 8 characters (4 bytes)
workfield4 = workfield3.slice(-8);                   // take only last 8 characters
workfield5 = workfield4.substring(0,4);              // split the string...
workfield6 = workfield4.substring(4,8);              // ...into 2 4 character fields
eibresp2Part1 = parseInt(workfield5,16);             // this is first two bytes of eibresp2
eibresp2Part2 = parseInt(workfield6,16);             // this is second two bytes of eibresp2
writeln('Eibresp2 field part 1 ', eibresp2Part1);
writeln('Eibresp2 field part 2 ', eibresp2Part2);

Here are the valid CVDA values for the fields above:

restype - ATOMSERVICE (1179)
               BUNDLE (1180)
               CONNECTION (755)
               CORBASERVER (1141)
               DB2CONN (1142)
               DB2ENTRY (1143)
               DB2TRAN (1184)
               DJAR (1189)
               DOCTEMPLATE (1145)
               ENQMODEL (1188)
               FILE (238)
               IPCONN (1176)
               JOURNALMODEL (1185)
               JVMSERVER (1193)
               LIBRARY (1177)
               LSRPOOL (1152)
               MAPSET (155)
               MQCONN (1175)
               PARTITIONSET (156)
               PARTNER (1182)
               PIPELINE (1124)
               PROCESSTYPE (1190)
               PROFILE (157)
               PROGRAM (154)
               REQUESTMODEL (1157)
               SESSIONS (1187)
               TCPIPSERVICE (1166)
               TDQUEUE (767)
               TERMINAL (213)
               TRANCLASS (1169)
               TRANSACTION (1171)
               TSMODEL (1183)
               TYPETERM (1186)
               URIMAP (1173)
               WEBSERVICE (1174)


csdRemove()  

Description:  Remove a group from a list in the CSD.

This method is currently not supported and will be supported in a future release of HostBridge. 

Properties:

NameTypeMaximum LengthInput/Output
groupstring8Input
liststring8Input

Corresponding CICS Command Level API command reference:  EXEC CICS CSD REMOVE

Example: 

// to be generated 

csdRename()  

Description:  Rename a resource definition in the CSD.

This method is currently not supported and will be supported in a future release of HostBridge. 

Properties:

NameTypeMaximum LengthInput/Output
asstring8Input
groupstring8Input
residstring8Input
restypeCVDA
Input

Corresponding CICS Command Level API command reference:  EXEC CICS CSD RENAME

Example: 

// to be generated 

Here are the valid CVDA values for the fields above:

restype - ATOMSERVICE (1179)
               BUNDLE (1180)
               CONNECTION (755)
               CORBASERVER (1141)
               DB2CONN (1142)
               DB2ENTRY (1143)
               DB2TRAN (1184)
               DJAR (1189)
               DOCTEMPLATE (1145)
               ENQMODEL (1188)
               FILE (238)
               IPCONN (1176)
               JOURNALMODEL (1185)
               JVMSERVER (1193)
               LIBRARY (1177)
               LSRPOOL (1152)
               MAPSET (155)
               MQCONN (1175)
               PARTITIONSET (156)
               PARTNER (1182)
               PIPELINE (1124)
               PROCESSTYPE (1190)
               PROFILE (157)
               PROGRAM (154)
               REQUESTMODEL (1157)
               SESSIONS (1187)
               TCPIPSERVICE (1166)
               TDQUEUE (767)
               TERMINAL (213)
               TRANCLASS (1169)
               TRANSACTION (1171)
               TSMODEL (1183)
               TYPETERM (1186)
               URIMAP (1173)
               WEBSERVICE (1174)

  • No labels
Write a comment…