SAS 9.1.3 Integration Technologies » Developer's Guide


SAS Publisher
Requirements
How SAS Publisher Works
Starting SAS Publisher
Publishing a Package
Defining Package Content
Specifying Package Destination
Specifying Package Format
Using SAS Publisher with SAS/Warehouse Administrator
Publishing Framework

Specifying Package Format (How to Publish)

You can specify the format of the published package using the How to Publish tab.

The fields that display on this tab change based on the destination type that you selected on the Where to Publish tab.

Formatting a Package for E-mail

Follow these steps to specify parameters in the How to Publish tab that format a package for delivery to e-mail.

  1. Specify whether to format the package as a SAS package. For details, see SAS Package Format.

  2. Specify options for publishing to e-mail. For details, see E-mail Publishing Options.

  3. Identify whether to apply a rendered view of the package for viewing in e-mail. For details, see Viewer Template.

  4. Specify an optional package expiration date and time. For details, see Package Expiration Date and Time.

  5. Once you specify the package format in the How to Publish tab, you are ready to publish the package. For details, see Publishing a Package, Saving and Viewing Publish Code.

Formatting a Package for a Message Queue

Follow these steps to specify parameters in the How to Publish tab that format a package for delivery to a message queue.

  1. Specify whether to format the package as a SAS package. For details, see SAS Package Format.

  2. Specify options for publishing to message queue. For details, see Message Queue Publishing Options.

  3. Identify whether to apply a rendered view of the package for delivery to the message queue. For details, see Viewer Template.

  4. Optionally, specify attributes that describe the package in the Package Name/Value (optional) panel. With this information, subscribers to SAS channels and developers of package retrieval applications can specify filters to control package delivery.

    For example, if you publish to a channel and describe the package as:

       market=(Canada, US)

    then the package is sent to subscribers who specify a filter of market=(US, Canada) but does not go to subscribers who specify a filter of market=(US, Asia).

    For complete details about filters, see Specifying Name/Value Pairs.

  5. Specify an optional package expiration date and time. For details, see Package Expiration Date and Time.

  6. Once you specify the package format in the How to Publish tab, you are ready to publish the package. For details, see Publishing a Package, Saving and Viewing Publish Code.

Formatting a Package for a Channel

Follow these steps to specify parameters in the How to Publish tab that format a package for delivery to a channel.

  1. Specify whether to format the package as a SAS package. For details, see SAS Package Format.

  2. Although a channel is used to identify information topics for subscription, the channel does not actually deliver the package to the end user. The package is delivered to the channel by a transport, which is defined in each subscriber's channel subscription properties that are stored in the LDAP directory. Therefore, enter appropriate values in the fields for E-mail Subject and Correlation ID. The channel's configured transports use these values to send the package to the subscribers.

    To specify options for e-mail delivery, see Options for e-mail.

    To specify a message queue delivery, specify a correlation ID in the Correlation ID field. The correlation ID is a binary string that identifies the package in the message queue. Package consumers who access the queue can then use the ID to quickly retrieve a specific package.

  3. Identify whether to apply a rendered view of the package for delivery to e-mail or message queue. For details, see Viewer Template.

  4. Optionally, specify attributes that describe the package in the Package Name/Value (optional) panel. With this information, subscribers to SAS channels and developers of package-retrieval applications can specify filters to control package delivery.

    For example, if you publish to a channel and describe the package as:

       market=(Canada, US)

    then the package is sent to subscribers who specify a filter of market=(US, Canada) but does not go to subscribers who specify a filter of market=(US, Asia).

    For complete details about filters, see Specifying Name/Value Pairs.

  5. Specify an optional package expiration date and time. For details, see Package Expiration Date and Time.

  6. Once you specify the package format in the How to Publish tab, you are ready to publish the package. For details about how to publish the package, see Publishing a Package, Saving and Viewing Publish Code.

Formatting a Package for an Archive

Follow these steps to specify parameters in the How to Publish tab that format a package for delivery to an archive.

By definition, an archive transport saves an archive file to a designated location for storage and subsequent access. The archive file results from the compression of the package into a single file, along with metadata that describes the package content.

Therefore, the Package as a SAS package (.spk) check box is already selected and cannot be unchecked.

  1. For details about completing the fields in the Package Formatting panel, see SAS Package Format.

  2. Optionally, specify attributes that describe the package in the Package Name/Value (optional) panel. With this information, subscribers to SAS channels and developers of package-retrieval applications can specify filters to control package delivery.

    For example, if you publish to a channel and describe the package as:

       market=(Canada, US)

    then the package is sent to subscribers who specify a filter of market=(US, Canada) but does not go to subscribers who specify a filter of market=(US, Asia).

    For complete details about filters, see Specifying Name/Value Pairs.

  3. Specify an optional package expiration date and time. For details, see Package Expiration Date and Time.

  4. After you specify the package format in the How to Publish tab, you are ready to publish the package. For details, see Publishing a Package, Saving and Viewing Publish Code.

Formatting a Package for a WebDAV-compliant Server

For the WebDAV-compliant server transport, the How to Publish tab is disabled.

Once you specify the package options in the Viewers and Publish Options tabs, you are ready to publish the package. For details about how to publish the package, see Publishing a Package, Saving and Viewing Publish Code.

SAS Package Format

A primary reason to save a package as a SAS package (also known as an SPK file) is to save storage resources. A SAS package and its metadata that describes the package content is compressed and saved as a single file. Storage constraints for archival purposes in the enterprise might dictate file compression.

Another benefit of package compression is that an SPK file can be delivered to a recipient who does not have access to a SAS system. Recipients can view an archive by using SAS Package Reader or a third-party unzip utility.

  1. If you selected a destination type of Archive in the in the Where to Publish tab, the Package as a SAS Package (.spk) check box is already selected and cannot be unchecked.

    For the e-mail transport, SAS channel subscriber, and message queue delivery types, the Package as a SAS Package (.spk) check box is already selected to indicate that the package will be delivered in compressed format. However, you can override the default selection and send the package in full-text (or uncompressed) format by clicking the already-selected check box. Removing the check mark delivers the package in full-text format.

    If you are publishing to e-mail but do not publish the package as a SAS package, you can deliver only URL package items. E-mail cannot convey SAS data files because it is a view-only delivery transport. However, with the aid of a viewer template, you can render SAS data package content for viewing in e-mail.

    If you decided to publish a package in full-text format, then you have completed all steps in this panel.

  2. If you select the Package as a SAS Package (.spk) check box, the Package Formatting panel appears.

    These fields let you decide how and where to store the SAS package. Select the appropriate button to indicate whether the storage location is a Directory name or an LDAP URL.

  3. Specify the location in the Path field. The down arrow control displays all locations that you have specified previously, and the right arrow control displays all possible locations.

    If you specify a storage location as a directory name, you must precede the directory name with the appropriate protocol: FTP or HTTP.

    Here is an example: ftp://c:\airways\travel\routes and http://www.travel.org/bestfares.

  4. The Name of spk field also appears. Optionally, specify the name under which the package will be stored in the archive. The right arrow control displays all package names and locations that you might have previously defined.

    If you leave this field blank, then SAS Publisher assigns the archived file a default name in the form of today's date and a unique numeric string–for example, 22MAR2000_059105.

Options for Publishing to E-mail

  1. In the E-mail Subject field, enter the subject line for the published e-mail. If you do not specify a subject, the subject defaults to the package description that is specified in the What to Publish tab.

  2. You can use the Publish Options tab to provide additional properties for e-mail.

  3. Identify a point-of-contact e-mail address in the Reply To field to let e-mail recipients return a message to a designated e-mail address. Such an address might belong to the package publisher or to someone else, such as a subject matter expert or a member of an administrative staff.

  4. Supply the user ID of the sender (or package publisher) of the e-mail message in the From field. Addresses that you supply in the Reply To and the From fields can be identical.

  5. The next four fields collect a user ID and a password that are needed for publishing an archived file to a secured host or server. Hosts that use FTP protocol require an FTP user ID and password. Servers that use HTTP protocol require an HTTP user ID and password.

  6. Identify the URL, in the form of a string, into which the collection of package entries is placed. Make an entry in either of these fields, but not both.

    Collection URL
    specifying a collection URL lets package consumers easily recognize package names for retrieval. A disadvantage is that subsequent publications of the same package overwrite the original package. For an example of a collection URL, see http://www.host.com/AlphaliteAirways/revenue/quarter1. The collection name is quarter1.

    Parent URL
    specifying a parent URL generates a name for the collection on the Web server that is unique in the destination directory. Specifying a parent URL also allows subsequent publications of the same package under unique names. A generated name is limited to eight characters, the first character being an s. For an example of a parent URL directory location, see http://www.host.com/AlphaliteAirways/revenue. An example of a collection name that is automatically generated might be s9811239.

Viewer Template

A viewer file is a template that contains formatting directives for rendering a specific view of the published package in e-mail. Typical viewer templates are written to format packages in HTML or text format. A text viewer template might be necessary if the destination e-mail program does not support the HTML MIME type. For complete details about viewers, see Viewer Processing.

  1. In the Viewers tab, click the appropriate button to specify the location of the viewer either as a physical filename or a SAS fileref. Here is an example:
    by name (filename)                 by reference (fileref)
    
    c:\Public\flights-viewtemplate     viewtemplate
    
  2. Specify the name of the viewer file as a character string. You can use the arrow buttons to the right of the Viewer field to browse directories or to select from previously defined locations.

Options for Publishing to Message Queue

  1. Specify a correlation ID in the Correlation ID field. The correlation ID is a binary string that identifies the package in the message queue.

    Package consumers who access the queue can then use the ID to quickly retrieve a specific package.

  2. The Publish Options tab enables you to specify a user ID and password to bind to the remote host or server where the package will be published. For details, see Options for Archives and Message Queues.

Package Expiration Date and Time

The Expiration date and the Expiration time fields display in the How to Publish tab for all delivery transports.

  1. In the Expiration date field, specify the date when the package information expires or is no longer valid. Select the right arrow to display a calendar window, from which you can choose an expiration date. Click End to return to the How to Publish tab.

    The name of the selected date appears in the Expiration date field. The date is gray to indicate that the field is not available.

  2. In the Expiration time field, specify the time at which the package information expires or is no longer valid. The default value is midnight.