Sequence Rule Mining Action Set: Syntax
Provides actions for sequence rule mining
pathing Action
Perform pathing analysis.
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.
|
Parameter |
Subparameter |
Description |
|---|---|---|
|
required parametertable |
— |
specifies the settings for an input table. |
|
Parameter |
Subparameter |
Description |
|---|---|---|
|
— |
specifies the in-memory table to store the pathing information such as the support, chain length, absolute length, and count for every sequence in the data set. The sequence is listed out in compact form in one column, as well as in expanded form, with a column for each sequence element and separator. | |
|
— |
when set to True, specifies that the action creates a second CAS table to save the map between every sequence index and the associated transactions. |
Parameter Descriptions
adjacent=TRUE | FALSE
when set to True, specifies that any adjacent items in a sequence must be adjacent in their transactions.
| Default | FALSE |
|---|
casOut={casouttable}
specifies the in-memory table to store the pathing information such as the support, chain length, absolute length, and count for every sequence in the data set. The sequence is listed out in compact form in one column, as well as in expanded form, with a column for each sequence element and separator.
For more information about specifying the casOut parameter, see the common casouttable parameter.
casOutSequTranMap={casouttable}
when set to True, specifies that the action creates a second CAS table to save the map between every sequence index and the associated transactions.
For more information about specifying the casOutSequTranMap parameter, see the common casouttable parameter.
durationRange={double-1 <, double-2, ...>}
specifies the minimum and maximum durations for a sequence.
encodeItem=TRUE | FALSE
when set to True, item sub-string separators ('-->', '==>', and '&') are replaced with XML-style encodings.
| Alias | encodeItems |
|---|---|
| Default | FALSE |
filterInnerOps={"AND", "OR"}
specifies a list of AND or OR logic operators. Each element controls the logic operation among the filter elements in an inner list of filters.
| Alias | filterInnerOp |
|---|
filterOuterOp="AND" | "OR"
specifies whether the outer operation is AND or OR.
| Default | AND |
|---|
filters={{list-1} <,{list-2}, ...>}
specifies a list of regular expression strings as constraints that sequences have to meet.
| Alias | filter |
|---|
freq="variable-name"
specifies the frequency variable used to compute the score of each sequence with the weight parameter. If you do not specify this parameter, the score of a sequence equates to the weight scaled by 1.
hashFunc="BERNSTEIN" | "CAS" | "ELF" | "FNV1A" | "JENKIN" | "MURMUR3" | "SDBM" | "SUPERFAST"
specifies the 32-bit hash function used to generate the hash value for a sequence string.
includeDuplicate=TRUE | FALSE
when set to True, specifies that duplicate items within a sequence are allowed.
| Aliases | includeDuplicates |
|---|---|
| includeDup | |
| inclDup | |
| Default | TRUE |
includeLeadingBlanks=TRUE | FALSE
when set to False, the leading blanks of each item value in the sequence string are trimmed. This parameter does not alter the values of the individual item columns in the output tables.
| Alias | keepLeadingBlanks |
|---|---|
| Default | TRUE |
includeMissItem=TRUE | FALSE
when set to True, specifies that the action includes records with missing values in the item variable in sequence analysis.
| Aliases | includeMissingItems |
|---|---|
| includeMissingItem | |
| inclMissItem | |
| inclMissingItems | |
| inclMissingItem | |
| Default | TRUE |
includeMissTime=TRUE | FALSE
when set to True, specifies that the action includes records with missing values in the time variable in sequence analysis.
| Aliases | includeMissingTimes |
|---|---|
| includeMissingTime | |
| inclMissTime | |
| inclMissingTimes | |
| inclMissingTime | |
| Default | TRUE |
includeMissTran=TRUE | FALSE
when set to True, specifies that the action includes records with missing values in the transaction variable in sequence analysis.
| Aliases | includeMissingTrans |
|---|---|
| includeMissingTran | |
| inclMissTran | |
| inclMissingTrans | |
| inclMissingTran | |
| Default | TRUE |
includeTrailingBlanks=TRUE | FALSE
when set to False, the trailing blanks of each item value in the sequence string are trimmed. This parameter does not alter the values of the individual item columns in the output tables.
| Alias | keepTrailingBlanks |
|---|---|
| Default | TRUE |
* item="variable-name"
specifies the column name with item values.
itemAgg="AVERAGE" | "MAXIMUM" | "MINIMUM" | "TOTAL"
specifies the aggregation function applied to the weight variables to create a score for the sequence. If weight is not specified, this value is ignored.
itemFmt="string"
specifies the format for the item variable.
| Alias | itemFormat |
|---|
itemRange={integer-1 <, integer-2, ...>}
specifies the minimum and maximum number of non-concurrent items allowed in a sequence.
maxDuration=double
specifies the maximum elapsed time between the time values for the first and last items in a sequence. If this elapsed time is greater than maxDuration, the sequence is excluded.
| Default | MACBIG |
|---|---|
| Range | 0–MACBIG |
maxItems=integer
specifies the maximum number of non-concurrent items allowed in a sequence.
| Default | MACINT |
|---|---|
| Range | 1–MACINT |
maxScore=double
specifies the maximum score a sequence must have. If weight is not specified, this value is ignored.
| Default | MACBIG |
|---|
maxSupport=double
specifies the maximum support value a sequence must have. Support is defined as the ratio between the number of appearances of a sequence and the number of transactions.
| Default | 1 |
|---|---|
| Range | 0–1 |
maxWindow=double
specifies the maximum elapsed time allowed between two adjacent items of a sequence. If this elapsed time is greater than maxWindow, the two items will not be in the same sequence.
| Default | MACBIG |
|---|---|
| Range | 0–MACBIG |
merge=TRUE | FALSE
when set to True, specifies that each transaction constructs a sequence for each subsequence within it.
| Default | TRUE |
|---|
minDuration=double
specifies the minimum elapsed time between the time values for the first and last items in a sequence. If this elapsed time is less than minDuration, the sequence is excluded.
| Default | 0 |
|---|---|
| Range | 0–MACBIG |
minItems=integer
specifies the minimum number of items allowed in a sequence.
| Default | 1 |
|---|---|
| Range | 1–MACINT |
minScore=double
specifies the minimum score a sequence must have. If weight is not specified, this value is ignored.
| Default | -MACBIG |
|---|
minSupport=double
specifies the minimum support value a sequence must have. Support is defined as the ratio between the number of appearances of a sequence and the number of transactions.
| Default | 0 |
|---|---|
| Range | 0–1 |
minWindow=double
specifies the minimum elapsed time allowed between two adjacent items of a sequence. If this elapsed time is less than minWindow, the two items will not be in the same sequence.
| Range | 0–MACBIG |
|---|
saveHash=TRUE | FALSE
when set to True, specifies that the action saves a hash value for the final sequence string according to the value of hashFunc into the results table or CAS table output.
| Alias | saveHashes |
|---|---|
| Default | FALSE |
saveItem=TRUE | FALSE
when set to True, specifies that the action saves items and separators of sequences in individual columns.
| Alias | saveItems |
|---|---|
| Default | TRUE |
saveSequTranMap=TRUE | FALSE
specifies that the action saves an additional sequenceID column in the first results or _sequenceID_ column in the CAS table. This column contains a compute environment invariant 0-based sequence index for every sequence value. Enabling this option also requests the action to produce a second results table, called "SequTranMap" or a second output CAS table controlled by casOutSequTranMap.
| Default | FALSE |
|---|
saveTran=TRUE | FALSE
when set to True, specifies that the action saves the list of hosting transactions where each sequence appears.
| Aliases | saveTransactions |
|---|---|
| saveTransaction | |
| Default | FALSE |
saveTranSeparator="string"
specifies the separator string for transactions per sequence. The default value is ', '.
| Default | ", " |
|---|
scoreRange={double-1 <, double-2, ...>}
specifies the minimum and maximum scores for a sequence. If weight is not specified, this value is ignored.
sequAgg="AVERAGE" | "MAXIMUM" | "MINIMUM" | "TOTAL"
specifies the aggregation function applied to a sequence at each occurrence in the data set to create a final score for the sequence. If weight is not specified, this value is ignored.
supportRange={double-1 <, double-2, ...>}
specifies the minimum and maximum support values for a sequence. Support is defined as the ratio between the number of appearances of a sequence and the number of transactions.
* table={castable}
specifies the settings for an input table.
| Long form | table={name="table-name"} |
|---|---|
| Shortcut form | table="table-name" |
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.
* name="table-name"
specifies the name of the input table.
singlePass=TRUE | FALSE
when set to True, does not create a transient table on the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.
| Default | FALSE |
|---|
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.
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.
* 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.
* time="variable-name"
specifies the column name with time values.
timeAgg="AVERAGE" | "MAXIMUM" | "MINIMUM"
specifies the aggregation function that, when paired with the window parameter, is used to update the anchor time.
* tran="variable-name"
specifies the column name with transaction values.
| Alias | transaction |
|---|
tranFmt="string"
specifies the format for the transaction variable.
| Alias | tranFormat |
|---|
weight="variable-name"
specifies the numeric weight variable used to compute the score of each sequence with the freq parameter. If you do not specify this parameter, aggregate, freq, and itemAgg options are ignored.
windowRange={double-1 <, double-2, ...>}
specifies the minimum and maximum windows for a sequence.
pathing Action
Perform pathing analysis.
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.
|
Parameter |
Subparameter |
Description |
|---|---|---|
|
required parametertable |
— |
specifies the settings for an input table. |
|
Parameter |
Subparameter |
Description |
|---|---|---|
|
— |
specifies the in-memory table to store the pathing information such as the support, chain length, absolute length, and count for every sequence in the data set. The sequence is listed out in compact form in one column, as well as in expanded form, with a column for each sequence element and separator. | |
|
— |
when set to True, specifies that the action creates a second CAS table to save the map between every sequence index and the associated transactions. |
Parameter Descriptions
adjacent=true | false
when set to True, specifies that any adjacent items in a sequence must be adjacent in their transactions.
| Default | false |
|---|
casOut={casouttable}
specifies the in-memory table to store the pathing information such as the support, chain length, absolute length, and count for every sequence in the data set. The sequence is listed out in compact form in one column, as well as in expanded form, with a column for each sequence element and separator.
For more information about specifying the casOut parameter, see the common casouttable parameter.
casOutSequTranMap={casouttable}
when set to True, specifies that the action creates a second CAS table to save the map between every sequence index and the associated transactions.
For more information about specifying the casOutSequTranMap parameter, see the common casouttable parameter.
durationRange={double-1 <, double-2, ...>}
specifies the minimum and maximum durations for a sequence.
encodeItem=true | false
when set to True, item sub-string separators ('-->', '==>', and '&') are replaced with XML-style encodings.
| Alias | encodeItems |
|---|---|
| Default | false |
filterInnerOps={"AND", "OR"}
specifies a list of AND or OR logic operators. Each element controls the logic operation among the filter elements in an inner list of filters.
| Alias | filterInnerOp |
|---|
filterOuterOp="AND" | "OR"
specifies whether the outer operation is AND or OR.
| Default | AND |
|---|
filters={{list-1} <,{list-2}, ...>}
specifies a list of regular expression strings as constraints that sequences have to meet.
| Alias | filter |
|---|
freq="variable-name"
specifies the frequency variable used to compute the score of each sequence with the weight parameter. If you do not specify this parameter, the score of a sequence equates to the weight scaled by 1.
hashFunc="BERNSTEIN" | "CAS" | "ELF" | "FNV1A" | "JENKIN" | "MURMUR3" | "SDBM" | "SUPERFAST"
specifies the 32-bit hash function used to generate the hash value for a sequence string.
includeDuplicate=true | false
when set to True, specifies that duplicate items within a sequence are allowed.
| Aliases | includeDuplicates |
|---|---|
| includeDup | |
| inclDup | |
| Default | true |
includeLeadingBlanks=true | false
when set to False, the leading blanks of each item value in the sequence string are trimmed. This parameter does not alter the values of the individual item columns in the output tables.
| Alias | keepLeadingBlanks |
|---|---|
| Default | true |
includeMissItem=true | false
when set to True, specifies that the action includes records with missing values in the item variable in sequence analysis.
| Aliases | includeMissingItems |
|---|---|
| includeMissingItem | |
| inclMissItem | |
| inclMissingItems | |
| inclMissingItem | |
| Default | true |
includeMissTime=true | false
when set to True, specifies that the action includes records with missing values in the time variable in sequence analysis.
| Aliases | includeMissingTimes |
|---|---|
| includeMissingTime | |
| inclMissTime | |
| inclMissingTimes | |
| inclMissingTime | |
| Default | true |
includeMissTran=true | false
when set to True, specifies that the action includes records with missing values in the transaction variable in sequence analysis.
| Aliases | includeMissingTrans |
|---|---|
| includeMissingTran | |
| inclMissTran | |
| inclMissingTrans | |
| inclMissingTran | |
| Default | true |
includeTrailingBlanks=true | false
when set to False, the trailing blanks of each item value in the sequence string are trimmed. This parameter does not alter the values of the individual item columns in the output tables.
| Alias | keepTrailingBlanks |
|---|---|
| Default | true |
* item="variable-name"
specifies the column name with item values.
itemAgg="AVERAGE" | "MAXIMUM" | "MINIMUM" | "TOTAL"
specifies the aggregation function applied to the weight variables to create a score for the sequence. If weight is not specified, this value is ignored.
itemFmt="string"
specifies the format for the item variable.
| Alias | itemFormat |
|---|
itemRange={integer-1 <, integer-2, ...>}
specifies the minimum and maximum number of non-concurrent items allowed in a sequence.
maxDuration=double
specifies the maximum elapsed time between the time values for the first and last items in a sequence. If this elapsed time is greater than maxDuration, the sequence is excluded.
| Default | MACBIG |
|---|---|
| Range | 0–MACBIG |
maxItems=integer
specifies the maximum number of non-concurrent items allowed in a sequence.
| Default | MACINT |
|---|---|
| Range | 1–MACINT |
maxScore=double
specifies the maximum score a sequence must have. If weight is not specified, this value is ignored.
| Default | MACBIG |
|---|
maxSupport=double
specifies the maximum support value a sequence must have. Support is defined as the ratio between the number of appearances of a sequence and the number of transactions.
| Default | 1 |
|---|---|
| Range | 0–1 |
maxWindow=double
specifies the maximum elapsed time allowed between two adjacent items of a sequence. If this elapsed time is greater than maxWindow, the two items will not be in the same sequence.
| Default | MACBIG |
|---|---|
| Range | 0–MACBIG |
merge=true | false
when set to True, specifies that each transaction constructs a sequence for each subsequence within it.
| Default | true |
|---|
minDuration=double
specifies the minimum elapsed time between the time values for the first and last items in a sequence. If this elapsed time is less than minDuration, the sequence is excluded.
| Default | 0 |
|---|---|
| Range | 0–MACBIG |
minItems=integer
specifies the minimum number of items allowed in a sequence.
| Default | 1 |
|---|---|
| Range | 1–MACINT |
minScore=double
specifies the minimum score a sequence must have. If weight is not specified, this value is ignored.
| Default | -MACBIG |
|---|
minSupport=double
specifies the minimum support value a sequence must have. Support is defined as the ratio between the number of appearances of a sequence and the number of transactions.
| Default | 0 |
|---|---|
| Range | 0–1 |
minWindow=double
specifies the minimum elapsed time allowed between two adjacent items of a sequence. If this elapsed time is less than minWindow, the two items will not be in the same sequence.
| Range | 0–MACBIG |
|---|
saveHash=true | false
when set to True, specifies that the action saves a hash value for the final sequence string according to the value of hashFunc into the results table or CAS table output.
| Alias | saveHashes |
|---|---|
| Default | false |
saveItem=true | false
when set to True, specifies that the action saves items and separators of sequences in individual columns.
| Alias | saveItems |
|---|---|
| Default | true |
saveSequTranMap=true | false
specifies that the action saves an additional sequenceID column in the first results or _sequenceID_ column in the CAS table. This column contains a compute environment invariant 0-based sequence index for every sequence value. Enabling this option also requests the action to produce a second results table, called "SequTranMap" or a second output CAS table controlled by casOutSequTranMap.
| Default | false |
|---|
saveTran=true | false
when set to True, specifies that the action saves the list of hosting transactions where each sequence appears.
| Aliases | saveTransactions |
|---|---|
| saveTransaction | |
| Default | false |
saveTranSeparator="string"
specifies the separator string for transactions per sequence. The default value is ', '.
| Default | ", " |
|---|
scoreRange={double-1 <, double-2, ...>}
specifies the minimum and maximum scores for a sequence. If weight is not specified, this value is ignored.
sequAgg="AVERAGE" | "MAXIMUM" | "MINIMUM" | "TOTAL"
specifies the aggregation function applied to a sequence at each occurrence in the data set to create a final score for the sequence. If weight is not specified, this value is ignored.
supportRange={double-1 <, double-2, ...>}
specifies the minimum and maximum support values for a sequence. Support is defined as the ratio between the number of appearances of a sequence and the number of transactions.
* table={castable}
specifies the settings for an input table.
| Long form | table={name="table-name"} |
|---|---|
| Shortcut form | table="table-name" |
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.
* name="table-name"
specifies the name of the input table.
singlePass=true | false
when set to True, does not create a transient table on the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.
| Default | false |
|---|
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.
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.
* 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.
* time="variable-name"
specifies the column name with time values.
timeAgg="AVERAGE" | "MAXIMUM" | "MINIMUM"
specifies the aggregation function that, when paired with the window parameter, is used to update the anchor time.
* tran="variable-name"
specifies the column name with transaction values.
| Alias | transaction |
|---|
tranFmt="string"
specifies the format for the transaction variable.
| Alias | tranFormat |
|---|
weight="variable-name"
specifies the numeric weight variable used to compute the score of each sequence with the freq parameter. If you do not specify this parameter, aggregate, freq, and itemAgg options are ignored.
windowRange={double-1 <, double-2, ...>}
specifies the minimum and maximum windows for a sequence.
pathing Action
Perform pathing analysis.
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.
|
Parameter |
Subparameter |
Description |
|---|---|---|
|
required parametertable |
— |
specifies the settings for an input table. |
|
Parameter |
Subparameter |
Description |
|---|---|---|
|
— |
specifies the in-memory table to store the pathing information such as the support, chain length, absolute length, and count for every sequence in the data set. The sequence is listed out in compact form in one column, as well as in expanded form, with a column for each sequence element and separator. | |
|
— |
when set to True, specifies that the action creates a second CAS table to save the map between every sequence index and the associated transactions. |
Parameter Descriptions
adjacent=True | False
when set to True, specifies that any adjacent items in a sequence must be adjacent in their transactions.
| Default | False |
|---|
casOut={casouttable}
specifies the in-memory table to store the pathing information such as the support, chain length, absolute length, and count for every sequence in the data set. The sequence is listed out in compact form in one column, as well as in expanded form, with a column for each sequence element and separator.
For more information about specifying the casOut parameter, see the common casouttable parameter.
casOutSequTranMap={casouttable}
when set to True, specifies that the action creates a second CAS table to save the map between every sequence index and the associated transactions.
For more information about specifying the casOutSequTranMap parameter, see the common casouttable parameter.
durationRange=[double-1 <, double-2, ...>]
specifies the minimum and maximum durations for a sequence.
encodeItem=True | False
when set to True, item sub-string separators ('-->', '==>', and '&') are replaced with XML-style encodings.
| Alias | encodeItems |
|---|---|
| Default | False |
filterInnerOps=["AND", "OR"]
specifies a list of AND or OR logic operators. Each element controls the logic operation among the filter elements in an inner list of filters.
| Alias | filterInnerOp |
|---|
filterOuterOp="AND" | "OR"
specifies whether the outer operation is AND or OR.
| Default | AND |
|---|
filters=[[list-1] <,[list-2], ...>]
specifies a list of regular expression strings as constraints that sequences have to meet.
| Alias | filter |
|---|
freq="variable-name"
specifies the frequency variable used to compute the score of each sequence with the weight parameter. If you do not specify this parameter, the score of a sequence equates to the weight scaled by 1.
hashFunc="BERNSTEIN" | "CAS" | "ELF" | "FNV1A" | "JENKIN" | "MURMUR3" | "SDBM" | "SUPERFAST"
specifies the 32-bit hash function used to generate the hash value for a sequence string.
includeDuplicate=True | False
when set to True, specifies that duplicate items within a sequence are allowed.
| Aliases | includeDuplicates |
|---|---|
| includeDup | |
| inclDup | |
| Default | True |
includeLeadingBlanks=True | False
when set to False, the leading blanks of each item value in the sequence string are trimmed. This parameter does not alter the values of the individual item columns in the output tables.
| Alias | keepLeadingBlanks |
|---|---|
| Default | True |
includeMissItem=True | False
when set to True, specifies that the action includes records with missing values in the item variable in sequence analysis.
| Aliases | includeMissingItems |
|---|---|
| includeMissingItem | |
| inclMissItem | |
| inclMissingItems | |
| inclMissingItem | |
| Default | True |
includeMissTime=True | False
when set to True, specifies that the action includes records with missing values in the time variable in sequence analysis.
| Aliases | includeMissingTimes |
|---|---|
| includeMissingTime | |
| inclMissTime | |
| inclMissingTimes | |
| inclMissingTime | |
| Default | True |
includeMissTran=True | False
when set to True, specifies that the action includes records with missing values in the transaction variable in sequence analysis.
| Aliases | includeMissingTrans |
|---|---|
| includeMissingTran | |
| inclMissTran | |
| inclMissingTrans | |
| inclMissingTran | |
| Default | True |
includeTrailingBlanks=True | False
when set to False, the trailing blanks of each item value in the sequence string are trimmed. This parameter does not alter the values of the individual item columns in the output tables.
| Alias | keepTrailingBlanks |
|---|---|
| Default | True |
* item="variable-name"
specifies the column name with item values.
itemAgg="AVERAGE" | "MAXIMUM" | "MINIMUM" | "TOTAL"
specifies the aggregation function applied to the weight variables to create a score for the sequence. If weight is not specified, this value is ignored.
itemFmt="string"
specifies the format for the item variable.
| Alias | itemFormat |
|---|
itemRange=[integer-1 <, integer-2, ...>]
specifies the minimum and maximum number of non-concurrent items allowed in a sequence.
maxDuration=double
specifies the maximum elapsed time between the time values for the first and last items in a sequence. If this elapsed time is greater than maxDuration, the sequence is excluded.
| Default | MACBIG |
|---|---|
| Range | 0–MACBIG |
maxItems=integer
specifies the maximum number of non-concurrent items allowed in a sequence.
| Default | MACINT |
|---|---|
| Range | 1–MACINT |
maxScore=double
specifies the maximum score a sequence must have. If weight is not specified, this value is ignored.
| Default | MACBIG |
|---|
maxSupport=double
specifies the maximum support value a sequence must have. Support is defined as the ratio between the number of appearances of a sequence and the number of transactions.
| Default | 1 |
|---|---|
| Range | 0–1 |
maxWindow=double
specifies the maximum elapsed time allowed between two adjacent items of a sequence. If this elapsed time is greater than maxWindow, the two items will not be in the same sequence.
| Default | MACBIG |
|---|---|
| Range | 0–MACBIG |
merge=True | False
when set to True, specifies that each transaction constructs a sequence for each subsequence within it.
| Default | True |
|---|
minDuration=double
specifies the minimum elapsed time between the time values for the first and last items in a sequence. If this elapsed time is less than minDuration, the sequence is excluded.
| Default | 0 |
|---|---|
| Range | 0–MACBIG |
minItems=integer
specifies the minimum number of items allowed in a sequence.
| Default | 1 |
|---|---|
| Range | 1–MACINT |
minScore=double
specifies the minimum score a sequence must have. If weight is not specified, this value is ignored.
| Default | -MACBIG |
|---|
minSupport=double
specifies the minimum support value a sequence must have. Support is defined as the ratio between the number of appearances of a sequence and the number of transactions.
| Default | 0 |
|---|---|
| Range | 0–1 |
minWindow=double
specifies the minimum elapsed time allowed between two adjacent items of a sequence. If this elapsed time is less than minWindow, the two items will not be in the same sequence.
| Range | 0–MACBIG |
|---|
saveHash=True | False
when set to True, specifies that the action saves a hash value for the final sequence string according to the value of hashFunc into the results table or CAS table output.
| Alias | saveHashes |
|---|---|
| Default | False |
saveItem=True | False
when set to True, specifies that the action saves items and separators of sequences in individual columns.
| Alias | saveItems |
|---|---|
| Default | True |
saveSequTranMap=True | False
specifies that the action saves an additional sequenceID column in the first results or _sequenceID_ column in the CAS table. This column contains a compute environment invariant 0-based sequence index for every sequence value. Enabling this option also requests the action to produce a second results table, called "SequTranMap" or a second output CAS table controlled by casOutSequTranMap.
| Default | False |
|---|
saveTran=True | False
when set to True, specifies that the action saves the list of hosting transactions where each sequence appears.
| Aliases | saveTransactions |
|---|---|
| saveTransaction | |
| Default | False |
saveTranSeparator="string"
specifies the separator string for transactions per sequence. The default value is ', '.
| Default | ", " |
|---|
scoreRange=[double-1 <, double-2, ...>]
specifies the minimum and maximum scores for a sequence. If weight is not specified, this value is ignored.
sequAgg="AVERAGE" | "MAXIMUM" | "MINIMUM" | "TOTAL"
specifies the aggregation function applied to a sequence at each occurrence in the data set to create a final score for the sequence. If weight is not specified, this value is ignored.
supportRange=[double-1 <, double-2, ...>]
specifies the minimum and maximum support values for a sequence. Support is defined as the ratio between the number of appearances of a sequence and the number of transactions.
* table={castable}
specifies the settings for an input table.
| Long form | table={"name":"table-name"} |
|---|---|
| Shortcut form | table="table-name" |
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.
* "name":"table-name"
specifies the name of the input table.
"singlePass":True | False
when set to True, does not create a transient table on the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.
| Default | False |
|---|
"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.
"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.
* "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.
* time="variable-name"
specifies the column name with time values.
timeAgg="AVERAGE" | "MAXIMUM" | "MINIMUM"
specifies the aggregation function that, when paired with the window parameter, is used to update the anchor time.
* tran="variable-name"
specifies the column name with transaction values.
| Alias | transaction |
|---|
tranFmt="string"
specifies the format for the transaction variable.
| Alias | tranFormat |
|---|
weight="variable-name"
specifies the numeric weight variable used to compute the score of each sequence with the freq parameter. If you do not specify this parameter, aggregate, freq, and itemAgg options are ignored.
windowRange=[double-1 <, double-2, ...>]
specifies the minimum and maximum windows for a sequence.
pathing Action
Perform pathing analysis.
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.
|
Parameter |
Subparameter |
Description |
|---|---|---|
|
required parametertable |
— |
specifies the settings for an input table. |
|
Parameter |
Subparameter |
Description |
|---|---|---|
|
— |
specifies the in-memory table to store the pathing information such as the support, chain length, absolute length, and count for every sequence in the data set. The sequence is listed out in compact form in one column, as well as in expanded form, with a column for each sequence element and separator. | |
|
— |
when set to True, specifies that the action creates a second CAS table to save the map between every sequence index and the associated transactions. |
Parameter Descriptions
adjacent=TRUE | FALSE
when set to True, specifies that any adjacent items in a sequence must be adjacent in their transactions.
| Default | FALSE |
|---|
casOut=list(casouttable)
specifies the in-memory table to store the pathing information such as the support, chain length, absolute length, and count for every sequence in the data set. The sequence is listed out in compact form in one column, as well as in expanded form, with a column for each sequence element and separator.
For more information about specifying the casOut parameter, see the common casouttable parameter.
casOutSequTranMap=list(casouttable)
when set to True, specifies that the action creates a second CAS table to save the map between every sequence index and the associated transactions.
For more information about specifying the casOutSequTranMap parameter, see the common casouttable parameter.
durationRange=list(double-1 <, double-2, ...>)
specifies the minimum and maximum durations for a sequence.
encodeItem=TRUE | FALSE
when set to True, item sub-string separators ('-->', '==>', and '&') are replaced with XML-style encodings.
| Alias | encodeItems |
|---|---|
| Default | FALSE |
filterInnerOps=list("AND", "OR")
specifies a list of AND or OR logic operators. Each element controls the logic operation among the filter elements in an inner list of filters.
| Alias | filterInnerOp |
|---|
filterOuterOp="AND" | "OR"
specifies whether the outer operation is AND or OR.
| Default | AND |
|---|
filters=list( list(list-1) <, list(list-2), ...>)
specifies a list of regular expression strings as constraints that sequences have to meet.
| Alias | filter |
|---|
freq="variable-name"
specifies the frequency variable used to compute the score of each sequence with the weight parameter. If you do not specify this parameter, the score of a sequence equates to the weight scaled by 1.
hashFunc="BERNSTEIN" | "CAS" | "ELF" | "FNV1A" | "JENKIN" | "MURMUR3" | "SDBM" | "SUPERFAST"
specifies the 32-bit hash function used to generate the hash value for a sequence string.
includeDuplicate=TRUE | FALSE
when set to True, specifies that duplicate items within a sequence are allowed.
| Aliases | includeDuplicates |
|---|---|
| includeDup | |
| inclDup | |
| Default | TRUE |
includeLeadingBlanks=TRUE | FALSE
when set to False, the leading blanks of each item value in the sequence string are trimmed. This parameter does not alter the values of the individual item columns in the output tables.
| Alias | keepLeadingBlanks |
|---|---|
| Default | TRUE |
includeMissItem=TRUE | FALSE
when set to True, specifies that the action includes records with missing values in the item variable in sequence analysis.
| Aliases | includeMissingItems |
|---|---|
| includeMissingItem | |
| inclMissItem | |
| inclMissingItems | |
| inclMissingItem | |
| Default | TRUE |
includeMissTime=TRUE | FALSE
when set to True, specifies that the action includes records with missing values in the time variable in sequence analysis.
| Aliases | includeMissingTimes |
|---|---|
| includeMissingTime | |
| inclMissTime | |
| inclMissingTimes | |
| inclMissingTime | |
| Default | TRUE |
includeMissTran=TRUE | FALSE
when set to True, specifies that the action includes records with missing values in the transaction variable in sequence analysis.
| Aliases | includeMissingTrans |
|---|---|
| includeMissingTran | |
| inclMissTran | |
| inclMissingTrans | |
| inclMissingTran | |
| Default | TRUE |
includeTrailingBlanks=TRUE | FALSE
when set to False, the trailing blanks of each item value in the sequence string are trimmed. This parameter does not alter the values of the individual item columns in the output tables.
| Alias | keepTrailingBlanks |
|---|---|
| Default | TRUE |
* item="variable-name"
specifies the column name with item values.
itemAgg="AVERAGE" | "MAXIMUM" | "MINIMUM" | "TOTAL"
specifies the aggregation function applied to the weight variables to create a score for the sequence. If weight is not specified, this value is ignored.
itemFmt="string"
specifies the format for the item variable.
| Alias | itemFormat |
|---|
itemRange=list(integer-1 <, integer-2, ...>)
specifies the minimum and maximum number of non-concurrent items allowed in a sequence.
maxDuration=double
specifies the maximum elapsed time between the time values for the first and last items in a sequence. If this elapsed time is greater than maxDuration, the sequence is excluded.
| Default | MACBIG |
|---|---|
| Range | 0–MACBIG |
maxItems=integer
specifies the maximum number of non-concurrent items allowed in a sequence.
| Default | MACINT |
|---|---|
| Range | 1–MACINT |
maxScore=double
specifies the maximum score a sequence must have. If weight is not specified, this value is ignored.
| Default | MACBIG |
|---|
maxSupport=double
specifies the maximum support value a sequence must have. Support is defined as the ratio between the number of appearances of a sequence and the number of transactions.
| Default | 1 |
|---|---|
| Range | 0–1 |
maxWindow=double
specifies the maximum elapsed time allowed between two adjacent items of a sequence. If this elapsed time is greater than maxWindow, the two items will not be in the same sequence.
| Default | MACBIG |
|---|---|
| Range | 0–MACBIG |
merge=TRUE | FALSE
when set to True, specifies that each transaction constructs a sequence for each subsequence within it.
| Default | TRUE |
|---|
minDuration=double
specifies the minimum elapsed time between the time values for the first and last items in a sequence. If this elapsed time is less than minDuration, the sequence is excluded.
| Default | 0 |
|---|---|
| Range | 0–MACBIG |
minItems=integer
specifies the minimum number of items allowed in a sequence.
| Default | 1 |
|---|---|
| Range | 1–MACINT |
minScore=double
specifies the minimum score a sequence must have. If weight is not specified, this value is ignored.
| Default | -MACBIG |
|---|
minSupport=double
specifies the minimum support value a sequence must have. Support is defined as the ratio between the number of appearances of a sequence and the number of transactions.
| Default | 0 |
|---|---|
| Range | 0–1 |
minWindow=double
specifies the minimum elapsed time allowed between two adjacent items of a sequence. If this elapsed time is less than minWindow, the two items will not be in the same sequence.
| Range | 0–MACBIG |
|---|
saveHash=TRUE | FALSE
when set to True, specifies that the action saves a hash value for the final sequence string according to the value of hashFunc into the results table or CAS table output.
| Alias | saveHashes |
|---|---|
| Default | FALSE |
saveItem=TRUE | FALSE
when set to True, specifies that the action saves items and separators of sequences in individual columns.
| Alias | saveItems |
|---|---|
| Default | TRUE |
saveSequTranMap=TRUE | FALSE
specifies that the action saves an additional sequenceID column in the first results or _sequenceID_ column in the CAS table. This column contains a compute environment invariant 0-based sequence index for every sequence value. Enabling this option also requests the action to produce a second results table, called "SequTranMap" or a second output CAS table controlled by casOutSequTranMap.
| Default | FALSE |
|---|
saveTran=TRUE | FALSE
when set to True, specifies that the action saves the list of hosting transactions where each sequence appears.
| Aliases | saveTransactions |
|---|---|
| saveTransaction | |
| Default | FALSE |
saveTranSeparator="string"
specifies the separator string for transactions per sequence. The default value is ', '.
| Default | ", " |
|---|
scoreRange=list(double-1 <, double-2, ...>)
specifies the minimum and maximum scores for a sequence. If weight is not specified, this value is ignored.
sequAgg="AVERAGE" | "MAXIMUM" | "MINIMUM" | "TOTAL"
specifies the aggregation function applied to a sequence at each occurrence in the data set to create a final score for the sequence. If weight is not specified, this value is ignored.
supportRange=list(double-1 <, double-2, ...>)
specifies the minimum and maximum support values for a sequence. Support is defined as the ratio between the number of appearances of a sequence and the number of transactions.
* table=list(castable)
specifies the settings for an input table.
| Long form | table=list(name="table-name") |
|---|---|
| Shortcut form | table="table-name" |
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.
* name="table-name"
specifies the name of the input table.
singlePass=TRUE | FALSE
when set to True, does not create a transient table on the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.
| Default | FALSE |
|---|
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.
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.
* 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.
* time="variable-name"
specifies the column name with time values.
timeAgg="AVERAGE" | "MAXIMUM" | "MINIMUM"
specifies the aggregation function that, when paired with the window parameter, is used to update the anchor time.
* tran="variable-name"
specifies the column name with transaction values.
| Alias | transaction |
|---|
tranFmt="string"
specifies the format for the transaction variable.
| Alias | tranFormat |
|---|
weight="variable-name"
specifies the numeric weight variable used to compute the score of each sequence with the freq parameter. If you do not specify this parameter, aggregate, freq, and itemAgg options are ignored.
windowRange=list(double-1 <, double-2, ...>)
specifies the minimum and maximum windows for a sequence.