Remove Secure Credential activity

An activity that deletes the runtime settings of an access token for an external system for a process instance made with the Set Secure Credential activity.


Remove Secure Credential activity

Configure the Remove Secure Credential activity

To configure the Remove Secure Credential activity, do the procedure in this topic.

Prerequisites

  • To use this activity, you must have activities in this order:

    Set Secure Credential activity > one or more activities for an external system, such as Database > Remove Secure Credential activity (optional)

Good to Know

  • ​​To send an email notification, click Advanced Advanced icon > Email Notifications E-mail Notifications icon.

    For more information, refer to Email Notifications screen (Process Activities).

  • If you have more than one activity following a Set Secure Credentials activity that uses the same type of data source defined in the Set Secure Credentials activity, all of the access tokens for those activities will be overridden, even if they use different access tokens.

    For example, in this process design, both the access tokens for two different databases, DB1 and DB2, would be overridden by the Set Secure Credentials activity:

    Set Secure Credentials > Update Record (DB1) > Delete Record (DB2)

    To avoid this problem, add a Remove Secure Credentials activity:

    Set Secure Credentials > Update Record (DB1) > Remove Secure Credentials > Delete Record (DB2)

  • This section shows the configuration settings on the configuration screens for this activity. Other configuration settings apply to system activities. For more information, refer to:
  • You can configure whether this activity waits for other activities before it runs.

    For more information, refer to How Do I Configure an Activity to Wait for Other Incoming Activities?

How to Start

  1. Open Process Builder.

    For information about how to open this screen, refer to Process Builder.


    Open Process Builder
  2. In Process Builder, in the Activity Library, open the AgilePoint NX tab.

    AgilePoint NX tab
  3. On the AgilePoint NX tab, drag the Remove Secure Credential activity onto your process.

    Drag Remove Secure Credential activity

General Configuration

Specifies the basic settings for the Remove Secure Credential activity.

Figure: General Configuration screen

General Configuration screen

Good to Know

  • Documentation for this screen is provided for completeness. The fields are mostly self-explanatory.

Fields

Field NameDefinition

Display Name

Function:
Specifies the activity name that shows in your process.
Accepted Values:
One line of text that can have spaces.
Default Value:
None
Accepts Process Data Variables:
No
Example:
This is a common configuration field that is used in many examples. Refer to:
  • Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Description

Function:
Specifies an optional text description for your activity.
Accepted Values:
More than one line of text.
Default Value:
None
Accepts Process Data Variables:
No

Secure Credential Type Configuration

Specifies the external system type for which to delete the runtime settings for the access token.

Figure: Secure Credential Types screen

Secure Credential Types screen

Fields

Field NameDefinition

Database

Function:
Specifies whether to delete the runtime settings for the database access token.