WFLogManager.Read Method

WFLogManagerRead Method

Content Studio 5.7 SDK

Content Studio Web Content Management System

[This is preliminary documentation and is subject to change.]

Reads an individual item from the workflow log.

Namespace: ContentStudio.Document.Workflow.Management
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)

Syntax

Copy

public string Read(
	ConnectionId connectionId,
	SessionId sessionId,
	int logId
)

Public Function Read ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	logId As Integer
) As String

Parameters

connectionId: Type: ContentStudioConnectionId
A value that identifies the web site
sessionId: Type: ContentStudio.SecuritySessionId
A value that identifies the user's session. This value typically is retrieved from a call to the OpenSession method
logId: Type: SystemInt32
The identifier if the log item to read.

Return Value

Type: String
Xml

Copy

<root>
  <status>0</status>
  <statustext>Success</statustext>
  <logs>
    <log id="Integer value"
         level="Integer value"
         logdate="Date/time value"
         summary="String value"
         details="String value"
         title="String value"
         username="String value"
         documentid="Integer value"
         categoryid="Integer value"
         categoryname="String value"
         wfinstance="Guid value" />
  </logs>
</root>

The attributes in the returned element root/logs contains the following attributes with values an meaning.

Attribute

Description

Integer, the identifier of the item returned.

level

Integer, the type of log item.
This attribute can have on of the following values:

Value	Meaning
0	Standard; standard information sufficient for most users
1	Extended: extended information more detailed that the standard level
2	Advanced; the item contains advanced and very detailed information of most actions taken by the workflow server.
3	Debug; messages that describes every internal action done by the engine. This level meaningful for developers and testers only.

logdate

A date time value that indicates when the log item was written to the log. This value is in the SortableDateTimePattern (based on ISO 8601) format using local time (e.g. 2007-11-01T16:34:18)

summary

String,

details

String, a detailed message of the returned item.

title

String, the title of the log item.

username

String, the name of the user that is involved in the logged workflow action.

documentid

Integer, an identifier to the document the is subject to workflow.

categoryid

IInteger, ddddddd

categoryname

String, The name of the category that host the document that uses the workflow.

wfinstance

Guid, that uniquely identifiers the instance definition used by the workflow that created the log. This value is equal to the internal revision identifier of the document versioning that was affected by the workflow.

Exceptions

Exception	Condition
CSException	A business rule was violated in the underlying Content Studio database
CSPermissionDeniedException	The caller has no permission to perform the requested action
CSInvalidSessionException	The session is invalid
CSDocumentNotFoundException	The object specified could not be found
SqlException	An error occurred when executing the command against the Content Studio database

Content Studio permissions

READCONTAINER permission on the category where the workflow is defined is required to be able to read the log.

Reference

WFLogManager Class

ContentStudio.Document.Workflow.Management Namespace