Real-Time Entity and Network Generation Action Set

Provides actions for generating entities and networks from transactional data

queryCompounds Action

Create the network a compound belongs to.

CASL Syntax

rteng.queryCompounds <result=results> <status=rc> /
required parameter compounds={castable} | {{compoundTypeAndValue-1} <, {compoundTypeAndValue-2}, ...>},
compoundStore={
caslib="string",
compoundTable="string",
copies=integer,
documentTable="string",
entityTable="string",
lockTable="string",
metadataTable="string"
},
documentTypes={"string-1" <, "string-2", ...>},
entityTypes={"string-1" <, "string-2", ...>},
level=integer,
required parameter output={
caslib="string",
compress=TRUE | FALSE,
indexVars={"variable-name-1" <, "variable-name-2", ...>},
label="string",
lifetime=64-bit-integer,
maxMemSize=64-bit-integer,
memoryFormat="DVR" | "INHERIT" | "STANDARD",
name="table-name",
promote=TRUE | FALSE,
replace=TRUE | FALSE,
replication=integer,
tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE",
threadBlockSize=64-bit-integer,
timeStamp="string",
where={"string-1" <, "string-2", ...>}
},
outputCompoundValue=TRUE | FALSE,
outputDocumentLinks={
caslib="string",
compress=TRUE | FALSE,
indexVars={"variable-name-1" <, "variable-name-2", ...>},
label="string",
lifetime=64-bit-integer,
maxMemSize=64-bit-integer,
memoryFormat="DVR" | "INHERIT" | "STANDARD",
name="table-name",
promote=TRUE | FALSE,
replace=TRUE | FALSE,
replication=integer,
tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE",
threadBlockSize=64-bit-integer,
timeStamp="string",
where={"string-1" <, "string-2", ...>}
},
outputSubEntityId=TRUE | FALSE,
softDeleteDocuments={{
required parameter documentType="string",
hasAttribute={{
required parameter attribute="string",
required parameter value="string"
}, {...}},
maxEntityCount=integer,
maxEntityCountByType={{
required parameter entityType="string",
maxCount=integer
}, {...}}
}, {...}},
softDeleteEntities={{
required parameter entityType="string",
hasAttribute={{
required parameter attribute="string",
required parameter value="string"
}, {...}},
maxDocumentCount=integer,
maxDocumentCountByType={{
required parameter documentType="string",
maxCount=integer
}, {...}},
temporalSplitting=TRUE | FALSE
}, {...}},
softDeleteLinks={{
required parameter documentType="string",
required parameter entityType="string",
required parameter hasAttribute={{
required parameter attribute="string",
required parameter value="string"
}, {...}}
}, {...}},
softDeleteOutputOption="ADJACENT" | "AUTOMATIC" | "NONE",
splitConflictingEntities={{
required parameter conflictingCompoundValue={
compoundTypes={"string-1" <, "string-2", ...>}
doNotSplit={{
required parameter compoundType="string",
required parameter documentType="string"
}, {...}}
},
required parameter entityType="string"
}, {...}}
;
indicates a required parameter

Summary: Input and Output Tables

If a row includes a subparameter, you can specify the name, caslib, and so on in the subparameter. Otherwise, you can specify the name, caslib, and so on in the parameter.

Parameters for Reading Input Tables

Parameter

Subparameter

Description

required parametercompounds

—

specifies the compounds to query. These are the seed compounds where the network traversal begins.
Parameters for Creating Output Tables

Parameter

Subparameter

Description

required parameteroutput

—

specifies the output table in which to store the results of the action.

 outputDocumentLinks

—

specifies the output table in which to store the document links.

Parameter Descriptions

* compounds={castable} | {{compoundTypeAndValue-1} <, {compoundTypeAndValue-2}, ...>}

specifies the compounds to query. These are the seed compounds where the network traversal begins.

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

caslib="string"

specifies the caslib for the input table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.

computedOnDemand=TRUE | FALSE

when set to True, creates the computed variables when the table is loaded instead of when the action begins.

Alias compOnDemand
Default FALSE
computedVars={{casinvardesc-1} <, {casinvardesc-2}, ...>}

specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter. If you do not specify this parameter, then all variables from computedVarsProgram are automatically included.

Alias compVars

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

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

computedVarsProgram="string"

specifies an expression for each computed variable that you include in the computedVars parameter.

Alias compPgm
dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>}

specifies data source options.

Aliases options
dataSource
importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}

specifies the settings for reading a table from a data source.

Alias import

For more information about specifying the importOptions parameter, see the common importOptions parameter (Appendix A: Common Parameters).

* name="table-name"

specifies the name of the input table.

vars={{casinvardesc-1} <, {casinvardesc-2}, ...>}

specifies the variables to use in the action.

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

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

where="where-expression"

specifies an expression for subsetting the input data.

whereTable={groupbytable}

specifies an input table that contains rows to use as a WHERE filter. If the vars parameter is not specified, then all the variable names that are common to the input table and the filtering table are used to find matching rows. If the where parameter for the input table and this parameter are specified, then this filtering table is applied first.

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

casLib="string"

specifies the caslib for the filter table. By default, the active caslib is used.

dataSourceOptions={adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | fedsvr-parameters | gcs_noreq-parameters | hadoop-parameters | hana-parameters | impala-parameters | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}

specifies data source options.

Aliases options
dataSource

For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter (Appendix A: Common Parameters).

importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}

specifies the settings for reading a table from a data source.

Alias import

For more information about specifying the importOptions parameter, see the common importOptions parameter (Appendix A: Common Parameters).

* name="table-name"

specifies the name of the filter table.

vars={{casinvardesc-1} <, {casinvardesc-2}, ...>}

specifies the variable names to use from the filter table.

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

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

where="where-expression"

specifies an expression for subsetting the data from the filter table.

The compoundTypeAndValue value is specified as follows:

* compoundType="string"

specifies the type of the compound.

compoundValue="string"

specifies the value of the compound.

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"

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

specifies the document types to include in the results. If this parameter is not specified, all document types are included.

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

specifies the entity types to include in the results. If this parameter is not specified, all entity types are included.

level=integer

specifies the maximum number of documents that are searched in a path before the search is stopped. A value of 0 includes all documents that can be reached from the starting documents or compounds.

Default 0
Range 0–64

* output={casouttable}

specifies the output table in which to store the results of the action.

For more information about specifying the output parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).

outputCompoundValue=TRUE | FALSE

when set to True, includes in the output table the compound_value column that contains a concatenation of the element values that make up the compound value.

Default FALSE

specifies the output table in which to store the document links.

For more information about specifying the outputDocumentLinks parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).

outputSubEntityId=TRUE | FALSE

when set to True, includes the _subentity_id_ column in the output table that contains a subentity ID as determined by temporal splitting. By default, this is set to True if temporal splitting is enabled for an entity soft-delete, otherwise it is set to False.

Default FALSE

softDeleteDocuments={{softDeleteDocuments-1} <, {softDeleteDocuments-2}, ...>}

specifies the rules that define the document soft-deletes.

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

* documentType="string"

specifies the type of document to which the soft-delete rule applies.

hasAttribute={{attributeValue-1} <, {attributeValue-2}, ...>}

specifies a collection of attribute names and values for defining document soft-deletes. The document is soft-deleted if it contains any of the listed attributes.

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

* attribute="string"

specifies the name of the attribute. This name must correspond to one of the columns from the input data tables.

* value="string"

specifies the value of the attribute.

maxEntityCount=integer

specifies the maximum number of entities to which a document can be connected before being soft-deleted.

Default MACINT
Minimum value 1
maxEntityCountByType={{entityCountByType-1} <, {entityCountByType-2}, ...>}

specifies a collection of entity type and count pairs for defining document soft-deletes. The document is soft-deleted if the number of connections it has to entities of the type specified in the entityType parameter exceeds the value of the maxCount parameter.

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

* entityType="string"

specifies the type of the entity to be counted.

maxCount=integer

specifies the maximum number of entities of the type specified in the entityType parameter to which a document can be connected before the document is soft-deleted.

Default 1
Minimum value 1

softDeleteEntities={{softDeleteEntities-1} <, {softDeleteEntities-2}, ...>}

specifies the rules that define the entity soft-deletes.

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

* entityType="string"

specifies the type of entity to which the soft-delete rule applies.

hasAttribute={{attributeValue-1} <, {attributeValue-2}, ...>}

specifies a collection of attribute names and values for defining entity soft-deletes. The entity is soft-deleted if it contains any of the listed attributes.

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

* attribute="string"

specifies the name of the attribute. This name must correspond to one of the columns from the input data tables.

* value="string"

specifies the value of the attribute.

maxDocumentCount=integer

specifies the maximum number of documents to which an entity can be connected before being soft-deleted.

Default MACINT
Minimum value 1
maxDocumentCountByType={{docCountByType-1} <, {docCountByType-2}, ...>}

specifies a collection of document type and count pairs for defining entity soft-deletes. The entity will be soft-deleted if it violates any of the rules.

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

* documentType="string"

specifies the type of the document to be counted.

maxCount=integer

specifies the maximum number of documents of the type specified in the documentType parameter to which an entity can be connected before the entity is soft-deleted.

Default 1
Minimum value 1
temporalSplitting=TRUE | FALSE

when set to True, temporally splits entities of this type into subentities.

Default FALSE

specifies the rules that define the link soft-deletes.

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

specifies the type of document to consider for soft-deleting a link.

specifies the type of entity to consider for soft-deleting a link.

specifies a collection of attribute names and values for defining link soft-deletes. The link is soft-deleted if it contains any of the listed attributes.

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

specifies the name of the attribute. This name must correspond to one of the columns from the input data tables.

specifies the value of the attribute.

softDeleteOutputOption="ADJACENT" | "AUTOMATIC" | "NONE"

specifies how to output soft-deleted items.

Default AUTOMATIC
ADJACENT

includes in the output soft-deleted items that are connected to the generated networks.

AUTOMATIC

uses option ADJACENT if soft-deletes are specified or NONE if soft-deletes are not specified.

NONE

does not include any soft-deleted items in the output.

splitConflictingEntities={{entitySplit-1} <, {entitySplit-2}, ...>}

specifies the conditions under which an entity should be split.

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

* conflictingCompoundValue={conflictingCompound}

specifies the rules under which an entity should be split on the basis of compound values.

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

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

specifies the types of compounds whose values must be consistent within an entity. If an entity contains different values for a compound type in this list, the entity will split into one or more entities such that each entity contains one value for each compound type in this list.

doNotSplit={{docAndCmpdType-1} <, {docAndCmpdType-2}, ...>}

specifies the pairs consisting of a document type and a compound type that should not be split during entity splitting.

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

* compoundType="string"

specifies the compound type.

* documentType="string"

specifies the document type.

* entityType="string"

specifies the type of entity to which the entity splitting rule applies.

queryCompounds Action

Create the network a compound belongs to.

Lua Syntax

results, info = s:rteng_queryCompounds{
required parameter compounds={castable} | {{compoundTypeAndValue-1} <, {compoundTypeAndValue-2}, ...>},
compoundStore={
caslib="string",
compoundTable="string",
copies=integer,
documentTable="string",
entityTable="string",
lockTable="string",
metadataTable="string"
},
documentTypes={"string-1" <, "string-2", ...>},
entityTypes={"string-1" <, "string-2", ...>},
level=integer,
required parameter output={
caslib="string",
compress=true | false,
indexVars={"variable-name-1" <, "variable-name-2", ...>},
label="string",
lifetime=64-bit-integer,
maxMemSize=64-bit-integer,
memoryFormat="DVR" | "INHERIT" | "STANDARD",
name="table-name",
promote=true | false,
replace=true | false,
replication=integer,
tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE",
threadBlockSize=64-bit-integer,
timeStamp="string",
where={"string-1" <, "string-2", ...>}
},
outputCompoundValue=true | false,
outputDocumentLinks={
caslib="string",
compress=true | false,
indexVars={"variable-name-1" <, "variable-name-2", ...>},
label="string",
lifetime=64-bit-integer,
maxMemSize=64-bit-integer,
memoryFormat="DVR" | "INHERIT" | "STANDARD",
name="table-name",
promote=true | false,
replace=true | false,
replication=integer,
tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE",
threadBlockSize=64-bit-integer,
timeStamp="string",
where={"string-1" <, "string-2", ...>}
},
outputSubEntityId=true | false,
softDeleteDocuments={{
required parameter documentType="string",
hasAttribute={{
required parameter attribute="string",
required parameter value="string"
}, {...}},
maxEntityCount=integer,
maxEntityCountByType={{
required parameter entityType="string",
maxCount=integer
}, {...}}
}, {...}},
softDeleteEntities={{
required parameter entityType="string",
hasAttribute={{
required parameter attribute="string",
required parameter value="string"
}, {...}},
maxDocumentCount=integer,
maxDocumentCountByType={{
required parameter documentType="string",
maxCount=integer
}, {...}},
temporalSplitting=true | false
}, {...}},
softDeleteLinks={{
required parameter documentType="string",
required parameter entityType="string",
required parameter hasAttribute={{
required parameter attribute="string",
required parameter value="string"
}, {...}}
}, {...}},
softDeleteOutputOption="ADJACENT" | "AUTOMATIC" | "NONE",
splitConflictingEntities={{
required parameter conflictingCompoundValue={
compoundTypes={"string-1" <, "string-2", ...>}
doNotSplit={{
required parameter compoundType="string",
required parameter documentType="string"
}, {...}}
},
required parameter entityType="string"
}, {...}}
}
indicates a required parameter

Summary: Input and Output Tables

If a row includes a subparameter, you can specify the name, caslib, and so on in the subparameter. Otherwise, you can specify the name, caslib, and so on in the parameter.

Parameters for Reading Input Tables

Parameter

Subparameter

Description

required parametercompounds

—

specifies the compounds to query. These are the seed compounds where the network traversal begins.
Parameters for Creating Output Tables

Parameter

Subparameter

Description

required parameteroutput

—

specifies the output table in which to store the results of the action.

 outputDocumentLinks

—

specifies the output table in which to store the document links.

Parameter Descriptions

* compounds={castable} | {{compoundTypeAndValue-1} <, {compoundTypeAndValue-2}, ...>}

specifies the compounds to query. These are the seed compounds where the network traversal begins.

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

caslib="string"

specifies the caslib for the input table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.

computedOnDemand=true | false

when set to True, creates the computed variables when the table is loaded instead of when the action begins.

Alias compOnDemand
Default false
computedVars={{casinvardesc-1} <, {casinvardesc-2}, ...>}

specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter. If you do not specify this parameter, then all variables from computedVarsProgram are automatically included.

Alias compVars

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

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

computedVarsProgram="string"

specifies an expression for each computed variable that you include in the computedVars parameter.

Alias compPgm
dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>}

specifies data source options.

Aliases options
dataSource
importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}

specifies the settings for reading a table from a data source.

Alias import

For more information about specifying the importOptions parameter, see the common importOptions parameter (Appendix A: Common Parameters).

* name="table-name"

specifies the name of the input table.

vars={{casinvardesc-1} <, {casinvardesc-2}, ...>}

specifies the variables to use in the action.

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

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

where="where-expression"

specifies an expression for subsetting the input data.

whereTable={groupbytable}

specifies an input table that contains rows to use as a WHERE filter. If the vars parameter is not specified, then all the variable names that are common to the input table and the filtering table are used to find matching rows. If the where parameter for the input table and this parameter are specified, then this filtering table is applied first.

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

casLib="string"

specifies the caslib for the filter table. By default, the active caslib is used.

dataSourceOptions={adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | fedsvr-parameters | gcs_noreq-parameters | hadoop-parameters | hana-parameters | impala-parameters | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}

specifies data source options.

Aliases options
dataSource

For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter (Appendix A: Common Parameters).

importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}

specifies the settings for reading a table from a data source.

Alias import

For more information about specifying the importOptions parameter, see the common importOptions parameter (Appendix A: Common Parameters).

* name="table-name"

specifies the name of the filter table.

vars={{casinvardesc-1} <, {casinvardesc-2}, ...>}

specifies the variable names to use from the filter table.

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

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

where="where-expression"

specifies an expression for subsetting the data from the filter table.

The compoundTypeAndValue value is specified as follows:

* compoundType="string"

specifies the type of the compound.

compoundValue="string"

specifies the value of the compound.

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"

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

specifies the document types to include in the results. If this parameter is not specified, all document types are included.

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

specifies the entity types to include in the results. If this parameter is not specified, all entity types are included.

level=integer

specifies the maximum number of documents that are searched in a path before the search is stopped. A value of 0 includes all documents that can be reached from the starting documents or compounds.

Default 0
Range 0–64

* output={casouttable}

specifies the output table in which to store the results of the action.

For more information about specifying the output parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).

outputCompoundValue=true | false

when set to True, includes in the output table the compound_value column that contains a concatenation of the element values that make up the compound value.

Default false

specifies the output table in which to store the document links.

For more information about specifying the outputDocumentLinks parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).

outputSubEntityId=true | false

when set to True, includes the _subentity_id_ column in the output table that contains a subentity ID as determined by temporal splitting. By default, this is set to True if temporal splitting is enabled for an entity soft-delete, otherwise it is set to False.

Default false

softDeleteDocuments={{softDeleteDocuments-1} <, {softDeleteDocuments-2}, ...>}

specifies the rules that define the document soft-deletes.

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

* documentType="string"

specifies the type of document to which the soft-delete rule applies.

hasAttribute={{attributeValue-1} <, {attributeValue-2}, ...>}

specifies a collection of attribute names and values for defining document soft-deletes. The document is soft-deleted if it contains any of the listed attributes.

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

* attribute="string"

specifies the name of the attribute. This name must correspond to one of the columns from the input data tables.

* value="string"

specifies the value of the attribute.

maxEntityCount=integer

specifies the maximum number of entities to which a document can be connected before being soft-deleted.

Default MACINT
Minimum value 1
maxEntityCountByType={{entityCountByType-1} <, {entityCountByType-2}, ...>}

specifies a collection of entity type and count pairs for defining document soft-deletes. The document is soft-deleted if the number of connections it has to entities of the type specified in the entityType parameter exceeds the value of the maxCount parameter.

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

* entityType="string"

specifies the type of the entity to be counted.

maxCount=integer

specifies the maximum number of entities of the type specified in the entityType parameter to which a document can be connected before the document is soft-deleted.

Default 1
Minimum value 1

softDeleteEntities={{softDeleteEntities-1} <, {softDeleteEntities-2}, ...>}

specifies the rules that define the entity soft-deletes.

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

* entityType="string"

specifies the type of entity to which the soft-delete rule applies.

hasAttribute={{attributeValue-1} <, {attributeValue-2}, ...>}

specifies a collection of attribute names and values for defining entity soft-deletes. The entity is soft-deleted if it contains any of the listed attributes.

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

* attribute="string"

specifies the name of the attribute. This name must correspond to one of the columns from the input data tables.

* value="string"

specifies the value of the attribute.

maxDocumentCount=integer

specifies the maximum number of documents to which an entity can be connected before being soft-deleted.

Default MACINT
Minimum value 1
maxDocumentCountByType={{docCountByType-1} <, {docCountByType-2}, ...>}

specifies a collection of document type and count pairs for defining entity soft-deletes. The entity will be soft-deleted if it violates any of the rules.

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

* documentType="string"

specifies the type of the document to be counted.

maxCount=integer

specifies the maximum number of documents of the type specified in the documentType parameter to which an entity can be connected before the entity is soft-deleted.

Default 1
Minimum value 1
temporalSplitting=true | false

when set to True, temporally splits entities of this type into subentities.

Default false

specifies the rules that define the link soft-deletes.

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

specifies the type of document to consider for soft-deleting a link.

specifies the type of entity to consider for soft-deleting a link.

specifies a collection of attribute names and values for defining link soft-deletes. The link is soft-deleted if it contains any of the listed attributes.

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

specifies the name of the attribute. This name must correspond to one of the columns from the input data tables.

specifies the value of the attribute.

softDeleteOutputOption="ADJACENT" | "AUTOMATIC" | "NONE"

specifies how to output soft-deleted items.

Default AUTOMATIC
ADJACENT

includes in the output soft-deleted items that are connected to the generated networks.

AUTOMATIC

uses option ADJACENT if soft-deletes are specified or NONE if soft-deletes are not specified.

NONE

does not include any soft-deleted items in the output.

splitConflictingEntities={{entitySplit-1} <, {entitySplit-2}, ...>}

specifies the conditions under which an entity should be split.

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

* conflictingCompoundValue={conflictingCompound}

specifies the rules under which an entity should be split on the basis of compound values.

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

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

specifies the types of compounds whose values must be consistent within an entity. If an entity contains different values for a compound type in this list, the entity will split into one or more entities such that each entity contains one value for each compound type in this list.

doNotSplit={{docAndCmpdType-1} <, {docAndCmpdType-2}, ...>}

specifies the pairs consisting of a document type and a compound type that should not be split during entity splitting.

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

* compoundType="string"

specifies the compound type.

* documentType="string"

specifies the document type.

* entityType="string"

specifies the type of entity to which the entity splitting rule applies.

queryCompounds Action

Create the network a compound belongs to.

Python Syntax

results=s.rteng.queryCompounds(
required parameter compounds={castable} | [{compoundTypeAndValue-1} <, {compoundTypeAndValue-2}, ...>],
compoundStore={
"caslib":"string",
"compoundTable":"string",
"copies":integer,
"documentTable":"string",
"entityTable":"string",
"lockTable":"string",
"metadataTable":"string"
},
documentTypes=["string-1" <, "string-2", ...>],
entityTypes=["string-1" <, "string-2", ...>],
level=integer,
required parameter output={
"caslib":"string",
"compress":True | False,
"indexVars":["variable-name-1" <, "variable-name-2", ...>],
"label":"string",
"lifetime":64-bit-integer,
"maxMemSize":64-bit-integer,
"memoryFormat":"DVR" | "INHERIT" | "STANDARD",
"name":"table-name",
"promote":True | False,
"replace":True | False,
"replication":integer,
"tableRedistUpPolicy":"DEFER" | "NOREDIST" | "REBALANCE",
"threadBlockSize":64-bit-integer,
"timeStamp":"string",
"where":["string-1" <, "string-2", ...>]
},
outputCompoundValue=True | False,
outputDocumentLinks={
"caslib":"string",
"compress":True | False,
"indexVars":["variable-name-1" <, "variable-name-2", ...>],
"label":"string",
"lifetime":64-bit-integer,
"maxMemSize":64-bit-integer,
"memoryFormat":"DVR" | "INHERIT" | "STANDARD",
"name":"table-name",
"promote":True | False,
"replace":True | False,
"replication":integer,
"tableRedistUpPolicy":"DEFER" | "NOREDIST" | "REBALANCE",
"threadBlockSize":64-bit-integer,
"timeStamp":"string",
"where":["string-1" <, "string-2", ...>]
},
outputSubEntityId=True | False,
softDeleteDocuments=[{
required parameter "documentType":"string",
"hasAttribute":[{
required parameter "attribute":"string",
required parameter "value":"string"
}<, {...}>],
"maxEntityCount":integer,
"maxEntityCountByType":[{
required parameter "entityType":"string",
"maxCount":integer
}<, {...}>]
}<, {...}>],
softDeleteEntities=[{
required parameter "entityType":"string",
"hasAttribute":[{
required parameter "attribute":"string",
required parameter "value":"string"
}<, {...}>],
"maxDocumentCount":integer,
"maxDocumentCountByType":[{
required parameter "documentType":"string",
"maxCount":integer
}<, {...}>],
"temporalSplitting":True | False
}<, {...}>],
softDeleteLinks=[{
required parameter "documentType":"string",
required parameter "entityType":"string",
required parameter "hasAttribute":[{
required parameter "attribute":"string",
required parameter "value":"string"
}<, {...}>]
}<, {...}>],
softDeleteOutputOption="ADJACENT" | "AUTOMATIC" | "NONE",
splitConflictingEntities=[{
required parameter "conflictingCompoundValue":{
"compoundTypes":["string-1" <, "string-2", ...>]
"doNotSplit":[{
required parameter "compoundType":"string",
required parameter "documentType":"string"
}<, {...}>]
},
required parameter "entityType":"string"
}<, {...}>]
)
indicates a required parameter

Summary: Input and Output Tables

If a row includes a subparameter, you can specify the name, caslib, and so on in the subparameter. Otherwise, you can specify the name, caslib, and so on in the parameter.

Parameters for Reading Input Tables

Parameter

Subparameter

Description

required parametercompounds

—

specifies the compounds to query. These are the seed compounds where the network traversal begins.
Parameters for Creating Output Tables

Parameter

Subparameter

Description

required parameteroutput

—

specifies the output table in which to store the results of the action.

 outputDocumentLinks

—

specifies the output table in which to store the document links.

Parameter Descriptions

* compounds={castable} | [{compoundTypeAndValue-1} <, {compoundTypeAndValue-2}, ...>]

specifies the compounds to query. These are the seed compounds where the network traversal begins.

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

"caslib":"string"

specifies the caslib for the input table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.

"computedOnDemand":True | False

when set to True, creates the computed variables when the table is loaded instead of when the action begins.

Alias compOnDemand
Default False
"computedVars":[{casinvardesc-1} <, {casinvardesc-2}, ...>]

specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter. If you do not specify this parameter, then all variables from computedVarsProgram are automatically included.

Alias compVars

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

"format":"string"

specifies the format to apply to the variable.

"formattedLength":integer

specifies the length of the format field plus the length of the format precision.

"label":"string"

specifies the descriptive label for the variable.

* "name":"variable-name"

specifies the name for the variable.

"nfd":integer

specifies the length of the format precision.

"nfl":integer

specifies the length of the format field.

"computedVarsProgram":"string"

specifies an expression for each computed variable that you include in the computedVars parameter.

Alias compPgm
"dataSourceOptions":{"key-1":{any-list-or-data-type-1} <, "key-2":{any-list-or-data-type-2}, ...>}

specifies data source options.

Aliases options
dataSource
"importOptions":{"fileType":"ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}

specifies the settings for reading a table from a data source.

Alias import_

For more information about specifying the importOptions parameter, see the common importOptions parameter (Appendix A: Common Parameters).

* "name":"table-name"

specifies the name of the input table.

"vars":[{casinvardesc-1} <, {casinvardesc-2}, ...>]

specifies the variables to use in the action.

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

"format":"string"

specifies the format to apply to the variable.

"formattedLength":integer

specifies the length of the format field plus the length of the format precision.

"label":"string"

specifies the descriptive label for the variable.

* "name":"variable-name"

specifies the name for the variable.

"nfd":integer

specifies the length of the format precision.

"nfl":integer

specifies the length of the format field.

"where":"where-expression"

specifies an expression for subsetting the input data.

"whereTable":{groupbytable}

specifies an input table that contains rows to use as a WHERE filter. If the vars parameter is not specified, then all the variable names that are common to the input table and the filtering table are used to find matching rows. If the where parameter for the input table and this parameter are specified, then this filtering table is applied first.

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

"casLib":"string"

specifies the caslib for the filter table. By default, the active caslib is used.

"dataSourceOptions":{adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | fedsvr-parameters | gcs_noreq-parameters | hadoop-parameters | hana-parameters | impala-parameters | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}

specifies data source options.

Aliases options
dataSource

For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter (Appendix A: Common Parameters).

"importOptions":{"fileType":"ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}

specifies the settings for reading a table from a data source.

Alias import_

For more information about specifying the importOptions parameter, see the common importOptions parameter (Appendix A: Common Parameters).

* "name":"table-name"

specifies the name of the filter table.

"vars":[{casinvardesc-1} <, {casinvardesc-2}, ...>]

specifies the variable names to use from the filter table.

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

"format":"string"

specifies the format to apply to the variable.

"formattedLength":integer

specifies the length of the format field plus the length of the format precision.

"label":"string"

specifies the descriptive label for the variable.

* "name":"variable-name"

specifies the name for the variable.

"nfd":integer

specifies the length of the format precision.

"nfl":integer

specifies the length of the format field.

"where":"where-expression"

specifies an expression for subsetting the data from the filter table.

The compoundTypeAndValue value is specified as follows:

* "compoundType":"string"

specifies the type of the compound.

"compoundValue":"string"

specifies the value of the compound.

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"

documentTypes=["string-1" <, "string-2", ...>]

specifies the document types to include in the results. If this parameter is not specified, all document types are included.

entityTypes=["string-1" <, "string-2", ...>]

specifies the entity types to include in the results. If this parameter is not specified, all entity types are included.

level=integer

specifies the maximum number of documents that are searched in a path before the search is stopped. A value of 0 includes all documents that can be reached from the starting documents or compounds.

Default 0
Range 0–64

* output={casouttable}

specifies the output table in which to store the results of the action.

For more information about specifying the output parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).

outputCompoundValue=True | False

when set to True, includes in the output table the compound_value column that contains a concatenation of the element values that make up the compound value.

Default False

specifies the output table in which to store the document links.

For more information about specifying the outputDocumentLinks parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).

outputSubEntityId=True | False

when set to True, includes the _subentity_id_ column in the output table that contains a subentity ID as determined by temporal splitting. By default, this is set to True if temporal splitting is enabled for an entity soft-delete, otherwise it is set to False.

Default False

softDeleteDocuments=[{softDeleteDocuments-1} <, {softDeleteDocuments-2}, ...>]

specifies the rules that define the document soft-deletes.

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

* "documentType":"string"

specifies the type of document to which the soft-delete rule applies.

"hasAttribute":[{attributeValue-1} <, {attributeValue-2}, ...>]

specifies a collection of attribute names and values for defining document soft-deletes. The document is soft-deleted if it contains any of the listed attributes.

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

* "attribute":"string"

specifies the name of the attribute. This name must correspond to one of the columns from the input data tables.

* "value":"string"

specifies the value of the attribute.

"maxEntityCount":integer

specifies the maximum number of entities to which a document can be connected before being soft-deleted.

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

specifies a collection of entity type and count pairs for defining document soft-deletes. The document is soft-deleted if the number of connections it has to entities of the type specified in the entityType parameter exceeds the value of the maxCount parameter.

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

* "entityType":"string"

specifies the type of the entity to be counted.

"maxCount":integer

specifies the maximum number of entities of the type specified in the entityType parameter to which a document can be connected before the document is soft-deleted.

Default 1
Minimum value 1

softDeleteEntities=[{softDeleteEntities-1} <, {softDeleteEntities-2}, ...>]

specifies the rules that define the entity soft-deletes.

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

* "entityType":"string"

specifies the type of entity to which the soft-delete rule applies.

"hasAttribute":[{attributeValue-1} <, {attributeValue-2}, ...>]

specifies a collection of attribute names and values for defining entity soft-deletes. The entity is soft-deleted if it contains any of the listed attributes.

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

* "attribute":"string"

specifies the name of the attribute. This name must correspond to one of the columns from the input data tables.

* "value":"string"

specifies the value of the attribute.

"maxDocumentCount":integer

specifies the maximum number of documents to which an entity can be connected before being soft-deleted.

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

specifies a collection of document type and count pairs for defining entity soft-deletes. The entity will be soft-deleted if it violates any of the rules.

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

* "documentType":"string"

specifies the type of the document to be counted.

"maxCount":integer

specifies the maximum number of documents of the type specified in the documentType parameter to which an entity can be connected before the entity is soft-deleted.

Default 1
Minimum value 1
"temporalSplitting":True | False

when set to True, temporally splits entities of this type into subentities.

Default False

specifies the rules that define the link soft-deletes.

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

specifies the type of document to consider for soft-deleting a link.

specifies the type of entity to consider for soft-deleting a link.

specifies a collection of attribute names and values for defining link soft-deletes. The link is soft-deleted if it contains any of the listed attributes.

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

specifies the name of the attribute. This name must correspond to one of the columns from the input data tables.

specifies the value of the attribute.

softDeleteOutputOption="ADJACENT" | "AUTOMATIC" | "NONE"

specifies how to output soft-deleted items.

Default AUTOMATIC
ADJACENT

includes in the output soft-deleted items that are connected to the generated networks.

AUTOMATIC

uses option ADJACENT if soft-deletes are specified or NONE if soft-deletes are not specified.

NONE

does not include any soft-deleted items in the output.

splitConflictingEntities=[{entitySplit-1} <, {entitySplit-2}, ...>]

specifies the conditions under which an entity should be split.

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

* "conflictingCompoundValue":{conflictingCompound}

specifies the rules under which an entity should be split on the basis of compound values.

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

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

specifies the types of compounds whose values must be consistent within an entity. If an entity contains different values for a compound type in this list, the entity will split into one or more entities such that each entity contains one value for each compound type in this list.

"doNotSplit":[{docAndCmpdType-1} <, {docAndCmpdType-2}, ...>]

specifies the pairs consisting of a document type and a compound type that should not be split during entity splitting.

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

* "compoundType":"string"

specifies the compound type.

* "documentType":"string"

specifies the document type.

* "entityType":"string"

specifies the type of entity to which the entity splitting rule applies.

queryCompounds Action

Create the network a compound belongs to.

R Syntax

results <– cas.rteng.queryCompounds(s,
required parameter compounds=list(castable) | list( list(compoundTypeAndValue-1) <, list(compoundTypeAndValue-2), ...>),
compoundStore=list(
caslib="string",
compoundTable="string",
copies=integer,
documentTable="string",
entityTable="string",
lockTable="string",
metadataTable="string"
),
documentTypes=list("string-1" <, "string-2", ...>),
entityTypes=list("string-1" <, "string-2", ...>),
level=integer,
required parameter output=list(
caslib="string",
compress=TRUE | FALSE,
indexVars=list("variable-name-1" <, "variable-name-2", ...>),
label="string",
lifetime=64-bit-integer,
maxMemSize=64-bit-integer,
memoryFormat="DVR" | "INHERIT" | "STANDARD",
name="table-name",
promote=TRUE | FALSE,
replace=TRUE | FALSE,
replication=integer,
tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE",
threadBlockSize=64-bit-integer,
timeStamp="string",
where=list("string-1" <, "string-2", ...>)
),
outputCompoundValue=TRUE | FALSE,
outputDocumentLinks=list(
caslib="string",
compress=TRUE | FALSE,
indexVars=list("variable-name-1" <, "variable-name-2", ...>),
label="string",
lifetime=64-bit-integer,
maxMemSize=64-bit-integer,
memoryFormat="DVR" | "INHERIT" | "STANDARD",
name="table-name",
promote=TRUE | FALSE,
replace=TRUE | FALSE,
replication=integer,
tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE",
threadBlockSize=64-bit-integer,
timeStamp="string",
where=list("string-1" <, "string-2", ...>)
),
outputSubEntityId=TRUE | FALSE,
softDeleteDocuments=list( list(
required parameter documentType="string",
hasAttribute=list( list(
required parameter attribute="string",
required parameter value="string"
) <, list(...)>),
maxEntityCount=integer,
maxEntityCountByType=list( list(
required parameter entityType="string",
maxCount=integer
) <, list(...)>)
) <, list(...)>),
softDeleteEntities=list( list(
required parameter entityType="string",
hasAttribute=list( list(
required parameter attribute="string",
required parameter value="string"
) <, list(...)>),
maxDocumentCount=integer,
maxDocumentCountByType=list( list(
required parameter documentType="string",
maxCount=integer
) <, list(...)>),
temporalSplitting=TRUE | FALSE
) <, list(...)>),
softDeleteLinks=list( list(
required parameter documentType="string",
required parameter entityType="string",
required parameter hasAttribute=list( list(
required parameter attribute="string",
required parameter value="string"
) <, list(...)>)
) <, list(...)>),
softDeleteOutputOption="ADJACENT" | "AUTOMATIC" | "NONE",
splitConflictingEntities=list( list(
required parameter conflictingCompoundValue=list(
compoundTypes=list("string-1" <, "string-2", ...>)
doNotSplit=list( list(
required parameter compoundType="string",
required parameter documentType="string"
) <, list(...)>)
),
required parameter entityType="string"
) <, list(...)>)
)
indicates a required parameter

Summary: Input and Output Tables

If a row includes a subparameter, you can specify the name, caslib, and so on in the subparameter. Otherwise, you can specify the name, caslib, and so on in the parameter.

Parameters for Reading Input Tables

Parameter

Subparameter

Description

required parametercompounds

—

specifies the compounds to query. These are the seed compounds where the network traversal begins.
Parameters for Creating Output Tables

Parameter

Subparameter

Description

required parameteroutput

—

specifies the output table in which to store the results of the action.

 outputDocumentLinks

—

specifies the output table in which to store the document links.

Parameter Descriptions

* compounds={castable} | list( list(compoundTypeAndValue-1) <, list(compoundTypeAndValue-2), ...>)

specifies the compounds to query. These are the seed compounds where the network traversal begins.

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

caslib="string"

specifies the caslib for the input table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.

computedOnDemand=TRUE | FALSE

when set to True, creates the computed variables when the table is loaded instead of when the action begins.

Alias compOnDemand
Default FALSE
computedVars=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)

specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter. If you do not specify this parameter, then all variables from computedVarsProgram are automatically included.

Alias compVars

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

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

computedVarsProgram="string"

specifies an expression for each computed variable that you include in the computedVars parameter.

Alias compPgm
dataSourceOptions=list(key-1=list(any-list-or-data-type-1) <, key-2=list(any-list-or-data-type-2), ...>)

specifies data source options.

Aliases options
dataSource
importOptions=list(fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters)

specifies the settings for reading a table from a data source.

Alias import

For more information about specifying the importOptions parameter, see the common importOptions parameter (Appendix A: Common Parameters).

* name="table-name"

specifies the name of the input table.

vars=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)

specifies the variables to use in the action.

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

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

where="where-expression"

specifies an expression for subsetting the input data.

whereTable=list(groupbytable)

specifies an input table that contains rows to use as a WHERE filter. If the vars parameter is not specified, then all the variable names that are common to the input table and the filtering table are used to find matching rows. If the where parameter for the input table and this parameter are specified, then this filtering table is applied first.

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

casLib="string"

specifies the caslib for the filter table. By default, the active caslib is used.

dataSourceOptions=list(adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | fedsvr-parameters | gcs_noreq-parameters | hadoop-parameters | hana-parameters | impala-parameters | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters)

specifies data source options.

Aliases options
dataSource

For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter (Appendix A: Common Parameters).

importOptions=list(fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters)

specifies the settings for reading a table from a data source.

Alias import

For more information about specifying the importOptions parameter, see the common importOptions parameter (Appendix A: Common Parameters).

* name="table-name"

specifies the name of the filter table.

vars=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)

specifies the variable names to use from the filter table.

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

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

where="where-expression"

specifies an expression for subsetting the data from the filter table.

The compoundTypeAndValue value is specified as follows:

* compoundType="string"

specifies the type of the compound.

compoundValue="string"

specifies the value of the compound.

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"

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

specifies the document types to include in the results. If this parameter is not specified, all document types are included.

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

specifies the entity types to include in the results. If this parameter is not specified, all entity types are included.

level=integer

specifies the maximum number of documents that are searched in a path before the search is stopped. A value of 0 includes all documents that can be reached from the starting documents or compounds.

Default 0
Range 0–64

* output=list(casouttable)

specifies the output table in which to store the results of the action.

For more information about specifying the output parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).

outputCompoundValue=TRUE | FALSE

when set to True, includes in the output table the compound_value column that contains a concatenation of the element values that make up the compound value.

Default FALSE

specifies the output table in which to store the document links.

For more information about specifying the outputDocumentLinks parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).

outputSubEntityId=TRUE | FALSE

when set to True, includes the _subentity_id_ column in the output table that contains a subentity ID as determined by temporal splitting. By default, this is set to True if temporal splitting is enabled for an entity soft-delete, otherwise it is set to False.

Default FALSE

softDeleteDocuments=list( list(softDeleteDocuments-1) <, list(softDeleteDocuments-2), ...>)

specifies the rules that define the document soft-deletes.

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

* documentType="string"

specifies the type of document to which the soft-delete rule applies.

hasAttribute=list( list(attributeValue-1) <, list(attributeValue-2), ...>)

specifies a collection of attribute names and values for defining document soft-deletes. The document is soft-deleted if it contains any of the listed attributes.

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

* attribute="string"

specifies the name of the attribute. This name must correspond to one of the columns from the input data tables.

* value="string"

specifies the value of the attribute.

maxEntityCount=integer

specifies the maximum number of entities to which a document can be connected before being soft-deleted.

Default MACINT
Minimum value 1
maxEntityCountByType=list( list(entityCountByType-1) <, list(entityCountByType-2), ...>)

specifies a collection of entity type and count pairs for defining document soft-deletes. The document is soft-deleted if the number of connections it has to entities of the type specified in the entityType parameter exceeds the value of the maxCount parameter.

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

* entityType="string"

specifies the type of the entity to be counted.

maxCount=integer

specifies the maximum number of entities of the type specified in the entityType parameter to which a document can be connected before the document is soft-deleted.

Default 1
Minimum value 1

softDeleteEntities=list( list(softDeleteEntities-1) <, list(softDeleteEntities-2), ...>)

specifies the rules that define the entity soft-deletes.

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

* entityType="string"

specifies the type of entity to which the soft-delete rule applies.

hasAttribute=list( list(attributeValue-1) <, list(attributeValue-2), ...>)

specifies a collection of attribute names and values for defining entity soft-deletes. The entity is soft-deleted if it contains any of the listed attributes.

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

* attribute="string"

specifies the name of the attribute. This name must correspond to one of the columns from the input data tables.

* value="string"

specifies the value of the attribute.

maxDocumentCount=integer

specifies the maximum number of documents to which an entity can be connected before being soft-deleted.

Default MACINT
Minimum value 1
maxDocumentCountByType=list( list(docCountByType-1) <, list(docCountByType-2), ...>)

specifies a collection of document type and count pairs for defining entity soft-deletes. The entity will be soft-deleted if it violates any of the rules.

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

* documentType="string"

specifies the type of the document to be counted.

maxCount=integer

specifies the maximum number of documents of the type specified in the documentType parameter to which an entity can be connected before the entity is soft-deleted.

Default 1
Minimum value 1
temporalSplitting=TRUE | FALSE

when set to True, temporally splits entities of this type into subentities.

Default FALSE

specifies the rules that define the link soft-deletes.

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

specifies the type of document to consider for soft-deleting a link.

specifies the type of entity to consider for soft-deleting a link.

specifies a collection of attribute names and values for defining link soft-deletes. The link is soft-deleted if it contains any of the listed attributes.

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

specifies the name of the attribute. This name must correspond to one of the columns from the input data tables.

specifies the value of the attribute.

softDeleteOutputOption="ADJACENT" | "AUTOMATIC" | "NONE"

specifies how to output soft-deleted items.

Default AUTOMATIC
ADJACENT

includes in the output soft-deleted items that are connected to the generated networks.

AUTOMATIC

uses option ADJACENT if soft-deletes are specified or NONE if soft-deletes are not specified.

NONE

does not include any soft-deleted items in the output.

splitConflictingEntities=list( list(entitySplit-1) <, list(entitySplit-2), ...>)

specifies the conditions under which an entity should be split.

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

* conflictingCompoundValue=list(conflictingCompound)

specifies the rules under which an entity should be split on the basis of compound values.

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

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

specifies the types of compounds whose values must be consistent within an entity. If an entity contains different values for a compound type in this list, the entity will split into one or more entities such that each entity contains one value for each compound type in this list.

doNotSplit=list( list(docAndCmpdType-1) <, list(docAndCmpdType-2), ...>)

specifies the pairs consisting of a document type and a compound type that should not be split during entity splitting.

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

* compoundType="string"

specifies the compound type.

* documentType="string"

specifies the document type.

* entityType="string"

specifies the type of entity to which the entity splitting rule applies.

Last updated: November 23, 2025