new ArchActionExtractSecureData(coreExtractSecureDataActionViewModel)
The Architect Scripting class for the Extract Secure Data action.
Instances of this action should be created by calling ArchFactoryActions#addActionExtractSecureData
Parameters:
| Name | Type | Description |
|---|---|---|
coreExtractSecureDataActionViewModel |
Object | ( Internal ) an Architect core extract secure data action view model. |
Extends
Members
-
static, readonly displayTypeName :string
-
Returns the display type name string 'ArchActionExtractSecureData'.
-
static, readonly isArchActionExtractSecureData :boolean
-
Returns true indicating that this is an ArchActionExtractSecureData instance.
-
readonly displayTypeName :string
-
Returns the display type name string 'ArchBaseAction'.
- Overrides:
-
readonly displayTypeNameArchitect :string
-
The Architect action type label
- Inherited From:
-
readonly hasSecureDataAcknowledgment :boolean
-
Returns whether or not the secure data extraction warning has been acknowledged for this action.
-
readonly isArchBaseAction :boolean
-
A property that can be checked to verify the scripting object is a type of ArchBaseAction
- Inherited From:
-
readonly isMenuChoiceAction :boolean
-
Returns whether or not this action is the action property for a
menu choice. For example, theArchMenuDisconnect#actionDisconnectproperty on anArchMenuDisconnectinstance.- Inherited From:
-
readonly isReachable :boolean
-
Returns whether or not this action is reachable at runtime.
- Inherited From:
-
readonly isSecure :boolean
-
Returns whether or not this action is secure which means either the action by its very nature is secure or it consumes secure data.
- Inherited From:
-
readonly isUnreachable :boolean
-
Returns whether or not this action is unreachable at runtime.
- Inherited From:
-
readonly logStr :string
-
A string suitable for logging that contains information about this action. This will contain the action tracking id, name and scripting type name.
- Inherited From:
-
name :string
-
The name of the action
- Inherited From:
-
readonly parentFlow :ArchBaseFlow
-
Returns the parent flow for this action.
- Inherited From:
-
readonly parentMenuChoice :ArchBaseMenuChoice
-
Returns the parent menu choice if this action is the action for a
menu choice. Otherwise, nothing is returned.- Inherited From:
-
readonly parentState :ArchState
-
Returns the parent state that contains this action if this action is in a
state. Otherwise, nothing is returned.- Inherited From:
-
readonly parentTask :ArchTask|ArchTaskLoop
-
Returns the parent task that contains this action if this action is in a
taskorlooping task. Otherwise, nothing is returned.- Inherited From:
-
readonly statements :Array.<ArchBaseVariableValuePair>
-
Returns an array of update statements currently configured on this extract secure data action. If there are no update statements configured, an empty array will be returned.
-
readonly trackingId :number
-
The integer tracking identifier for this action. This is the numeric identifier is displayed in the Architect user interface.
- Inherited From:
Methods
-
acknowledgeSecureUsage()
-
Call this function to acknowledge the insecuring of secure data with the logged in user and current date. This must be called for the extract secure data action to be valid. If not acknowledged, the action will be in error.
-
addExtractSecureDataStatement(archDataType, variableToAssign, valueExpressionToAssignopt) → {ArchBaseVariableValuePair}
-
This adds an extract secure data statement to an extract secure data action.
Parameters:
Name Type Attributes Description archDataTypeArchDataType the data type for this extract secure data statement. The data type must be script creatable.
variableToAssignstring | ArchBaseVariable the variable to which the value should be assigned.
valueExpressionToAssignstring <optional>
the expression text for the value to assign in the extract secure data statement.
Returns:
ArchBaseVariableValuePair