Namespace: Consultingwerk.Integrations.RapidCloud.Session
Class 
RapidCloudSessionEndpoint Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Integrations.RapidCloud.Session.RapidCloudSessionEndpoint

Inherits: Progress.Lang.Object
Implements: Consultingwerk.Integrations.RapidCloud.Session.IRapidCloudSessionEndpoint


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



Top Method Summary
Options Name Purpose
CheckAuthentication (IRapidCloudRequest, dataset-handle) Serves the FrameworkAuthCheck endpoint (login step 1) - resolves the authentication route of the user identified by the ttLoginCheck request row
CHARACTER DisplayDateFormat (character) Maps the ABL session date format to the display date format of the RCD frontend
GetAfterLoginData (IRapidCloudRequest, dataset-handle) Serves the AfterLoginData endpoint - the frontend session bootstrap data of the authenticated user
CHARACTER LoginCompanyCode () Returns the RCD company code of the login company of the current session
CHARACTER LoginCompanyImage () Returns the small image of the login company of the session (the ToolbarIcon of the after-login data)
CHARACTER ResolveLoginType (handle) Resolves the authentication route (LoginType) of the user identified by the given ttLoginCheck buffer
CHARACTER UserInitials (character, character) Derives the user initials from the given user full name
CHARACTER UserRoles () Returns the RCD Roles list of the current session user
LOGICAL ValidateCredentials (character, character) Validates the given user name and password against the IAuthenticationService
ValidateLogin (IRapidCloudRequest, dataset-handle) Serves the FrameworkAuthLogin endpoint (login step 2) - validates the user name and password of the ttLogin request row against the IAuthenticationService


Method Detail
Top

CheckAuthentication (IRapidCloudRequest, dataset-handle)
Purpose: Serves the FrameworkAuthCheck endpoint (login step 1) -
resolves the authentication route of the user identified
by the ttLoginCheck request row
Notes: The endpoint is invoked anonymously (before
authentication). Inbound ttResult rows skip the operation
(client-side validation short circuit)

Parameters:
poRequest Consultingwerk.Integrations.RapidCloud.IRapidCloudRequest
The request of the endpoint invocation
phResponse DATASET-HANDLE
OUTPUT The response ProDataset
Top

CHARACTER DisplayDateFormat (character)
Purpose: Maps the ABL session date format to the display date
format of the RCD frontend
Notes: "dmy" maps to "dd/mm/yyyy", "mdy" to "mm/dd/yyyy" and so
on for every permutation of the ABL date format string

Parameters:
pcDateFormat CHARACTER
The ABL date format, e.g. "dmy"
Returns CHARACTER
The display date format, e.g. "dd/mm/yyyy"
Top

GetAfterLoginData (IRapidCloudRequest, dataset-handle)
Purpose: Serves the AfterLoginData endpoint - the frontend session
bootstrap data of the authenticated user
Notes: The session context is established from the
client-principal of the request through
ServiceInterface:Activate Activate (RestServerSessionActivator)
when the request is not already activated. The response
dataset is named dsAfterlogindata following the RCD wire
contract. Version 1 switches off the company switch (the
login company is part of the identity), the language
switch (the per-request LanCd of the frontend is not
honoured) and the chat (no websocket token, SCL-5731);
theme and app layout stay enabled as frontend-only
features. The ToolbarIcon is the small image of the login
company; a user picture is not provided (SmartUser carries
none)

Parameters:
poRequest Consultingwerk.Integrations.RapidCloud.IRapidCloudRequest
The request of the endpoint invocation
phResponse DATASET-HANDLE
OUTPUT The response ProDataset
Top

CHARACTER LoginCompanyCode ()
Purpose: Returns the RCD company code of the login company of the
current session
Notes: Version 1 maps the short name of the SmartFramework login
company (falling back to the login company name) onto the
RCD CoCd

Returns CHARACTER
The company code of the login company
Top

CHARACTER LoginCompanyImage ()
Purpose: Returns the small image of the login company of the
session (the ToolbarIcon of the after-login data)
Notes: Read from the login company record - the server-side
session context (RestServerSessionActivator) carries the
key and names of the login company only, not its images

Returns CHARACTER
The small image of the login company or an empty value
Top

CHARACTER ResolveLoginType (handle)
Purpose: Resolves the authentication route (LoginType) of the user
identified by the given ttLoginCheck buffer
Notes: Version 1 always answers "database" (the password is
validated by the backend through FrameworkAuthLogin).
Subclasses supporting the authentication service route
(AuthJS providers, e.g. Azure AD) override this method
and additionally fill the ClientId, Secret and
IssuerTenantId fields of the buffer

Parameters:
phLoginCheck HANDLE
The ttLoginCheck buffer positioned on the request row
Returns CHARACTER
The LoginType of the user, e.g. "database"
Top

CHARACTER UserInitials (character, character)
Purpose: Derives the user initials from the given user full name
Notes: The first character of each word of the full name (at
most three); when no full name is available the first two
characters of the user name are used instead

Parameters:
pcFullName CHARACTER
The full name of the user
pcUserName CHARACTER
The (login) user name of the user
Returns CHARACTER
The derived user initials
Top

CHARACTER UserRoles ()
Purpose: Returns the RCD Roles list of the current session user
Notes: Version 1 projects the SmartFramework group names of the
user (as determined during session activation) into the
comma-separated RCD Roles list

Returns CHARACTER
The comma-separated Roles list of the user
Top

LOGICAL ValidateCredentials (character, character)
Purpose: Validates the given user name and password against the
IAuthenticationService
Notes: The login company is resolved from the domain part of the
user name (user@domain) or from the
DefaultAuthenticationDomain configuration value, following
the SmartHybridRealm pattern. Every failure returns false -
errors raised by the authentication chain (e.g. a disabled
user account) are logged on the server and never disclosed
to the client

Parameters:
pcUserName CHARACTER
The user name, either as a simple user name or in the form of user@domain
pcPassword CHARACTER
The password to validate (plain text)
Returns LOGICAL
Logical value indicating if the credentials are valid
Top

ValidateLogin (IRapidCloudRequest, dataset-handle)
Purpose: Serves the FrameworkAuthLogin endpoint (login step 2) -
validates the user name and password of the ttLogin
request row against the IAuthenticationService
Notes: The endpoint is invoked anonymously (before
authentication) and acts as a credential oracle only.
Every failure - unknown user, wrong password, disabled
user, unresolvable login company - answers with the same
"Invalid credentials." error so the response does not
disclose whether the user account exists. The password is
never part of the response, and the session state the
authentication service may have assigned is reset before
the method returns

Parameters:
poRequest Consultingwerk.Integrations.RapidCloud.IRapidCloudRequest
The request of the endpoint invocation
phResponse DATASET-HANDLE
OUTPUT The response ProDataset


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       10.10.2026 15:23:27