...
- Navigate to Manage apps > SQL Configuration > Data source profiles.
- Click the Add profile button to open the Add profile wizard.
Select your database. See here to learn more.
Provide connection and user credentials to access the specified database. Click this for more details.
Note title About Macro Security: Administrators can add another layer of security using Macro Security for Confluence. Administrators can specify trusted users and restrict access to specific macro parameters or parameter values in SQL Configuration > Macro security and add another layer of security. Refer to this documentation to learn more.
- Save your profile.
The newly created profile is now listed in the Data source profiles page.
Anchor sqlCld_100_config_profile_add01 sqlCld_100_config_profile_add01
Add profile wizard - Step 1
sqlCld_100_config_profile_add01 | |
sqlCld_100_config_profile_add01 |
Select the database that the macro must access, query, and retrieve data from.
Anchor sqlCld_100_config_profile_add02 sqlCld_100_config_profile_add02
Add profile wizard - Step 2
sqlCld_100_config_profile_add02 | |
sqlCld_100_config_profile_add02 |
After selecting the relevant SQL database, provide details such as the database connection details, user authentication method, and more.
...
Section | Parameter | Default value | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| 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:
| |||||||||
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:
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 theAWS 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:
| |||||||||||
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:
| |||||||||
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:
|
...
Note | ||
---|---|---|
| ||
There are some parameters, such as Limit rows processed or Limit query time, that are available in Global configuration, profile configuration, as well as macro editor. Any parameter defined at the macro level overrides the values set at the Global or profile configuration levels. The order of overriding the default setting is: Macro level parameter > Profile configuration > Global configuration |
Anchor sqlCld_100_config_profile_add03 sqlCld_100_config_profile_add03
Add profile wizard - Step 3
sqlCld_100_config_profile_add03 | |
sqlCld_100_config_profile_add03 |
Click Save profile to create the profile, or, Cancel to go back to the Data source profiles screen. The newly created profile is now displayed along with the connection status on the Data source profiles screen.
...
Click any of the given links to learn more about the app:
- App configuration for configuration related details
- SQL Query macro to learn more about the macroTutorials to learn app usage