Extends

• ArchBaseAction

Members

static, readonly displayTypeName :string

Returns the display type name string 'ArchActionShowKnowledgeArticle'.

readonly displayTypeName :string

Returns the display type name string 'ArchBaseAction'.

Overrides:

• ArchBaseAction#displayTypeName

readonly displayTypeNameArchitect :string

The Architect action type label

Inherited From:

• ArchBaseAction#displayTypeNameArchitect

readonly isArchActionShowKnowledgeArticle :boolean

Returns true indicating that this is an ArchActionShowKnowledgeArticle instance.

readonly isArchBaseAction :boolean

A property that can be checked to verify the scripting object is a type of ArchBaseAction

Inherited From:

• ArchBaseAction#isArchBaseAction

readonly isMenuChoiceAction :boolean

Returns whether or not this action is the action property for a menu choice. For example, the ArchMenuDisconnect#actionDisconnect property on an ArchMenuDisconnect instance.

Inherited From:

• ArchBaseAction#isMenuChoiceAction

readonly isReachable :boolean

Returns whether or not this action is reachable at runtime.

Inherited From:

• ArchBaseAction#isReachable

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:

• ArchBaseAction#isSecure

readonly isUnreachable :boolean

Returns whether or not this action is unreachable at runtime.

Inherited From:

• ArchBaseAction#isUnreachable

readonly knowledgeArticle :ArchValueKnowledgeBaseDocument

The knowledge article is the knowledge base document in the knowledge base configured on the flow that should be displayed to the external participant at flow runtime.

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:

• ArchBaseAction#logStr

name :string

The name of the action

Inherited From:

• ArchBaseAction#name

readonly parentFlow :ArchBaseFlow

Returns the parent flow for this action.

Inherited From:

• ArchBaseAction#parentFlow

readonly parentMenuChoice :ArchBaseMenuChoice

Returns the parent menu choice if this action is the action for a menu choice. Otherwise, nothing is returned.

Inherited From:

• ArchBaseAction#parentMenuChoice

readonly parentState :ArchState

Returns the parent state that contains this action if this action is in a state. Otherwise, nothing is returned.

Inherited From:

• ArchBaseAction#parentState

readonly parentTask :ArchTask|ArchTaskLoop

Returns the parent task that contains this action if this action is in a task or looping task. Otherwise, nothing is returned.

Inherited From:

• ArchBaseAction#parentTask

readonly trackingId :number

The integer tracking identifier for this action. This is the numeric identifier is displayed in the Architect user interface.

Inherited From:

• ArchBaseAction#trackingId

Methods

setLiteralByKnowledgeBaseDocumentIdAsync(knowledgeBaseDocumentId, callbackFunctionopt) → {Promise.<ArchActionShowKnowledgeArticle>}

This helper method sets the knowledgeArticle to by accessing the ArchActionShowKnowledgeArticle#knowledgeArticle property and then calls the ArchActionShowKnowledgeArticle#setLiteralByKnowledgeBaseDocumentIdAsync method passing the submitted knowledgeArticle identifier through to that method. This method requires that a knowledge base is configured on the flow when called and will fail if the knowledge base has not been set.

Parameters:

Name	Type	Attributes	Description
knowledgeBaseDocumentId	string		the id of the Knowledge Base document to set.
callbackFunction	callbackArchActionShowKnowledgeArticle	<optional>	a callback function to call if the knowledgeArticle is successfully looked up and configured on this action. The first parameter passed to the callback function will be this show knowledge article action instance.

Returns:

Promise.<ArchActionShowKnowledgeArticle>

setLiteralByKnowledgeBaseDocumentNameAsync(knowledgeArticleName, callbackFunctionopt) → {Promise.<ArchActionShowKnowledgeArticle>}

This helper method sets the knowledgeArticle by accessing the ArchActionShowKnowledgeArticle#knowledgeArticle property and then calls the ArchActionShowKnowledgeArticle#setLiteralByKnowledgeBaseDocumentNameAsync method passing the submitted knowledgeArticle name through that method. This method requires that a knowledge base is configured on the flow when called and will fail if the knowledge base has not been set.

Parameters:

Name	Type	Attributes	Description
knowledgeArticleName	string		the name of the knowledge base document to set. This search is performed in a case insensitive manner.
callbackFunction	callbackArchActionShowKnowledgeArticle	<optional>	a callback function to call if the knowledge base document is successfully looked up and configured on this action. The first parameter passed to the callback function will be this show knowledge article action instance.

Returns:

Promise.<ArchActionShowKnowledgeArticle>