Namespace: Consultingwerk.Util.SessionInfo
Class 
SupportSnapshotProvider Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Util.SessionInfo.SupportSnapshotProvider

Inherits: Progress.Lang.Object
Implements: Consultingwerk.Util.SessionInfo.ISupportSnapshotProvider


Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
AppendRtfConfiguration (longchar, JsonObject) Appends the Configuration section of the snapshot to the RTF document
AppendRtfContextDataset (longchar, JsonObject) Appends the Context Dataset section of the snapshot to the RTF document
AppendRtfSessionInfo (longchar, JsonObject) Appends the SessionInfo sections of the snapshot to the RTF document
AppendTextConfiguration (longchar, JsonObject) Appends the Configuration section of the snapshot to the plain text
AppendTextContextDataset (longchar, JsonObject) Appends the Context Dataset section of the snapshot to the plain text
AppendTextSessionInfo (longchar, JsonObject) Appends the SessionInfo sections of the snapshot to the plain text
LONGCHAR EscapeRtf (character) Escapes a character value for use in an RTF document
Progress.Json.ObjectModel.JsonObject GetConfigurationJson () Returns the Configuration snapshot section as a JsonObject
Progress.Json.ObjectModel.JsonObject GetContextDatasetJson () Returns the JSON representation of the SessionManager's Context Dataset
Progress.Json.ObjectModel.JsonArray GetMaskedSessionInfoSections () Returns the session info sections provided by the ISessionInfoProvider service with sensitive values masked
Progress.Json.ObjectModel.JsonObject GetSnapshot () Returns the support snapshot as a JsonObject
LONGCHAR GetSnapshotRtf () Returns the support snapshot as an RTF document
LONGCHAR GetSnapshotRtf (JsonObject) Returns the given support snapshot as an RTF document
LONGCHAR GetSnapshotText () Returns the support snapshot as plain text
LONGCHAR GetSnapshotText (JsonObject) Returns the given support snapshot as plain text
CHARACTER GetValueAsCharacter (JsonObject, character) Returns the value of a JsonObject property as a character value
CHARACTER MaskConfigurationValue (character, character) Masks the value of a sensitive configuration setting
CHARACTER MaskStartupParameters (character) Masks the values of the -P and -sectok parameters in a comma delimited startup parameter list
CHARACTER ToHex (integer) Returns the two digit hex representation of an integer value

Top Property Summary
Options Name Purpose
CHARACTER MASKED_VALUE


Method Detail
Top

AppendRtfConfiguration (longchar, JsonObject)
Purpose: Appends the Configuration section of the snapshot to the RTF document
Notes:

Parameters:
plcRtf LONGCHAR
The longchar with the RTF document to append to
poSnapshot Progress.Json.ObjectModel.JsonObject
The JsonObject with the support snapshot
Top

AppendRtfContextDataset (longchar, JsonObject)
Purpose: Appends the Context Dataset section of the snapshot to the RTF document
Notes: Every temp-table of the context dataset is rendered as a
header followed by a table

Parameters:
plcRtf LONGCHAR
The longchar with the RTF document to append to
poSnapshot Progress.Json.ObjectModel.JsonObject
The JsonObject with the support snapshot
Top

AppendRtfSessionInfo (longchar, JsonObject)
Purpose: Appends the SessionInfo sections of the snapshot to the RTF document
Notes: Every section is rendered as a header followed by a two
column table

Parameters:
plcRtf LONGCHAR
The longchar with the RTF document to append to
poSnapshot Progress.Json.ObjectModel.JsonObject
The JsonObject with the support snapshot
Top

AppendTextConfiguration (longchar, JsonObject)
Purpose: Appends the Configuration section of the snapshot to the plain text
Notes:

Parameters:
plcText LONGCHAR
The longchar with the plain text to append to
poSnapshot Progress.Json.ObjectModel.JsonObject
The JsonObject with the support snapshot
Top

AppendTextContextDataset (longchar, JsonObject)
Purpose: Appends the Context Dataset section of the snapshot to the plain text
Notes:

Parameters:
plcText LONGCHAR
The longchar with the plain text to append to
poSnapshot Progress.Json.ObjectModel.JsonObject
The JsonObject with the support snapshot
Top

AppendTextSessionInfo (longchar, JsonObject)
Purpose: Appends the SessionInfo sections of the snapshot to the plain text
Notes:

Parameters:
plcText LONGCHAR
The longchar with the plain text to append to
poSnapshot Progress.Json.ObjectModel.JsonObject
The JsonObject with the support snapshot
Top

LONGCHAR EscapeRtf (character)
Purpose: Escapes a character value for use in an RTF document
Notes: Forwards to the escaping of the RtfWriter (SCL-5851), which
escapes the backslash and the two braces, turns a line
break and a tab into their control word and writes every
character outside the ASCII range as a unicode escape.
That last part is what the local implementation this method
replaces could not do: it wrote a hex escape, which can only
carry what the ansicpg code page knows, so everything beyond
Latin-1 was lost. The snapshot renders the values of the
configuration and of the context dataset, which are not
restricted to that.
The rest of the RTF is still written here rather than through
the RtfWriter: the snapshot renders every section as a table,
and a table is not part of the TextDocument model, so writing
it through the writer would flatten the sections into
paragraphs.

Parameters:
pcValue CHARACTER
The character value to escape
Returns LONGCHAR
The longchar with the escaped value
Top

Progress.Json.ObjectModel.JsonObject GetConfigurationJson ()
Purpose: Returns the Configuration snapshot section as a JsonObject
Notes: Returns an invalid reference when no IConfigurationProvider
service is registered. Sensitive values are masked

Returns Progress.Json.ObjectModel.JsonObject
The JsonObject with the configuration values
Top

Progress.Json.ObjectModel.JsonObject GetContextDatasetJson ()
Purpose: Returns the JSON representation of the SessionManager's
Context Dataset
Notes: Returns an invalid reference when no Context Dataset is set

Returns Progress.Json.ObjectModel.JsonObject
The JsonObject with the context dataset data
Top

Progress.Json.ObjectModel.JsonArray GetMaskedSessionInfoSections ()
Purpose: Returns the session info sections provided by the
ISessionInfoProvider service with sensitive values masked
Notes: Masks the value of the -P and -sectok startup parameters
in the Startup Parameters section as well as in the
STARTUP-PARAMETERS property of the SESSION system handle

Returns Progress.Json.ObjectModel.JsonArray
The JsonArray with the session info sections
Top

Progress.Json.ObjectModel.JsonObject GetSnapshot ()
Purpose: Returns the support snapshot as a JsonObject
Notes: The JsonObject contains the properties CreationTime,
SessionInfo, ContextDataset and Configuration

Returns Progress.Json.ObjectModel.JsonObject
The JsonObject with the support snapshot
Top

LONGCHAR GetSnapshotRtf ()
Purpose: Returns the support snapshot as an RTF document
Notes: Every section is rendered as a header followed by a table

Returns LONGCHAR
The longchar with the RTF document
Top

LONGCHAR GetSnapshotRtf (JsonObject)
Purpose: Returns the given support snapshot as an RTF document
Notes: Every section is rendered as a header followed by a table

Parameters:
poSnapshot Progress.Json.ObjectModel.JsonObject
The JsonObject with the support snapshot as returned by GetSnapshot
Returns LONGCHAR
The longchar with the RTF document
Top

LONGCHAR GetSnapshotText ()
Purpose: Returns the support snapshot as plain text
Notes: Every section is rendered as a header followed by the
key/value pairs of the section

Returns LONGCHAR
The longchar with the plain text representation
Top

LONGCHAR GetSnapshotText (JsonObject)
Purpose: Returns the given support snapshot as plain text
Notes: Every section is rendered as a header followed by the
key/value pairs of the section

Parameters:
poSnapshot Progress.Json.ObjectModel.JsonObject
The JsonObject with the support snapshot as returned by GetSnapshot
Returns LONGCHAR
The longchar with the plain text representation
Top

CHARACTER GetValueAsCharacter (JsonObject, character)
Purpose: Returns the value of a JsonObject property as a character value
Notes: Returns the JSON text of the property for non string values
and ? for null values

Parameters:
poObject Progress.Json.ObjectModel.JsonObject
The JsonObject to return the property value of
pcName CHARACTER
The name of the property
Returns CHARACTER
The property value as a character value
Top

CHARACTER MaskConfigurationValue (character, character)
Purpose: Masks the value of a sensitive configuration setting
Notes: Values of settings with a name containing password,
passphrase, secret or token are masked

Parameters:
pcName CHARACTER
The name of the configuration setting
pcValue CHARACTER
The value of the configuration setting
Returns CHARACTER
The masked value
Top

CHARACTER MaskStartupParameters (character)
Purpose: Masks the values of the -P and -sectok parameters in a comma
delimited startup parameter list
Notes: Follows the pattern established by Consultingwerk.SessionInfo

Parameters:
pcParameters CHARACTER
The comma delimited startup parameter list
Returns CHARACTER
The startup parameter list with masked sensitive values
Top

CHARACTER ToHex (integer)
Purpose: Returns the two digit hex representation of an integer value
Notes: Supports values between 0 and 255

Parameters:
piValue INTEGER
The integer value to convert
Returns CHARACTER
The two digit hex representation


Property Detail
Top

CHARACTER MASKED_VALUE

Returns CHARACTER


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       19.09.2026 10:19:56