Namespace: Consultingwerk.Studio.Pasoe
Class 
PasoeManager Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Studio.Pasoe.PasoeManager

Inherits: Progress.Lang.Object


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



Top Method Summary
Options Name Purpose
+ ActivateObjectTracking (character) Turn on ABLObjects tracking
- CHARACTER AddTerminationOptions (character, character, TerminationParameter) Adds termiation options to a URL, for a given action
- CreateAgentSessionRecord (character, JsonObject) Creates an eAgentSession record
- CreateClientRecord (JsonObject) Create an eClient record
- CreateMetricsRecord (JsonObject) Create an eMetrics record
- CreateSessionRecord (JsonObject) Create an eSession record
- CreateUrlRecord (character, character) Create an eUrl record.
+ DeactivateObjectTracking (character) Turn off ABLObjects tracking
+ GetAgent (character, dataset) Retrieves information about a single agent information from PASOE
+ GetAgentRequests (character, dataset) Retrieve agent request information from PASOE
+ GetAgents (dataset) Retrieve agent(s) information from PASOE
+ GetAgentSession (character, int64, dataset) Retrieve a single agent session information from PASOE
+ GetAgentSessions (character, dataset) Retrieve agent session information from PASOE
+ GetApplications (dataset) Retrieve application(s) from PASOE
+ GetClients (dataset) Retrieve client(s) information from PASOE
+ GetMetrics (dataset) Retrieve metrics from PASOE
- OpenEdge.Net.HTTP.IHttpResponse GetResponse (character, character, Credentials) Does a Get or Delete request to a PASOE
+ GetSessions (dataset) Retrieve session(s) information from PASOE
+ ObjectTrackingStatus (character) Check ABLObjects tracking
- OpenEdge.Net.HTTP.IHttpResponse PasoePidRequest (character, character, character, character) Does a request to https address and/or http
- OpenEdge.Net.HTTP.IHttpResponse PasoeRequest (character, character) Does a request to https address and/or http
- OpenEdge.Net.HTTP.IHttpResponse PasoeRequest (character, character, logical) Does a request to https address and/or http
+ QueryPasoe (dataset) Get all the information of a PASOE application
+ ReportObjectTracking (character, logical) Report ABLObjects tracking
+ TrimAgent (character, TerminationParameter, dataset) Trims (stops) a single agent
+ TrimAgents (TerminationParameter, dataset) Trim agents, first get a list of agents then delete each one
+ TrimAgents (dataset) Trim agents, first get a list of agents then delete each one
+ TrimAgentSession (character, int64, TerminationParameter, dataset) Trims (stops) a single agent
- CHARACTER Url (logical, character, integer) Builds the url for the oemanager requests
- CHARACTER Url (logical, character, integer, character, character) Builds the url for the oemanager requests
+ VerifyAgent (character) Verify the agent PID
+ VerifyAppName () Verify the application name if the name is needed to execute PasoeManager functionality

Top Constructor Summary
Options Name Purpose
+ PasoeManager (character, character, character, integer, character) Public constructor with all necessary properties as parameter

Top Property Summary
Options Name Purpose
+ CHARACTER AppName
+ OpenEdge.Net.HTTP.Credentials Credentials
+ CHARACTER HostName
- INTEGER LastStatusCode
- CHARACTER LastStatusReason
+ CHARACTER LastUrlUsed
- CHARACTER Password
+ INTEGER PortNumber
+ CHARACTER UserName


Method Detail
Top

PUBLIC ActivateObjectTracking (character)
Purpose: Turn on ABLObjects tracking
Notes:

Parameters:
pcAgentPid CHARACTER
Character Process ID of the agent
Top

PRIVATE CHARACTER AddTerminationOptions (character, character, TerminationParameter)
Purpose: Adds termiation options to a URL, for a given action
Notes:

Parameters:
pcTrimType CHARACTER
The type being terminated: AGENTS, AGENTSESSIONS
pcUrl CHARACTER
The URL to which to append the options
poTerminateParam Consultingwerk.Studio.Pasoe.TerminationParameter
The termination options
Returns CHARACTER
The updated URL string
Top

PRIVATE CreateAgentSessionRecord (character, JsonObject)
Purpose: Creates an eAgentSession record
Notes:

Parameters:
pcAgentPid CHARACTER
The PID of the agent contining the agent session
poSession Progress.Json.ObjectModel.JsonObject
JsonObject with Agent Session request information
Top

PRIVATE CreateClientRecord (JsonObject)
Purpose: Create an eClient record
Notes:

Parameters:
poClient Progress.Json.ObjectModel.JsonObject
JsonObject with Client request information
Top

PRIVATE CreateMetricsRecord (JsonObject)
Purpose: Create an eMetrics record
Notes:

Parameters:
poMetrics Progress.Json.ObjectModel.JsonObject
JsonObject with PASOE metrics
Top

PRIVATE CreateSessionRecord (JsonObject)
Purpose: Create an eSession record
Notes:

Parameters:
poSession Progress.Json.ObjectModel.JsonObject
JsonObject with Session request information
Top

PRIVATE CreateUrlRecord (character, character)
Purpose: Create an eUrl record.
Notes:

Parameters:
pcIdentifier CHARACTER
could be agents, clients, metrics or sessions.
pcLastUrlUsed CHARACTER
Url.
Top

PUBLIC DeactivateObjectTracking (character)
Purpose: Turn off ABLObjects tracking
Notes:

Parameters:
pcAgentPid CHARACTER
Character Process ID of the agent
Top

PUBLIC GetAgent (character, dataset)
Purpose: Retrieves information about a single agent information from PASOE
Notes: Creates eAgent records and 1 eUrl record

Parameters:
pcAgentPid CHARACTER
Process ID of the agent
dsPasoeManager DATASET dsPasoeManager
Dataset with eAgents records and one eUrl records
Top

PUBLIC GetAgentRequests (character, dataset)
Purpose: Retrieve agent request information from PASOE
Notes: Creates eAgentRequest records and 1 eUrl record

Parameters:
pcAgentPid CHARACTER
Character Process ID of the agent
dsPasoeManager DATASET dsPasoeManager
Dataset with eAgentRequest records and one eUrl records
Top

PUBLIC GetAgents (dataset)
Purpose: Retrieve agent(s) information from PASOE
Notes: Creates eAgent records and 1 eUrl record

Parameters:
dsPasoeManager DATASET dsPasoeManager
Dataset with eAgents records and one eUrl records
Top

PUBLIC GetAgentSession (character, int64, dataset)
Purpose: Retrieve a single agent session information from PASOE
Notes: Creates eAgentSession records and 1 eUrl record

Parameters:
pcAgentPid CHARACTER
Character Process ID of the agent
piSessionId INT64
The session id of to retrieve
dsPasoeManager DATASET dsPasoeManager
Dataset with eAgentSession records and one eUrl records
Top

PUBLIC GetAgentSessions (character, dataset)
Purpose: Retrieve agent session information from PASOE
Notes: Creates eAgentSession records and 1 eUrl record

Parameters:
pcAgentPid CHARACTER
Character Process ID of the agent
dsPasoeManager DATASET dsPasoeManager
Dataset with eAgentSession records and one eUrl records
Top

PUBLIC GetApplications (dataset)
Purpose: Retrieve application(s) from PASOE
Notes: Creates eApplication records and 1 eUrl record

Parameters:
dsPasoeManager DATASET dsPasoeManager
Dataset with eApplication records and one eUrl records
Top

PUBLIC GetClients (dataset)
Purpose: Retrieve client(s) information from PASOE
Notes: Creates eClient records and 1 eUrl record

Parameters:
dsPasoeManager DATASET dsPasoeManager
Dataset with eClients records and one eUrl records
Top

PUBLIC GetMetrics (dataset)
Purpose: Retrieve metrics from PASOE
Notes: Creates an eMetrics record and 1 eUrl record

Parameters:
dsPasoeManager DATASET dsPasoeManager
Dataset with one Metrics record and one eUrl records
Top

PRIVATE OpenEdge.Net.HTTP.IHttpResponse GetResponse (character, character, Credentials)
Purpose: Does a Get or Delete request to a PASOE
Notes:

Parameters:
pcOperation CHARACTER
Either Get or Delete, the latter is used for trimming agents
pcUrl CHARACTER
Http(s) address
poCredentials OpenEdge.Net.HTTP.Credentials
Username password object
Returns OpenEdge.Net.HTTP.IHttpResponse
IHttpResponse Contains json formatted data
Top

PUBLIC GetSessions (dataset)
Purpose: Retrieve session(s) information from PASOE
Notes: Creates eSession records and 1 eUrl record

Parameters:
dsPasoeManager DATASET dsPasoeManager
Dataset with eSessions records and one eUrl records
Top

PUBLIC ObjectTrackingStatus (character)
Purpose: Check ABLObjects tracking
Notes:

Parameters:
pcAgentPid CHARACTER
Character Process ID of the agent
Top

PRIVATE OpenEdge.Net.HTTP.IHttpResponse PasoePidRequest (character, character, character, character)
Purpose: Does a request to https address and/or http
Notes: Try http first if http fails try https.
If both fail a combined error of both fails is thrown.

Parameters:
pcOperation CHARACTER
Either Get or Delete, the latter is used for trimming agents
pcAction CHARACTER
Action could be agents, clients, metrics or sessions
pcPid CHARACTER
PID Identifier
pcAttribute CHARACTER
Attribute could be session or requestes
Returns OpenEdge.Net.HTTP.IHttpResponse
IHttpResponse Contains json formatted data
Top

PRIVATE OpenEdge.Net.HTTP.IHttpResponse PasoeRequest (character, character)
Purpose: Does a request to https address and/or http
Notes: Try http first if http fails try https.
If both fail a combined error of both fails is thrown.

Parameters:
pcAction CHARACTER
Action could be agents, clients, metrics or sessions
pcOperation CHARACTER
Either Get or Delete, the latter is used for trimming agents
Returns OpenEdge.Net.HTTP.IHttpResponse
IHttpResponse Contains json formatted data
Top

PRIVATE OpenEdge.Net.HTTP.IHttpResponse PasoeRequest (character, character, logical)
Purpose: Does a request to https address and/or http
Notes: Try http first if http fails try https.
If both fail a combined error of both fails is thrown.

Parameters:
pcAction CHARACTER
Action could be agents, clients, metrics or sessions
pcOperation CHARACTER
Either Get or Delete, the latter is used for trimming agents
plSecure LOGICAL
indicates if a secure or a non secure connection was used
Returns OpenEdge.Net.HTTP.IHttpResponse
IHttpResponse Contains json formatted data
Top

PUBLIC QueryPasoe (dataset)
Purpose: Get all the information of a PASOE application
Notes:

Parameters:
dsPasoeManager DATASET dsPasoeManager
dataset with eAgent, eClient, eMetrics, eSessions and eUrl records
Top

PUBLIC ReportObjectTracking (character, logical)
Purpose: Report ABLObjects tracking
Notes:

Parameters:
pcAgentPid CHARACTER
Character Process ID of the agent
plConsole LOGICAL
Logical indator if console output should be used
Top

PUBLIC TrimAgent (character, TerminationParameter, dataset)
Purpose: Trims (stops) a single agent
Notes: Default options for are used

Parameters:
pcAgentPid CHARACTER
Process ID of the agent
poTerminateParam Consultingwerk.Studio.Pasoe.TerminationParameter
Options for the termination of the session
dsPasoeManager DATASET dsPasoeManager
OUTPUT Dataset
Top

PUBLIC TrimAgents (TerminationParameter, dataset)
Purpose: Trim agents, first get a list of agents then delete each one
Notes:

Parameters:
poTerminateParam Consultingwerk.Studio.Pasoe.TerminationParameter
Options for the termination of the session
dsPasoeManager DATASET dsPasoeManager
dataset with eUrl and eAgent records
Top

PUBLIC TrimAgents (dataset)
Purpose: Trim agents, first get a list of agents then delete each one
Notes:

Parameters:
dsPasoeManager DATASET dsPasoeManager
dataset with eUrl and eAgent records
Top

PUBLIC TrimAgentSession (character, int64, TerminationParameter, dataset)
Purpose: Trims (stops) a single agent
Notes: Default options for are used

Parameters:
pcAgentPid CHARACTER
Process ID of the agent
piSessionId INT64
The session's identifier
poTerminateParam Consultingwerk.Studio.Pasoe.TerminationParameter
Options for the termination of the session
dsPasoeManager DATASET dsPasoeManager
OUTPUT Dataset
Top

PRIVATE CHARACTER Url (logical, character, integer)
Purpose: Builds the url for the oemanager requests
Notes: Sets the property LastUrlUsed.

Parameters:
plSecure LOGICAL
Try for https/false for http
pcHostName CHARACTER
Hostname, ipaddress or domain
piPortNumber INTEGER
Portnumber
Returns CHARACTER
HTTP(S) address
Top

PRIVATE CHARACTER Url (logical, character, integer, character, character)
Purpose: Builds the url for the oemanager requests
Notes: Sets the property LastUrlUsed.

Parameters:
plSecure LOGICAL
Try for https/false for http
pcHostName CHARACTER
Hostname, ipaddress or domain
piPortNumber INTEGER
Portnumber
pcAppName CHARACTER
PASOE application name
pcAction CHARACTER
action could be agents, clients, metrics or sessions
Returns CHARACTER
HTTP(S) address
Top

PUBLIC VerifyAgent (character)
Purpose: Verify the agent PID
Notes: if the agent PID is not available display a list of available agent PIDs

Parameters:
pcAgentPid CHARACTER
Process ID of the agent
Top

PUBLIC VerifyAppName ()
Purpose: Verify the application name if the name is needed to execute PasoeManager functionality
Notes: Verifies if the application name exists, else lists all available applications



Constructor Detail
Top

PUBLIC PasoeManager (character, character, character, integer, character)
Purpose: Public constructor with all necessary properties as parameter
Notes:

Parameters:
pcUserName CHARACTER
Username used for credentials object
pcPassword CHARACTER
Password used for credentials object
pcHostName CHARACTER
Hostname, ipaddress or domain
piPortNumber INTEGER
Portnumber
pcAppName CHARACTER
PASOE application name


Property Detail
Top

PUBLIC CHARACTER AppName

Returns CHARACTER
Top

PUBLIC OpenEdge.Net.HTTP.Credentials Credentials

Returns OpenEdge.Net.HTTP.Credentials
Top

PUBLIC CHARACTER HostName

Returns CHARACTER
Top

PRIVATE INTEGER LastStatusCode

Returns INTEGER
Top

PRIVATE CHARACTER LastStatusReason

Returns CHARACTER
Top

PUBLIC CHARACTER LastUrlUsed

Returns CHARACTER
Top

PRIVATE CHARACTER Password

Returns CHARACTER
Top

PUBLIC INTEGER PortNumber

Returns INTEGER
Top

PUBLIC CHARACTER UserName

Returns CHARACTER


ProDataset Detail

ProDataset dsPasoeManager

Member tables: eMetrics, eAgent, eDeletedAgent, eSession, eClient, eUrl, eApplication, eAgentSessions, eAgentRequests, eDeletedAgentSession


Temp-Table Detail

Temp-Table eAgent

Defined in:

Temp-Table eAgentRequests

Defined in:

Temp-Table eAgentSessions

Defined in:

Temp-Table eApplication

Defined in:

Temp-Table eClient

Defined in:

Temp-Table eDeletedAgent

Defined in:

Temp-Table eDeletedAgentSession

Defined in:

Temp-Table eMetrics

Defined in:

Temp-Table eSession

Defined in:

Temp-Table eUrl

Defined in:


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       08.12.2024 13:22:42