Profile name

Enter the name to be used for the profile. Users can then select from the list of profiles displayed in the macro editor. This field is mandatory. 

Database connection

Hostname

Enter the host name or the IP address of the database server to be accessed. This field is mandatory. 

Port

Enter the port number required to access the relevant database on the server. This field is mandatory.

Database

Enter the database name the macros must query for information. This field is mandatory.

Authentication type

Authentication type

Basic

Select the authentication method to be used to connect to the specified database. This field is mandatory.

The options are as follows:

• Basic - This is the default authentication method. This method uses the basic user authentication (user name and password) to validate access to the required database.

• AWS IAM - This authentication method is used to manage access to Amazon Web Services (AWS) and resources securely with access keys. 

User

Enter the user name to be used to log in the required database or AWS account. Based on the value of Authentication type, provide the following:

• Basic: Enter the user name or ID to be used to log into the required database. 

• AWS IAM: Enter the user ID of the AWS account used to log into the required database.

This field is mandatory.

Password

Enter the password to be used along with the user name to access the required database. This field is mandatory.

AWS region

Enter the AWS region (specified when creating the AWS account) where the relevant database is hosted.

An AWS region is a physical location that contains clusters of data centers where cloud based services are accessed over the internet. For more information about regions, refer to the AWS global infrastructure documentation. 

Key ID

Enter the AWS key ID of the user to log in the required database. This field is mandatory.

Access keys are long-term credentials for an IAM user or the AWS account root user. For more information about AWS access keys, refer to the AWS IAM documentation.

Secret access key

Enter the AWS secret access key (part of a user's AWS access key) to be used to log in the required database. This field is mandatory.

For more information about AWS access keys, refer to the AWS IAM documentation.

Test connection

Click this link to test whether a connection can be established with the required database using the specified authentication details. After the test is completed, either of the following indicators are shown:

Indicator	Definition
Open	Indicates that the connection information supplied for the data source profile enabled a successful validation. Thus, further connections can be made from Confluence to the targeted database. Note that this indicator does not imply that the profile is actually being used on a Confluence page.
Open	Indicates that the connection specific information is incorrect, and thus, the connection to the targeted database is not established. A relevant error message about the connection failure is displayed along with this indicator. If this indicator is displayed, update the profile details with the relevant changes.

Extended parameters

Limit rows processed

250

Select the maximum number of rows to be processed and displayed on Confluence pages. This setting prevents queries from using excessive resources that can result in a large number of rows.

Individual queries can use the Limit rows processed parameter in the macro editor to override this value.

The following options are available from a selection list:

• 250

• 500

• 1000

• 2500

• 5000

• 10000

• 25000

Limit query time

120

Select the time in seconds that a query can take before a forced timeout. This prevents queries that take too long, from impacting other users.

Individual users can use the Limit query time parameter in macro editor to override this value.

The following options are available from a selection list:

• 1

• 5

• 10

• 30

• 60

• 120