Skip to main content


persistent class HS.Message.StreamletRequest extends HS.Util.EnsRequest

SQL Table Name: HS_Message.StreamletRequest

This is used when aggregating data to send to Analytics

Property Inventory


parameter RESPONSECLASSNAME = HS.Message.ECRFetchResponse;
Default response class


property AggregationKey as %String;
used with the Transmit flavor
Property methods: AggregationKeyDisplayToLogical(), AggregationKeyGet(), AggregationKeyGetStored(), AggregationKeyIsValid(), AggregationKeyLogicalToDisplay(), AggregationKeyLogicalToOdbc(), AggregationKeyNormalize(), AggregationKeySet()
property Flavor as %String;
This request can be used in several different parts of the analytics aggregation, to retrieve a collection of streamlets into a contentstream, both as an Ensemble request and as an argument to HS.SDA3.Container method GetStreamlets. The flavor is used to distinguish the context. Choices are:
Resend: Ensemble request to Edge: return all non-deleted streamlets for the specified MRNs
Update: Ensemble request to Edge: return a specific list of updated streamlets, using the IncludeStreamlets property
Match: Ensemble request to Edge: return a list of potentially matching streamlets, using the MatchStreamlets, and populating only one MRN in MRNs
Transmit: Access (argument only): transmit all of the aggregated streamlets to the analytics database.
Property methods: FlavorDisplayToLogical(), FlavorGet(), FlavorGetStored(), FlavorIsValid(), FlavorLogicalToDisplay(), FlavorLogicalToOdbc(), FlavorNormalize(), FlavorSet()
property Gateway as %String);
The gateway endpoint
Property methods: GatewayDisplayToLogical(), GatewayGet(), GatewayGetStored(), GatewayIsValid(), GatewayLogicalToDisplay(), GatewayLogicalToOdbc(), GatewayNormalize(), GatewaySet()
property IncludeStreamlets as list of %String);
This is used in the first pass fetch (Update flavor), where we are asking for a specific list of streamlets that have been changed Each list item is of format Action^StreamletType^streamlet ID 1, streamlet ID 2, etc. (ends with a comma) Action is I (insert), U (update), or D (delete) (action is just a passthru to be inserted into the response object)
Property methods: IncludeStreamletsBuildValueArray(), IncludeStreamletsCollectionToDisplay(), IncludeStreamletsCollectionToOdbc(), IncludeStreamletsDisplayToCollection(), IncludeStreamletsDisplayToLogical(), IncludeStreamletsGet(), IncludeStreamletsGetObject(), IncludeStreamletsGetObjectId(), IncludeStreamletsGetStored(), IncludeStreamletsGetSwizzled(), IncludeStreamletsIsValid(), IncludeStreamletsLogicalToDisplay(), IncludeStreamletsLogicalToOdbc(), IncludeStreamletsNormalize(), IncludeStreamletsOdbcToCollection(), IncludeStreamletsSet(), IncludeStreamletsSetObject(), IncludeStreamletsSetObjectId()
property IncludeTimeZoneOffsets as %Integer [ InitialExpression = 0 ];
A flag to govern whether time zone offsets will be present in data fetched from an edge gateway
Property methods: IncludeTimeZoneOffsetsDisplayToLogical(), IncludeTimeZoneOffsetsGet(), IncludeTimeZoneOffsetsGetStored(), IncludeTimeZoneOffsetsIsValid(), IncludeTimeZoneOffsetsLogicalToDisplay(), IncludeTimeZoneOffsetsNormalize(), IncludeTimeZoneOffsetsSet(), IncludeTimeZoneOffsetsXSDToLogical()
property MPIID as %String;
used for streamlet requests to the registry, such as cohort membership
Property methods: MPIIDDisplayToLogical(), MPIIDGet(), MPIIDGetStored(), MPIIDIsValid(), MPIIDLogicalToDisplay(), MPIIDLogicalToOdbc(), MPIIDNormalize(), MPIIDSet()
property MRN as %String (MAXLEN = 200);
For the second pass (Match flavor), an MRNs for which we are returning all of the potential match streamlets. It is also used for the Resend flavor. The MRN is of format facility^AA^mredrecnum
Property methods: MRNDisplayToLogical(), MRNGet(), MRNGetStored(), MRNIsValid(), MRNLogicalToDisplay(), MRNLogicalToOdbc(), MRNNormalize(), MRNSet()
property MatchStreamlets as list of %String);
This is used in the second pass (Match flavor), where we are asking for all non-encountered streamlets of specified types which might match (but are not the same as) one of the ones that we have included. Each list item is of format StreamletType^streamlet ID 1, streamlet ID 2, etc., where we specifically want to exclude those streamlets
Property methods: MatchStreamletsBuildValueArray(), MatchStreamletsCollectionToDisplay(), MatchStreamletsCollectionToOdbc(), MatchStreamletsDisplayToCollection(), MatchStreamletsDisplayToLogical(), MatchStreamletsGet(), MatchStreamletsGetObject(), MatchStreamletsGetObjectId(), MatchStreamletsGetStored(), MatchStreamletsGetSwizzled(), MatchStreamletsIsValid(), MatchStreamletsLogicalToDisplay(), MatchStreamletsLogicalToOdbc(), MatchStreamletsNormalize(), MatchStreamletsOdbcToCollection(), MatchStreamletsSet(), MatchStreamletsSetObject(), MatchStreamletsSetObjectId()
property Timeout as %Integer;
Property methods: TimeoutDisplayToLogical(), TimeoutGet(), TimeoutGetStored(), TimeoutIsValid(), TimeoutLogicalToDisplay(), TimeoutNormalize(), TimeoutSet(), TimeoutXSDToLogical()

Inherited Members

Inherited Properties

Inherited Methods


Gray indicates storage defined by superclasses.

Storage Model: Storage (Ens.MessageBody)


Storage Model: Storage (HS.Util.EnsRequest)


Storage Model: Storage (HS.Message.StreamletRequest)

FeedbackOpens in a new tab