Click or drag to resize
ClientConfigPublishDocument Method DataPA OpenAnalytics
DataPA OpenAnalytics API Reference
Publishes a Document (Report or Query) to DataPA Enterprise.

Namespace: DataPAClientConfig
Assembly: DataPAClientConfig (in DataPAClientConfig.dll) Version: 1.0.1.0 (1.0.1.0)
Syntax
public bool PublishDocument(
	ref byte[] DocumentData,
	int PublishTimeOut,
	string ID,
	string Type,
	string FileName,
	string System,
	string Title,
	string Description,
	string Keywords,
	string Category,
	string Comments,
	string Author,
	string UserName,
	string Password,
	ref string[] ReqFieldNames,
	ref string[] ReqFieldLabels,
	ref string[] ReqFieldDescs,
	ref string[] ReqFieldTypes,
	ref string[] ReqFieldMands,
	ref string[] ReqFieldValues,
	ref string[] ReqFieldLookups,
	ref string[] ReqFieldFormats,
	ref string ErrMessage = ""
)

Parameters

DocumentData
Type: SystemByte
Byte array containing binary representation of document being published.
PublishTimeOut
Type: SystemInt32
The publish timeout in minutes.
ID
Type: SystemString
ID of the document to be published.
Type
Type: SystemString
FileName
Type: SystemString
System
Type: SystemString
Title
Type: SystemString
The title of the document.
Description
Type: SystemString
Description of the document.
Keywords
Type: SystemString
Keywords of the document.
Category
Type: SystemString
Comments
Type: SystemString
Author
Type: SystemString
UserName
Type: SystemString
Password
Type: SystemString
ReqFieldNames
Type: SystemString
ReqFieldLabels
Type: SystemString
ReqFieldDescs
Type: SystemString
ReqFieldTypes
Type: SystemString
ReqFieldMands
Type: SystemString
ReqFieldValues
Type: SystemString
ReqFieldLookups
Type: SystemString
ReqFieldFormats
Type: SystemString
ErrMessage (Optional)
Type: SystemString
Any error messages that occured during the publish.

Return Value

Type: Boolean
True if the object is published to DataPA Enterprise.
Remarks