|
|
Publishing Framework
PACKAGE_PUBLISH
The PACKAGE_PUBLISH CALL routine publishes the specified package. The method
of publication depends on the following types of delivery transport:
Transport Properties
Valid property values are defined as follows:
- ADDRESSLIST_DATASET_LIBNAME
- an alternative to specifying explicit e-mail addresses, specifies a character string that indicates the name of the SAS library in which resides the data set from which an e-mail list can be extracted. (Applies to the following transport: e-mail.)
- ADDRESSLIST_DATASET_MEMNAME
- an alternative to specifying explicit e-mail addresses, specifies a character string that indicates the name of the SAS member in which resides the data set from which an e-mail list can be extracted. The data set is fully specified by library.member. (Applies to the following transport: e-mail.)
- ADDRESSLIST_VARIABLE_NAME
- specifies a character string that indicates the name of the variable (or column) in the data set
that contains the e-mail addresses. (Applies to the following transports: e-mail.)
- APPLIED_TEXT_VIEWER_NAME
- specifies a character string that names the rendered package view, which results from the application of the text viewer template to the package for viewing in e-mail. You can use the following syntax to specify the name of the rendered package view:
- FILENAME: external_filename
- FILEREF: sas_fileref
This property is valid only when the TEXT_VIEWER_NAME property is also
specified. By default, the rendered view is created as a temporary file.
This property overrides the default, causing the rendered view to be saved permanently to a file. (Applies to the following transports: e-mail, subscriber.)
- APPLIED_VIEWER_NAME
- specifies a character string that indicates the name of the rendered package view, which results from the application of the HTML viewer template to the package for viewing in e-mail. You can use the following syntax to specify the name of the rendered package view:
- FILENAME: external_filename
- FILEREF: sas_fileref
This property is valid only when the VIEWER_NAME property is also
specified. By default, the rendered view is created as a temporary file.
This property overrides the default, causing the rendered view to be saved permanently to a file. (Applies to the following transports: e-mail, subscriber.)
- ARCHIVE_NAME
- specifies a character string that indicates the name of the archive file. (Applies to the following transports: archive, e-mail, queue, subscriber, WebDAV.)
- ARCHIVE_PATH
- specifies a character string that indicates the path where the archive should be created. (Applies to the following transports: archive, e-mail, queue, subscriber, WebDAV.)
- CHANNEL_STORE
- specifies a character string that indicates the repository containing the channel and subscriber metadata. The channel can be defined in LDAP or in a SAS Metadata Repository. See LDAP Channel Store Syntax for details on how to identify a channel defined in LDAP. See SAS Metadata Repository Channel Store Syntax for details on how to identify a channel defined in a SAS Metadata Repository. (Applies to this transport: subscriber.)
- COLLECTION_URL
- specifies a character string that indicates the URL in which the WebDAV collection is
placed. You assign an explicit file name to the collection. (Applies to the following transports: e-mail, subscriber, WebDAV.)
Note: When you use COLLECTION_URL, the default behavior is to replace the existing collection at that location.
- CORRELATIONID
- specifies a binary character string correlator that is used on the package header message. (Applies to the following transports: queue, subscriber.)
- DATASET_OPTIONS
- specifies a character string that indicates the options to use for opening and accessing a SAS data set that contains e-mail addresses that are used to populate addressn. Specify this property as option1=value option2=value .... For a complete list of data set options, see the SAS Data Set Options topic in the SAS Online Help, Release 8.2 . (Applies to the following transports: e-mail, subscriber.)
- FROM
- specifies a character string that indicates the sender (or package publisher) of the e-mail message. (Applies to the following transports: e-mail, subscriber.)
Note: The FROM field is valid only with the SMTP e-mail interface.
- FTP_PASSWORD
- indicates the password that is needed to log on to the remote host at which the archive will be stored. Specify this property only when the remote host is secured. (Applies to the following transports: archive, e-mail, queue, subscriber.)
- FTP_USER
- indicates the user ID that is needed to log on to the remote host at which the archive will be stored. Specify this property only when the remote host is secured. (Applies to the following transports: archive, e-mail, queue, subscriber.)
- HTTP_PASSWORD
- Indicates the password that is needed to bind to the Web server on which the package is published. Specify this property only when the Web server is secured. (Applies to the following transports: archive, e-mail, queue, subscriber, WebDAV.)
- HTTP_PROXY_URL
- indicates the URL of the proxy server. (Applies to the following transports: archive, e-mail, queue, subscriber, WebDAV.)
- HTTP_USER
- indicates the user ID that is needed to bind to the Web server on which the package is published.
Specify this property only when the Web server is secured. (Applies to the following transports:
archive, e-mail, queue, subscriber, WebDAV.)
- IF_EXISTS
- specifies one of the following character strings. Use the IF_EXISTS property to control the treatment of same-named collections already existing on the server. (Applies to the following transports: e-mail, subscriber, WebDAV.)
-
"NOREPLACE" indicates that if the package being published contains a collection that already exists on the server, the PUBLISH_PACKAGE call is to return immediately without affecting the contents of the existing collection.
-
"UPDATE" indicates that if the collection already exists on the server, the PUBLISH_PACKAGE call is to update the existing collection by replacing like-named entities and adding newly named entities. If "UPDATE" is specified and both the package to publish and the existing collection have an HTML set (created with INSERT_HTML) with the same NESTED_NAME, the HTML set in the published package replaces the HTML set in the existing collection.
-
"UPDATEANY" is identical to "UPDATE" except that the PUBLISH_PACKAGE CALL routine can be used to update a collection that SAS did not create. A consequence of using "UPDATEANY" is that SAS will be unable to retrieve the published package.
Note: When names are generated automatically for HTML set collections, the publish code ensures that name collisions will not occur.
- LDAP_BINDDN
- specifies a character string that indicates the distinguished name that is used to bind to the LDAP
server. Specify this property only when the ARCHIVE_PATH is an LDAP URL and
when the LDAP server is running secured. (Applies to the following transports: archive, e-mail, queue, subscriber.)
- LDAP_BINDPW
- specifies a character string that indicates the password that is used to bind to the LDAP server.
Specify this property only when the ARCHIVE_PATH is an LDAP URL and when the LDAP
server is running secured. (Applies to the following transports: archive, e-mail, queue, subscriber.)
- METAPASS
- specifies the password to use when binding to the SAS Metadata Server. (Applies to this transport: subscriber.) If the METAPASS property is not specified on the PACKAGE_PUBLISH CALL routine, then the METAPASS system option, if set, will be used when binding to the SAS Metadata Server.
- METAUSER
- specifies the user name to use when binding to the SAS Metadata Server. (Applies to this transport: subscriber.) If the METAUSER property is not specified on the PACKAGE_PUBLISH CALL routine, then the METAUSER system option, if set, will be used when binding to the SAS Metadata Server.
- PARENT_URL
- specifies a character string that indicates the URL under which the WebDAV collection is placed. The collection is automatically assigned a unique name. (Applies to the following transports: archive, e-mail, subscriber, WebDAV.)
- PROCESS_VIEWER
- specifies a character string of "yes" to indicate that the rendered view will be delivered in e-mail. If you specify the PROCESS_VIEWER property with the ARCHIVE_PATH property, the archive is created but is not sent as an attachment in e-mail. Instead, viewer processing occurs and the rendered view is sent in e-mail. (Applies to the following transports: e-mail, subscriber.)
- REPLYTO
- specifies a character string that indicates the designated e-mail address to which package recipients might respond. (Applies to the following transports: e-mail, subscriber.)
Note: The REPLYTO field is valid only with the SMTP e-mail interface.
- SUBJECT
- specifies a character string that provides the subject line for the e-mail message. (Applies to the following transports: e-mail, subscriber.)
- TARGET_VIEW_NAME
- specifies a character string that indicates the name of the rendered view for delivery to a WebDAV-compliant server. The specified target view name overrides the default name, which is index.html. (Applies to the following transports: e-mail, subscriber, WebDAV.)
- TARGET_VIEW_MIMETYPE
- specifies a character string that indicates the MIME type of the rendered view for delivery to a WebDAV-compliant server. The target view mimetype overrides the default view mimetype, which is automatically inferred from the viewer. Typical MIME types are HTML (.htm) and plain text (.txt) files. If this field remains blank, the viewer filename extension is used to locate the MIME type in the appropriate registry. Windows hosts use the Windows Registry; other hosts use the SAS Registry. (Applies to the following transports: e-mail, subscriber, WebDAV.)
- TEXT_VIEWER_NAME
- specifies a character string that indicates the name of a text viewer template that formats package content for viewing in e-mail using the following syntax:
- FILENAME: external_filename
- FILEREF: sas_fileref
A text viewer template might be necessary if the destination e-mail program does not support the HTML MIME type. (Applies to the following transports: e-mail, subscriber, WebDAV.)
See Viewer Processing for more information.
- UUID
- specifies a character string that serves as a unique ID, which is assigned to the sasGUID attribute of the sasArchive instance. The UUID identifies a package that is published to an archive at an LDAP URL. (Applies to the following transports: archive, e-mail, queue, subscriber.)
- VIEWER_NAME
- specifies a character string that indicates the name of the HTML viewer template to be applied when publishing e-mail using the following syntax:
- FILENAME: external_filename
- FILEREF: sas_fileref
(Applies to the following transports: e-mail, channel, WebDAV.)
See Viewer Processing for more information.
|
