Set Secure Credential activity

An activity that lets you change the settings of an access token for an external system for a process instance at runtime.


Set Secure Credential activity

Configure the Set Secure Credential activity

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

Prerequisites

  • When you configure this activity, the database type must be the same as access token specified in any database activities whose credentials you want to override.
  • If you use a different database in the Set Secure Credentials activity than the one specified in the access token, the column names in both databases must be the same.

Good to Know

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

    For more information, refer to Configure E-mail Notifications for Any Activity.

  • 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)

  • You must configure all settings for an access token in order to override it. You can not, for example, enter only a new user name and password.
  • 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)

  • In most text fields, you can use process data variables as an alternative to literal data values.
  • 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 the Process Builder, in the Activity Library, open the AgilePoint NX tab.

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

    Drag Set Secure Credential activity

General Configuration

Specifies the basic settings for the Set Secure Credential activity.

Figure: General Configuration screen

General Configuration screen

Fields

Field Name Definition

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 Types

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

Figure: Secure Credential Types screen

Secure Credential Types screen

Fields

Field Name Definition

Database

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

Set Secure Credential Configuration (Database)

Specifies the information to change the settings for the database access token.

Figure: Set Secure Credential Configuration (Database) screen

Set Secure Credential Configuration screen

Fields

Field Name Definition

Database Type

Function:
Specifies the database technology to store your data.
Note: When you configure this activity, the database type must be the same as access token specified in any database activities whose credentials you want to override.
Accepted Values:
  • SQL Server
  • MySQL
  • Oracle
Default Value:
None

Database Server Name

Function:
Specifies the database server name, where your database is installed.
Accepted Values:
A valid database server name.
Default Value:
None
Accepts Process Data Variables:
Yes

Database Name

Function:
Specifies the name of your database.
Note: If you use a different database in the Set Secure Credentials activity than the one specified in the access token, the column names in both databases must be the same.
Accepted Values:
A valid database name.
Default Value:
None
Accepts Process Data Variables:
Yes

Port

Function:
Specifies the port number to connect to the database server.
Accepted Values:
A valid port number.
Default Value:
None
Accepts Process Data Variables:
No

Timeout(seconds)

Function:
Specifies the maximum time in seconds to connect to the database.
Accepted Values:
An integer.
Default Value:
600

SSPI (Integrated Security)

Function:
Determines whether the SSPI integrated security is to be activated.
Accepted Values:
  • Deselected - Specifies not to activate the SSPI integrated security.
  • Selected - Specifies to activate the SSPI integrated security.
Default Value:
Deselected

User Name

Function:
Specifies the user name for database authentication.
Accepted Values:
A valid user name.
Default Value:
None
Accepts Process Data Variables:
Yes

Password

Function:
The password for the authentication account.
Accepted Values:
An alphanumeric string that represents a password.
Default Value:
None
Accepts Process Data Variables:
Yes