General Read

pixiAdminGetCUL

Returns the users logged in to licence-relevant Pixi clients at a given snapshot time, or at the latest snapshot if no date is passed.

Lists the currently logged-in users (CUL) as recorded in the login snapshot table UsersLoggedIn.

If Date is not passed, the call uses the most recent snapshot time (MAX(Tag)) of all sessions with session type 1 or 2.
Only rows whose Tag equals that date exactly are taken, and only sessions of type 1 or 2.
Only applications that need a licence are included. An application counts if it is listed in ExeClientVersion with LicenceNeeded = 1 and either:
- the setting pixiLicencesManager is 1 and the client's session type reference is 1 (desktop), or
- the setting pixiLicencesManagerWeb is 1 and the client's session type reference is 2 (web). Missing settings are treated as 0.
Master users are excluded: rows whose UserName is a ComputerName in MasterUsers, and rows whose UserNameUsingPixi is master.
Known executables are given a sortable display name (for example PPOS2.exe becomes 1_POS, supplorders_a.exe becomes 2_SupplOrders, through to ControlCenter.exe as 9_ControlCenter). Other application names stay as they are.

The result is sorted by UserName, UserNameUsingPixi and the mapped AppName.

Notes

All reads use NOLOCK, so the result may contain uncommitted data.
If both licence manager settings are 0 or missing, no application qualifies and the result is always empty.
Date must match a snapshot Tag exactly (including time); a date without the snapshot's exact time returns no rows. Passing 1900-01-01 behaves like passing no date, because the code compares ISNULL(@Date, '') with an empty string.
AppName_clean simply removes the first two characters of AppName. For mapped applications this strips the numeric prefix (1_POS → POS); for unmapped applications it cuts off the first two characters of the original executable name.
Full mapping: PPOS2.exe → 1_POS, supplorders_a.exe → 2_SupplOrders, paymentsclient_a.exe → 3_Payments, shippingclient_a.exe → 4_Shipping, CustomerClient_A.exe → 5_CustomerService, ReportClientA.exe → 6_Reports, binclient_a.exe → 7_Bin, InvoicesClient_A.exe → 8_Invoices, ControlCenter.exe → 9_ControlCenter.

Parameters

Parameter	Type	Default	Description
`Date`	datetime dateTime	NULL	Snapshot time (`Tag` in `UsersLoggedIn`) to evaluate. Must match exactly. If omitted, the latest snapshot of session types 1 and 2 is used. Example: `2024-05-14T10:15:00`

Response

Result set 1 · Always (may be empty)

Logged-in users of licence-relevant applications at the selected snapshot, excluding master users.

Column	Type	Description
`Tag`	datetime dateTime	Snapshot time of the login record.
`UserNameUsingPixi` Nullable	string	Pixi user name used in the session.
`UserName` Nullable	string	User or computer name of the session.
`SessionId` Nullable	string	Session identifier.
`AppName_clean` Nullable	string	`AppName` without its first two characters (e.g. `POS` for `1_POS`).
`AppName` Nullable	string	Application name; known executables are replaced by a numbered display name such as `1_POS`.
`AppVersion` Nullable	string	Version of the application used in the session.

Response example

<SqlRowSet1>
  <row>
    <Tag>2024-05-14T10:15:00</Tag>
    <UserNameUsingPixi>mmueller</UserNameUsingPixi>
    <UserName>WS-LAGER01</UserName>
    <SessionId>58</SessionId>
    <AppName_clean>Bin</AppName_clean>
    <AppName>7_Bin</AppName>
    <AppVersion>24.5.1.0</AppVersion>
  </row>
  <row>
    <Tag>2024-05-14T10:15:00</Tag>
    <UserNameUsingPixi>skraus</UserNameUsingPixi>
    <UserName>WS-OFFICE03</UserName>
    <SessionId>71</SessionId>
    <AppName_clean>SupplOrders</AppName_clean>
    <AppName>2_SupplOrders</AppName>
    <AppVersion>24.5.1.0</AppVersion>
  </row>
</SqlRowSet1>

Examples

POST https://apigateway.descartes.com/tms/pixi/
Content-Type: text/xml; charset=utf-8
Authorization: Basic BASE64(USERNAME:PASSWORD)

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://apigateway.descartes.com/tms/pixi/">
  <SOAP-ENV:Body>
    <ns1:pixiAdminGetCUL>
      <!-- <Date>2024-05-14T10:15:00</Date> -->
    </ns1:pixiAdminGetCUL>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

curl -X POST 'https://apigateway.descartes.com/tms/pixi/' \
  --user 'USERNAME:PASSWORD' \
  --header 'Content-Type: text/xml; charset=utf-8' \
  --data-binary @- <<'XML'
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://apigateway.descartes.com/tms/pixi/">
  <SOAP-ENV:Body>
    <ns1:pixiAdminGetCUL>
      <!-- <Date>2024-05-14T10:15:00</Date> -->
    </ns1:pixiAdminGetCUL>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML

<?php

$soapClient = new SoapClient(null, [
    'login' => 'USERNAME',
    'password' => 'PASSWORD',
    'location' => 'https://apigateway.descartes.com/tms/pixi/',
    'uri' => 'https://apigateway.descartes.com/tms/pixi/',
]);

$arguments = [
    // 'Date' => '2024-05-14T10:15:00',
];

$soapArguments = [];
foreach ($arguments as $name => $value) {
    $soapArguments[] = new SoapVar($value, XSD_STRING, '', '', $name);
}

$response = $soapClient->__soapCall('pixiAdminGetCUL', $soapArguments);

Tables used

UsersLoggedIn · Read settings · Read ExeClientVersion · Read MasterUsers · Read

SQL object:: dbo.pipiAdminGetCUL