In this section: How to: |
The DSTBULK subroutine maintains Distribution Lists stored in BOTADDR and BOTDEST. It is a procedure-based call. With this subroutine, you can perform the following functions, using an external Distribution List residing on EDAPATH, or an HTML input form:
Note: These functions cannot be performed as a pre-processing procedure of the schedule being submitted.
-SET &var_name=DSTBULK(srv_userid,srv_userid_length, - 'srv_userpass',srv_userpass_length, - 'host_port',host_port_length, - 'name',name_length, - 'function',function_length, - 'access',access_length, - 'method',method_length, - 'user',user_length, - 'filename',filename_length, - 'copy',copy_length, - 'httpuser/pswd',httpuser/pswd_length, [- 'tcpiplevel',] - 'I4');
where:
Is the variable that will contain the return code.
The following sections describe the arguments for the DSTBULK subroutine. For an example that uses the DSTBULK subroutine, see Replacing Members in a Distribution List Using DSTBULK.
Description |
Valid Execution ID. It must match the user ID stored in the ReportCaster Repository. |
Required? |
Yes |
Format |
A48 (Windows and UNIX) A8 (OS/390) |
Valid Values |
Single quotation marks, ampersands, and spaces are not allowed. First character must be alphanumeric (OS/390). |
Description |
Length of the user ID. |
Required? |
Yes |
Format |
I4 |
Valid Values |
Integer |
Description |
Valid password for the Execution ID. It must match the password of the user ID stored in the ReportCaster Repository. |
Required? |
Yes |
Format |
A48 |
Valid Values |
Alphanumeric characters and spaces are allowed. |
Description |
Length of the srv_userpass value. |
Required? |
Yes |
Format |
I4 |
Valid Values |
Integer |
Description |
Is the host name (or IP address) and port number of the Web server on which the WebFOCUS Client is installed.
|
Required? |
Yes |
Format |
A64 |
Valid Values |
No restrictions. |
Description |
Is the length of the host name and port number. This is only the length of the host name if the port number is omitted. |
Required? |
Yes |
Format |
I4 |
Valid Values |
Integer |
Description |
Name of the Distribution List that will be modified. |
Required? |
Yes |
Format |
A50 |
Valid Values |
First character must be alphabetic. |
Description |
Length of the name of the Distribution List. |
Required? |
Yes |
Format |
I4 |
Valid Values |
Integer |
Description |
Type of maintenance action that will be performed. |
Required? |
Yes |
Format |
A1 |
Valid Values |
C = Create a new Distribution List. N = Add new members to an existing Distribution List. R = Replace all members in an existing Distribution List. D = Delete an existing Distribution List. |
Description |
Length of the value of the function. |
Required? |
Yes |
Format |
I4 |
Valid Values |
1 |
Description |
Length of the value of the function. |
Required? |
Yes, if function is C. Ignored if function is N, R, or D. |
Format |
A2 |
Valid Values |
PR = Private Distribution List (other users cannot access the list). PU = Public Distribution List (anyone can access the list). |
Description |
Length of the value of the access allowed. |
Required? |
Yes, if access is supplied. |
Format |
I4 |
Valid Values |
2 |
Description |
Distribution method for a new Distribution List. |
Required? |
Yes, if function is C. Ignored if function is N, R, or D. |
Format |
A5 |
Valid Values |
FTP or F = FTP distribution.MAIL or M = E-mail distribution.PRINT or P = Printer distribution. |
Description |
Length of the value for the distribution method. |
Required? |
Yes, if function is C. |
Format |
I4 |
Valid Values |
Integer |
Description |
One of the following:
|
Required? |
Yes This feature enables a logon user to create or manipulate a Distribution List for another user, whose ID is supplied on owner. |
Format |
A48 (Windows and UNIX)A8 (OS/390) |
Valid Values |
Single quotation marks, ampersands, and spaces are not allowed. First character must be alphanumeric (OS/390). |
Description |
Length of the user argument. |
Required? |
Yes |
Format |
I4 |
Valid Values |
Integer |
Description |
Name of the external source file used to supply member names. The following requirements apply:
Note: This is similar to the way the IBIB_filename parameter is used for DSTDLBULK. For more information, see Creating an External File. |
Required? |
Yes, if supplying members from an external file when function is C, N, or R. |
Format |
A8 |
Valid Values |
First character must be alphanumeric.Single quotation marks and ampersands are not allowed.Blank lines are not allowed in an external distribution file. |
Description |
Length of the name of the external source file. |
Required? |
Yes, if filename is supplied. |
Format |
I4 |
Valid Values |
I4 |
Description |
Name of the source Distribution List. Applies when function is one of the following:
|
Required? |
Yes, if supplying members from a Distribution List. |
Format |
A50 |
Valid Values |
First character must be alphabetic. |
Description |
Length of the name of the source Distribution List. |
Required? |
Yes, if copy is supplied. |
Format |
I4 |
Valid Values |
Integer |
Description |
Web server user ID and password. |
Required? |
Yes, if the Web server is running with security on. |
Format |
A75 |
Valid Values |
Valid Web server user ID and password. |
Description |
Length of the Web server user ID and password, including the character /. |
Required? |
Yes, if httpuser/pswd is supplied. |
Format |
I4 |
Valid Values |
Integer |
Description |
Method ReportCaster uses for securing sockets from TCP/IP, based on a specific SAS/C library. |
Required? |
Yes, if the WebFOCUS Reporting Server runs on OS/390. |
Format |
I4 |
Valid Values |
1 = Resolves special connectivity problems. 0 = Specifies no special connectivity problems. |
Description |
Value that DSTBULK returns to the calling procedure, indicating successful completion (0) or an error condition. For more information, see ReportCaster API Subroutine Messages. |
Required? |
Yes |
Format |
I4 |
Valid Values |
'I4' |
The following Dialogue Manager procedure calls DSTBULK to replace members in an existing Distribution List with members from an external file. The procedure resides on a WebFOCUS Reporting Server for Windows. The numbers to the left of the code refer to the annotations that follow.
1. FILEDEF SUBLOG DISK D:\ibi\srv77\wfs\catalog\sublog.ftm -RUN 2. -SET &SUBERR = DSTBULK( - 'userid',6, 3. - 'mypass',6, 4. - 'ibihost',7, 5. - 'Managers',8, 6. - 'R',1, 7. - 'PU',2, 8. - ' ',0, 9. - 'JXDMKT',6, 10. - 'extfile1',8, 11. - ' ',0, 12. - ' ',0, 13. - 'I4'); 14. -IF &SUBERR EQ 0 GOTO EXIT; -INCLUDE DSTBLKER -WRITE SUBLOG &SUBERR -EXIT
The procedure runs as follows:
For more information about the FILEDEF command, see the Developing Reporting Applications manual.
The Execution ID ('userid'), included in single quotation marks, and length of 'userid' (6), are the first arguments passed to the subroutine.
If it is a non-zero value, indicating an error condition, the procedure continues to the next line, which incorporates the supplied file DSTBLKER. DSTBLKER translates return codes into meaningful messages. Messages are written to the file sublog.ftm, which was defined by the FILEDEF command in the first line of code.
For more information about DSTBLKER, see ReportCaster API Subroutine Messages.
Note: The initial hyphen and space on each line are required for a continuation line.
WebFOCUS |