Maintaining Distribution Lists Using the DSTDLBULK Servlet

In this section:

The DSTDLBULK servlet maintains Distribution Lists stored in BOTADDR and BOTDEST. With this servlet you can perform the following functions, using an external Distribution List residing on EDAPATH, or an HTML input form:


Top of page

Example: Specifying an Absolute Address Using DSTDLBULK
<FORM ACTION="http://hostname/context_root/servlet/DSTDLBULK">

where:

context_root

Is the configurable context root for the ReportCaster Web application in your Application Server configuration. By default, this is /ibi_apps.

hostname

Is the host name of the Web server.


Top of page

x
DSTDLBULK Parameters

In this section:

The following parameters may be used in an HTML calling form to generate the query string passed to the DSTDLBULK servlet.



x
IBIB_access Parameter for DSTDLBULK

Description

Access allowed on a new Distribution List.

Required?

Yes, if IBIB_function is C, which copies an existing Distribution List to a new Distribution List.

Ignored, if IBIB_function is N, R, or D.

Size in bytes

2

Valid Values

PR = Private Distribution List (other users cannot access the list). PU = Public Distribution List (anyone can access the list).

Default

PU



x
IBIB_copy Parameter for DSTDLBULK

Description

Name of source Distribution List. Applies when IBIB_function is one of the following:

  • C, which copies an existing Distribution List to a new Distribution List.
  • N, which appends an existing Distribution List to another one.
  • R, which replaces an existing Distribution List with another one.

Required?

Yes, if supplying members from a Distribution List.

Size in bytes

50

Valid Values

An existing Distribution List created using the ReportCaster API.

Default

None



x
IBIB_filename Parameter for DSTDLBULK

Description

Name of external source file used to supply member names. The file must:

  • Reside on EDAPATH (Windows and UNIX), or in a partitioned data set (PDS) allocated to ddname EDARPC (OS/390).
  • Have the extension .fex on Windows and UNIX, although you do not specify it.

For more information about IBIB_filename, see Creating an External File.

Required?

Yes, if supplying members from an external file when IBIB_function is C, N, or R.

Size in bytes

8

Valid Values

First character must be alphabetic. Single quotation marks and ampersands are not allowed. Blank lines are not allowed in an external distribution file.

Default

None



x
IBIB_function Parameter for DSTDLBULK

Description

Type of maintenance action that will be performed.

Required?

Yes

Size in bytes

1

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.

Default

C



x
IBIB_method Parameter for DSTDLBULK

Description

Distribution method for a new Distribution List.

Required?

Yes, if IBIB_function is C. Ignored, if IBIB_function is N, R, or D.

Size in bytes

5

Valid Values

FTP or F = FTP distribution. MAIL or M = Mail distribution. PRINT or P = Printer distribution.

Default

MAIL



x
IBIB_name Parameter for DSTDLBULK

Description

Name of the Distribution List that will be modified.

Required?

Yes

Size in bytes

50

Valid Values

An existing Distribution List created using the ReportCaster API.

Default

None



x
IBIB_recipients Parameter for DSTDLBULK

Description

Records typed into a text box on an HTML form.

Required?

Yes, if supplying members from text box input when IBIB_function is C, N, or R.

Size in bytes

75

Valid Values

A file name (FTP distribution), e-mail address, or printer name. For example: File name ENGLAND.HTM,,$E-mail address Alfred_Stevens@abcd.com,,$Printer name \\WERIBI\29B2.PRNTNY.IBI,,$

Default

None



x
IBIB_tcpiplevel Parameter for DSTDLBULK

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.

Size in bytes

1

Valid Values

1 = Resolves special connectivity problems. 0 = Specifies no special connectivity problems.

Default

0



x
IBIB_user Parameter for DSTDLBULK

Description

One of the following:

  • User ID of the owner of the target Distribution List when IBIB_copy is not present. The target Distribution List is the one being added to, replaced, or deleted.
  • User ID of the owner of the target Distribution List when IBIB_copy is present. The owner of the target Distribution List is the user ID in the WebFOCUS cookie (WF_COOKIE).

Required?

For adding, replacing, or deleting:

A value is required if IBIB_function is N, R, or D. Only public Distribution Lists may be copied.

For creating:

Only a ReportCaster Administrator can create a Distribution List for another user. This must be a public Distribution List.

Size in bytes

48 (Windows and UNIX)8 (OS/390)

Valid Values

Single quotation marks, ampersands, and spaces are not allowed. First character must be alphabetic (OS/390).

Default

None



x
Creating an External File

The parameter IBIB_filename refers to an external file used to supply member names to a Distribution List. You must provide a value for this parameter when both of the following conditions are true:

When you create an external file, it must contain a maximum of 75-bytes, in comma-delimited format. A record must contain a single destination field for non-burst report distribution, and an additional burst value field for burst report distribution.

When creating an external file:



Example: Creating an External File for a Burst Report

For a burst report, each record in the external file consists of the destination field, followed by the burst value field, and then a comma and a dollar sign to terminate the record. The following are sample records from external files that supply member names to a Distribution List for a burst report.

The first record illustrates a file name for FTP distribution (ENGLAND.HTM). It is followed by the field value on which the report is burst (ENGLAND). A comma and a dollar sign terminate the record:

ENGLAND.HTM,ENGLAND,$

The next record illustrates an e-mail address (Alfred_Stevens@abcd.com), followed by the field on which the report is burst (ENGLAND). A comma and a dollar sign terminate the record:

Alfred_Stevens@abcd.com,ENGLAND,$

The last record illustrates a printer name (\\WERIBI\29B2.PRNTNY.IBI), followed by the field on which the report is burst (ENGLAND). A comma and a dollar sign terminate the record:

\\WERIBI\29B2.PRNTNY.IBI,ENGLAND,$


Example: Creating an External File for a Non-Burst Report

For a non-burst report, each record in the external file consists of the destination field, followed by a comma to represent the missing burst value field, and then a comma and a dollar sign to terminate the record.

The first sample record illustrates a file name for FTP distribution (ENGLAND.HTM). It is followed by a comma to represent the missing burst value field. The record terminates with a comma and a dollar sign:

ENGLAND.HTM,,$

The next record illustrates an e-mail address for e-mail distribution. The rest of the record is the same as the preceding record:

Alfred_Stevens@abcd.com,,$

The last record illustrates a printer name for printer distribution. The rest of the record is the same as the preceding two records:

\\WERIBI\29B2.PRNTNY.IBI,,$

Top of page

x
Generating Text Box Input

The value of the parameter IBIB_recipients results from values typed into a text box on an HTML form. IBIB_recipients is used to supply member names to a Distribution List. You must supply a value for IBIB_recipients when IBIB_function is C, N, or R, and member names for a Distribution List come from an HTML text box rather than from an existing ReportCaster Distribution List or an external file.

IBIB_recipients is composed of instances of the destination field and the burst value field in the same way that IBIB_filename is composed for an external file. For a burst report, each record consists of the destination field, followed by the burst value field, and then a comma and a dollar sign to terminate the record. For a non-burst report, each record consists of the destination field, followed by a comma to represent the missing burst value field, and then a comma and a dollar sign to terminate the record.


Top of page

x
Creating and Populating a Distribution List Using Text Box Input

You can use the DSTDLBULK servlet to create a new Distribution List and populate it with members from text box input on an HTML form.

This form also enables you to append new members to an existing Distribution List or replace the members in an existing Distribution List.


WebFOCUS