Real-Time Entity and Network Generation Action Set

Provides actions for generating entities and networks from transactional data

createCompoundStore Action

Define elements, compounds and entities.

CASL Syntax

rteng.createCompoundStore <result=results> <status=rc> /
compoundStore={
caslib="string",
compoundTable="string",
copies=integer,
documentTable="string",
entityTable="string",
lockTable="string",
metadataTable="string"
},
required parameter compoundTypes={{
required parameter elementTypes={"string-1" <, "string-2", ...>},
maxCount=integer,
maxElementTypeCounts={{
count=integer,
required parameter elementType="string",
regressLimit=integer
}, {...}},
required parameter name="string"
}, {...}},
documentIdType="CHAR" | "INT32" | "INT64",
required parameter elementTypes={{
format="string",
isAttribute=TRUE | FALSE,
keep=TRUE | FALSE,
required parameter name="string",
type="CHAR" | "DOUBLE" | "INT32" | "INT64",
validtime="NO" | "VALIDFROM" | "VALIDTO"
}, {...}},
required parameter entityTypes={{
required parameter compoundTypes={"string-1" <, "string-2", ...>},
required parameter name="string",
required parameter primaryElementType="string",
validFrom="string",
validTo="string"
}, {...}},
exclusionRegressLimit=integer,
preserveDocumentTypeCase=TRUE | FALSE,
recordIdType="CHAR" | "INT32" | "INT64"
;
indicates a required parameter

Parameter Descriptions

compoundStore={compoundStore}

specifies the table names and CAS library to use for the compound store across sessions.

Long form compoundStore={caslib="string"}
Shortcut form compoundStore="string"

The compoundStore value can be one or more of the following:

caslib="string"

specifies the CAS library in which to create or find the tables. This library must be a global library.

compoundTable="string"

specifies the name of the CAS table in which to store compounds.

Default "rtengCmpd"
copies=integer

specifies the number of redundant copies to keep. A value of 0 is fastest but disables failover when a worker fails.

Default 1
Minimum value 0
documentTable="string"

specifies the name of the CAS table in which to store documents.

Default "rtengDoc"
entityTable="string"

specifies the name of the CAS table in which to store entities.

Default "rtengEntity"
lockTable="string"

specifies the name of the CAS table to use for preventing access to the compound store by other sessions while an action is running. This table is used internally and should never be created by the user.

Default "rtengLock"
metadataTable="string"

specifies the name of the CAS table in which to store the metadata, including the element, compound, and entity definitions.

Default "rtengMeta"

* compoundTypes={{compoundType-1} <, {compoundType-2}, ...>}

defines the compound types that are used to identify entities.

The compoundType value can be one or more of the following:

* elementTypes={"string-1" <, "string-2", ...>}

specifies the collection of element types that form this compound type.

maxCount=integer

specifies the maximum number of times that a compound value of this type can appear in the data before the compound value is excluded.

Default MACINT
Minimum value 1
maxElementTypeCounts={{elementTypeCount-1} <, {elementTypeCount-2}, ...>}

specifies a collection of element type and counts for defining compound exclusions. A compound value is excluded if the total number of distinct element values of the type that you specify in the elementType parameter is greater than the value that you specify in the maxCount parameter.

The elementTypeCount value can be one or more of the following:

count=integer

specifies the maximum number of distinct values of the element type that can occur across all data rows that are associated with the compound value. If you exceed this limit, the compound value is excluded.

Default 1
Minimum value 1
* elementType="string"

specifies the type of the element for which distinct values are counted.

regressLimit=integer

specifies the maximum number of element values to store for the specified element type.

Default MACINT
Minimum value 1
* name="string"

specifies the name of the compound type. Compound types constitute collections of element types and are used to define entity types.

documentIdType="CHAR" | "INT32" | "INT64"

specifies the type of the document ID to use in the raw import tables when documents are added.

Default CHAR

* elementTypes={{elementType-1} <, {elementType-2}, ...>}

defines the element types to be used to uniquely identify compounds.

The elementType value can be one or more of the following:

format="string"

specifies the SAS format to use when the value is output.

isAttribute=TRUE | FALSE

when set to True, can use the element as an attribute for soft-deletes of documents and entities.

Default FALSE
keep=TRUE | FALSE

when set to True, includes this element's value in the output table. This parameter applies only to elements in the primary table.

Default FALSE
* name="string"

specifies the name of an element that is used to define compounds. This name must match a column name in a raw import table when documents are added.

type="CHAR" | "DOUBLE" | "INT32" | "INT64"

specifies the type of the element.

Default CHAR
validtime="NO" | "VALIDFROM" | "VALIDTO"

specifies whether this element is used as a time value and, if so, whether the value represents a starting time or an ending time that an entity is active.

Default NO

* entityTypes={{entityType-1} <, {entityType-2}, ...>}

defines the entity types.

The entityType value can be one or more of the following:

* compoundTypes={"string-1" <, "string-2", ...>}

specifies one or more compound types that are used to define an entity.

* name="string"

specifies the name of the entity definition.

* primaryElementType="string"

specifies the element that defines the primary table when documents are added.

validFrom="string"

specifies the element that defines the starting time that this entity is active.

validTo="string"

specifies the element that defines the ending time that this entity is active.

exclusionRegressLimit=integer

specifies the maximum number of element values to store for computing compound exclusions. This limit is applied to each compound exclusion rule unless you specify a different limit by using the regressLimit subparameter of the maxElementTypeCounts parameter.

Default MACINT
Minimum value 1

preserveDocumentTypeCase=TRUE | FALSE

when set to False, converts the document type to uppercase when documents are added.

Default TRUE

recordIdType="CHAR" | "INT32" | "INT64"

specifies the type of the record ID to use in the raw import tables when documents are added.

Default CHAR

createCompoundStore Action

Define elements, compounds and entities.

Lua Syntax

results, info = s:rteng_createCompoundStore{
compoundStore={
caslib="string",
compoundTable="string",
copies=integer,
documentTable="string",
entityTable="string",
lockTable="string",
metadataTable="string"
},
required parameter compoundTypes={{
required parameter elementTypes={"string-1" <, "string-2", ...>},
maxCount=integer,
maxElementTypeCounts={{
count=integer,
required parameter elementType="string",
regressLimit=integer
}, {...}},
required parameter name="string"
}, {...}},
documentIdType="CHAR" | "INT32" | "INT64",
required parameter elementTypes={{
format="string",
isAttribute=true | false,
keep=true | false,
required parameter name="string",
type="CHAR" | "DOUBLE" | "INT32" | "INT64",
validtime="NO" | "VALIDFROM" | "VALIDTO"
}, {...}},
required parameter entityTypes={{
required parameter compoundTypes={"string-1" <, "string-2", ...>},
required parameter name="string",
required parameter primaryElementType="string",
validFrom="string",
validTo="string"
}, {...}},
exclusionRegressLimit=integer,
preserveDocumentTypeCase=true | false,
recordIdType="CHAR" | "INT32" | "INT64"
}
indicates a required parameter

Parameter Descriptions

compoundStore={compoundStore}

specifies the table names and CAS library to use for the compound store across sessions.

Long form compoundStore={caslib="string"}
Shortcut form compoundStore="string"

The compoundStore value can be one or more of the following:

caslib="string"

specifies the CAS library in which to create or find the tables. This library must be a global library.

compoundTable="string"

specifies the name of the CAS table in which to store compounds.

Default "rtengCmpd"
copies=integer

specifies the number of redundant copies to keep. A value of 0 is fastest but disables failover when a worker fails.

Default 1
Minimum value 0
documentTable="string"

specifies the name of the CAS table in which to store documents.

Default "rtengDoc"
entityTable="string"

specifies the name of the CAS table in which to store entities.

Default "rtengEntity"
lockTable="string"

specifies the name of the CAS table to use for preventing access to the compound store by other sessions while an action is running. This table is used internally and should never be created by the user.

Default "rtengLock"
metadataTable="string"

specifies the name of the CAS table in which to store the metadata, including the element, compound, and entity definitions.

Default "rtengMeta"

* compoundTypes={{compoundType-1} <, {compoundType-2}, ...>}

defines the compound types that are used to identify entities.

The compoundType value can be one or more of the following:

* elementTypes={"string-1" <, "string-2", ...>}

specifies the collection of element types that form this compound type.

maxCount=integer

specifies the maximum number of times that a compound value of this type can appear in the data before the compound value is excluded.

Default MACINT
Minimum value 1
maxElementTypeCounts={{elementTypeCount-1} <, {elementTypeCount-2}, ...>}

specifies a collection of element type and counts for defining compound exclusions. A compound value is excluded if the total number of distinct element values of the type that you specify in the elementType parameter is greater than the value that you specify in the maxCount parameter.

The elementTypeCount value can be one or more of the following:

count=integer

specifies the maximum number of distinct values of the element type that can occur across all data rows that are associated with the compound value. If you exceed this limit, the compound value is excluded.

Default 1
Minimum value 1
* elementType="string"

specifies the type of the element for which distinct values are counted.

regressLimit=integer

specifies the maximum number of element values to store for the specified element type.

Default MACINT
Minimum value 1
* name="string"

specifies the name of the compound type. Compound types constitute collections of element types and are used to define entity types.

documentIdType="CHAR" | "INT32" | "INT64"

specifies the type of the document ID to use in the raw import tables when documents are added.

Default CHAR

* elementTypes={{elementType-1} <, {elementType-2}, ...>}

defines the element types to be used to uniquely identify compounds.

The elementType value can be one or more of the following:

format="string"

specifies the SAS format to use when the value is output.

isAttribute=true | false

when set to True, can use the element as an attribute for soft-deletes of documents and entities.

Default false
keep=true | false

when set to True, includes this element's value in the output table. This parameter applies only to elements in the primary table.

Default false
* name="string"

specifies the name of an element that is used to define compounds. This name must match a column name in a raw import table when documents are added.

type="CHAR" | "DOUBLE" | "INT32" | "INT64"

specifies the type of the element.

Default CHAR
validtime="NO" | "VALIDFROM" | "VALIDTO"

specifies whether this element is used as a time value and, if so, whether the value represents a starting time or an ending time that an entity is active.

Default NO

* entityTypes={{entityType-1} <, {entityType-2}, ...>}

defines the entity types.

The entityType value can be one or more of the following:

* compoundTypes={"string-1" <, "string-2", ...>}

specifies one or more compound types that are used to define an entity.

* name="string"

specifies the name of the entity definition.

* primaryElementType="string"

specifies the element that defines the primary table when documents are added.

validFrom="string"

specifies the element that defines the starting time that this entity is active.

validTo="string"

specifies the element that defines the ending time that this entity is active.

exclusionRegressLimit=integer

specifies the maximum number of element values to store for computing compound exclusions. This limit is applied to each compound exclusion rule unless you specify a different limit by using the regressLimit subparameter of the maxElementTypeCounts parameter.

Default MACINT
Minimum value 1

preserveDocumentTypeCase=true | false

when set to False, converts the document type to uppercase when documents are added.

Default true

recordIdType="CHAR" | "INT32" | "INT64"

specifies the type of the record ID to use in the raw import tables when documents are added.

Default CHAR

createCompoundStore Action

Define elements, compounds and entities.

Python Syntax

results=s.rteng.createCompoundStore(
compoundStore={
"caslib":"string",
"compoundTable":"string",
"copies":integer,
"documentTable":"string",
"entityTable":"string",
"lockTable":"string",
"metadataTable":"string"
},
required parameter compoundTypes=[{
required parameter "elementTypes":["string-1" <, "string-2", ...>],
"maxCount":integer,
"maxElementTypeCounts":[{
"count":integer,
required parameter "elementType":"string",
"regressLimit":integer
}<, {...}>],
required parameter "name":"string"
}<, {...}>],
documentIdType="CHAR" | "INT32" | "INT64",
required parameter elementTypes=[{
"format":"string",
"isAttribute":True | False,
"keep":True | False,
required parameter "name":"string",
"type":"CHAR" | "DOUBLE" | "INT32" | "INT64",
"validtime":"NO" | "VALIDFROM" | "VALIDTO"
}<, {...}>],
required parameter entityTypes=[{
required parameter "compoundTypes":["string-1" <, "string-2", ...>],
required parameter "name":"string",
required parameter "primaryElementType":"string",
"validFrom":"string",
"validTo":"string"
}<, {...}>],
exclusionRegressLimit=integer,
preserveDocumentTypeCase=True | False,
recordIdType="CHAR" | "INT32" | "INT64"
)
indicates a required parameter

Parameter Descriptions

compoundStore={compoundStore}

specifies the table names and CAS library to use for the compound store across sessions.

Long form compoundStore={"caslib":"string"}
Shortcut form compoundStore="string"

The compoundStore value can be one or more of the following:

"caslib":"string"

specifies the CAS library in which to create or find the tables. This library must be a global library.

"compoundTable":"string"

specifies the name of the CAS table in which to store compounds.

Default "rtengCmpd"
"copies":integer

specifies the number of redundant copies to keep. A value of 0 is fastest but disables failover when a worker fails.

Default 1
Minimum value 0
"documentTable":"string"

specifies the name of the CAS table in which to store documents.

Default "rtengDoc"
"entityTable":"string"

specifies the name of the CAS table in which to store entities.

Default "rtengEntity"
"lockTable":"string"

specifies the name of the CAS table to use for preventing access to the compound store by other sessions while an action is running. This table is used internally and should never be created by the user.

Default "rtengLock"
"metadataTable":"string"

specifies the name of the CAS table in which to store the metadata, including the element, compound, and entity definitions.

Default "rtengMeta"

* compoundTypes=[{compoundType-1} <, {compoundType-2}, ...>]

defines the compound types that are used to identify entities.

The compoundType value can be one or more of the following:

* "elementTypes":["string-1" <, "string-2", ...>]

specifies the collection of element types that form this compound type.

"maxCount":integer

specifies the maximum number of times that a compound value of this type can appear in the data before the compound value is excluded.

Default MACINT
Minimum value 1
"maxElementTypeCounts":[{elementTypeCount-1} <, {elementTypeCount-2}, ...>]

specifies a collection of element type and counts for defining compound exclusions. A compound value is excluded if the total number of distinct element values of the type that you specify in the elementType parameter is greater than the value that you specify in the maxCount parameter.

The elementTypeCount value can be one or more of the following:

"count":integer

specifies the maximum number of distinct values of the element type that can occur across all data rows that are associated with the compound value. If you exceed this limit, the compound value is excluded.

Default 1
Minimum value 1
* "elementType":"string"

specifies the type of the element for which distinct values are counted.

"regressLimit":integer

specifies the maximum number of element values to store for the specified element type.

Default MACINT
Minimum value 1
* "name":"string"

specifies the name of the compound type. Compound types constitute collections of element types and are used to define entity types.

documentIdType="CHAR" | "INT32" | "INT64"

specifies the type of the document ID to use in the raw import tables when documents are added.

Default CHAR

* elementTypes=[{elementType-1} <, {elementType-2}, ...>]

defines the element types to be used to uniquely identify compounds.

The elementType value can be one or more of the following:

"format":"string"

specifies the SAS format to use when the value is output.

"isAttribute":True | False

when set to True, can use the element as an attribute for soft-deletes of documents and entities.

Default False
"keep":True | False

when set to True, includes this element's value in the output table. This parameter applies only to elements in the primary table.

Default False
* "name":"string"

specifies the name of an element that is used to define compounds. This name must match a column name in a raw import table when documents are added.

"type":"CHAR" | "DOUBLE" | "INT32" | "INT64"

specifies the type of the element.

Default CHAR
"validtime":"NO" | "VALIDFROM" | "VALIDTO"

specifies whether this element is used as a time value and, if so, whether the value represents a starting time or an ending time that an entity is active.

Default NO

* entityTypes=[{entityType-1} <, {entityType-2}, ...>]

defines the entity types.

The entityType value can be one or more of the following:

* "compoundTypes":["string-1" <, "string-2", ...>]

specifies one or more compound types that are used to define an entity.

* "name":"string"

specifies the name of the entity definition.

* "primaryElementType":"string"

specifies the element that defines the primary table when documents are added.

"validFrom":"string"

specifies the element that defines the starting time that this entity is active.

"validTo":"string"

specifies the element that defines the ending time that this entity is active.

exclusionRegressLimit=integer

specifies the maximum number of element values to store for computing compound exclusions. This limit is applied to each compound exclusion rule unless you specify a different limit by using the regressLimit subparameter of the maxElementTypeCounts parameter.

Default MACINT
Minimum value 1

preserveDocumentTypeCase=True | False

when set to False, converts the document type to uppercase when documents are added.

Default True

recordIdType="CHAR" | "INT32" | "INT64"

specifies the type of the record ID to use in the raw import tables when documents are added.

Default CHAR

createCompoundStore Action

Define elements, compounds and entities.

R Syntax

results <– cas.rteng.createCompoundStore(s,
compoundStore=list(
caslib="string",
compoundTable="string",
copies=integer,
documentTable="string",
entityTable="string",
lockTable="string",
metadataTable="string"
),
required parameter compoundTypes=list( list(
required parameter elementTypes=list("string-1" <, "string-2", ...>),
maxCount=integer,
maxElementTypeCounts=list( list(
count=integer,
required parameter elementType="string",
regressLimit=integer
) <, list(...)>),
required parameter name="string"
) <, list(...)>),
documentIdType="CHAR" | "INT32" | "INT64",
required parameter elementTypes=list( list(
format="string",
isAttribute=TRUE | FALSE,
keep=TRUE | FALSE,
required parameter name="string",
type="CHAR" | "DOUBLE" | "INT32" | "INT64",
validtime="NO" | "VALIDFROM" | "VALIDTO"
) <, list(...)>),
required parameter entityTypes=list( list(
required parameter compoundTypes=list("string-1" <, "string-2", ...>),
required parameter name="string",
required parameter primaryElementType="string",
validFrom="string",
validTo="string"
) <, list(...)>),
exclusionRegressLimit=integer,
preserveDocumentTypeCase=TRUE | FALSE,
recordIdType="CHAR" | "INT32" | "INT64"
)
indicates a required parameter

Parameter Descriptions

compoundStore=list(compoundStore)

specifies the table names and CAS library to use for the compound store across sessions.

Long form compoundStore=list(caslib="string")
Shortcut form compoundStore="string"

The compoundStore value can be one or more of the following:

caslib="string"

specifies the CAS library in which to create or find the tables. This library must be a global library.

compoundTable="string"

specifies the name of the CAS table in which to store compounds.

Default "rtengCmpd"
copies=integer

specifies the number of redundant copies to keep. A value of 0 is fastest but disables failover when a worker fails.

Default 1
Minimum value 0
documentTable="string"

specifies the name of the CAS table in which to store documents.

Default "rtengDoc"
entityTable="string"

specifies the name of the CAS table in which to store entities.

Default "rtengEntity"
lockTable="string"

specifies the name of the CAS table to use for preventing access to the compound store by other sessions while an action is running. This table is used internally and should never be created by the user.

Default "rtengLock"
metadataTable="string"

specifies the name of the CAS table in which to store the metadata, including the element, compound, and entity definitions.

Default "rtengMeta"

* compoundTypes=list( list(compoundType-1) <, list(compoundType-2), ...>)

defines the compound types that are used to identify entities.

The compoundType value can be one or more of the following:

* elementTypes=list("string-1" <, "string-2", ...>)

specifies the collection of element types that form this compound type.

maxCount=integer

specifies the maximum number of times that a compound value of this type can appear in the data before the compound value is excluded.

Default MACINT
Minimum value 1
maxElementTypeCounts=list( list(elementTypeCount-1) <, list(elementTypeCount-2), ...>)

specifies a collection of element type and counts for defining compound exclusions. A compound value is excluded if the total number of distinct element values of the type that you specify in the elementType parameter is greater than the value that you specify in the maxCount parameter.

The elementTypeCount value can be one or more of the following:

count=integer

specifies the maximum number of distinct values of the element type that can occur across all data rows that are associated with the compound value. If you exceed this limit, the compound value is excluded.

Default 1
Minimum value 1
* elementType="string"

specifies the type of the element for which distinct values are counted.

regressLimit=integer

specifies the maximum number of element values to store for the specified element type.

Default MACINT
Minimum value 1
* name="string"

specifies the name of the compound type. Compound types constitute collections of element types and are used to define entity types.

documentIdType="CHAR" | "INT32" | "INT64"

specifies the type of the document ID to use in the raw import tables when documents are added.

Default CHAR

* elementTypes=list( list(elementType-1) <, list(elementType-2), ...>)

defines the element types to be used to uniquely identify compounds.

The elementType value can be one or more of the following:

format="string"

specifies the SAS format to use when the value is output.

isAttribute=TRUE | FALSE

when set to True, can use the element as an attribute for soft-deletes of documents and entities.

Default FALSE
keep=TRUE | FALSE

when set to True, includes this element's value in the output table. This parameter applies only to elements in the primary table.

Default FALSE
* name="string"

specifies the name of an element that is used to define compounds. This name must match a column name in a raw import table when documents are added.

type="CHAR" | "DOUBLE" | "INT32" | "INT64"

specifies the type of the element.

Default CHAR
validtime="NO" | "VALIDFROM" | "VALIDTO"

specifies whether this element is used as a time value and, if so, whether the value represents a starting time or an ending time that an entity is active.

Default NO

* entityTypes=list( list(entityType-1) <, list(entityType-2), ...>)

defines the entity types.

The entityType value can be one or more of the following:

* compoundTypes=list("string-1" <, "string-2", ...>)

specifies one or more compound types that are used to define an entity.

* name="string"

specifies the name of the entity definition.

* primaryElementType="string"

specifies the element that defines the primary table when documents are added.

validFrom="string"

specifies the element that defines the starting time that this entity is active.

validTo="string"

specifies the element that defines the ending time that this entity is active.

exclusionRegressLimit=integer

specifies the maximum number of element values to store for computing compound exclusions. This limit is applied to each compound exclusion rule unless you specify a different limit by using the regressLimit subparameter of the maxElementTypeCounts parameter.

Default MACINT
Minimum value 1

preserveDocumentTypeCase=TRUE | FALSE

when set to False, converts the document type to uppercase when documents are added.

Default TRUE

recordIdType="CHAR" | "INT32" | "INT64"

specifies the type of the record ID to use in the raw import tables when documents are added.

Default CHAR
Last updated: November 23, 2025