Data Sources H

NOTE: It is recommended that data sources be registered in Common instead of System Administration. A Data Services data source must be registered in Common and cannot be registered in System Administration.

Use this page to:

The configuration of the Vertical View depends on the Data Source Type. Options are:

To access this page, select  Admin > Data Sources in the Navigation pane.

Data Sources V

Data Sources H

Use this page to Register a Data Source.

The configuration of the Vertical View depends on the Data Source Type. Options are:

Data Sources V: SQL Server

This page contains the following tabs:

General tab

Field

Description

Test Connection

Click to test the connection to the data source, which verifies that the user ID and password are valid.

Recompile Objects

Click to verify the data is available in the database. Objects may need to be recompiled a few times. If the recompile fails after three attempts, submit an issue to BackOffice Support:

https://support.boaweb.com/.

Append Columns

Click to append the BackOffice reserved columns to all tables in the data source that do not already contain them. The following are BackOffice reserved columns:

  • boaStatus
  • AddedOn
  • AddedBy
  • AddedVia
  • ChangedBy
  • ChangedOn
  • ChangedVia

Refer to Append BOA Reserved Columns to Tables for more information.

NOTE This feature is used for local SQL data sources only.

Data Source Type

Displays the type of data source: SqlServer.

Connection Settings

Server Address

Displays address of the server this data source connects to. The database name must be the host name of the database instance and cannot be the IP address. Although the IP address may test successfully, if the IP address is used for the CranSoft data source, then Collect downloads do not return the Record Count and the rules registered to Collect tables will not execute.

Database

Displays the database name exactly as it appears in the database.

User ID

Displays the user ID used to connect to the database.

Password

Displays asterisks representing the password associated with the user ID used to connect to the database.

Advanced Properties tab

Field

Description

Active

If checked, the data source is active. If unchecked, the data source is inactive, and system views cannot be created for the data source.

Protected

If checked, the data source is protected (read only) and no schema changes will be performed by DSP®.

Features that make changes to the data source are hidden/disabled (for example, Recompile Objects, Append System Columns, building System Views, indexing, auditing, encryption, and building WebApps).

System Views

If checked, Systems Views are created in the data source by DSP®. System Views are views that are installed by the Platform in a data source that links back to certain tables or views in the CranSoft database.

This feature is often used for more advanced WebApp development.

If unchecked, Systems Views are not created in the data source by DSP®.

Connection Properties

Port

Displays the TCP/IP Port to use when connecting to the data source. FTP, HTTP, and databases can use non-default ports for security and management.

Trusted Connection

If checked, if the Server is configured to connect using Windows Authentication, the connection uses the hosting machine’s information to authenticate the connection and bypass the usage of the User ID and Password fields.

Connection Timeout

Displays the number of seconds until the connection times out and the DSP displays an error message stating that the connection failed. Generally, this value does not need to be changed to a value higher than 30 seconds, and adjustment to values above that should be made after checking with BackOffice Product Support.

Command Timeout

Displays the number of seconds until the command times out, the execution of the command fails, and the DSP displays a notification about the error. Insufficient command timeouts are the main cause of timeout errors in DSP and this parameter may be increased to a high value to accommodate long running processes.

 

Data Sources V: ODBC

Data Sources H

This page contains the following tabs:

General tab

Field

Description

Test Connection

Click to test the connection to the data source, which verifies that the user ID and password are valid.

Recompile Objects

This feature is not supported for ODBC data sources.

Append Columns

This feature is not supported for ODBC data sources.

Data Source Type

Displays the type of data source: ODBC.

Connection Settings

Database Type

Displays the type of database.

Server Address

Displays address of a non-DSP server used to connect to the current system. The database name must be the host name of the database instance and cannot be the IP address. Although the IP address may test successfully, if the IP address is used for the CranSoft data source, then Collect downloads do not return the Record Count and the rules registered to Collect tables will not execute.

Database

Displays the database name exactly as it appears in the database.

Connection String

Displays the OLE database connection string.

DSN

Displays the Data Source Name (DSN) parameter, which can be used when the connection to the data source is not a SQL server connection. It is used primarily when defined by the web server control panel, or if the SQL server connection requires additional special parameters not supplied by the DSP standard connection.

User ID

Displays the user name used to connect to the database.

Password

Displays asterisks representing the password associated with the User ID used to connect to the database.

Advanced Properties tab

Field

Description

Active

If checked, the data source is active. If unchecked, the data source is inactive and system views cannot be created for the data source.

Protected

If checked, the data source is protected (read only) and no schema changes will be performed by DSP.

Features that make changes to the data source are hidden/disabled (for example, Recompile Objects, Append System Columns, building System Views, indexing, auditing, encryption, and building WebApps).

System Views

If checked, Systems Views are created in the data source by DSP®. System Views are views that are installed by the Platform in a data source that links back to certain tables or views in the CranSoft database.

This feature is often used for advanced WebApp development.

If unchecked, Systems Views are not created in the data source by DSP®.

Connection Properties

Connection Timeout

Displays the number of seconds until the connection times out and the DSP displays an error message stating that the connection failed. Generally, this value does not need to be changed to a value higher than 30 seconds, and adjustment to values above that should be made after checking with BackOffice Product Support.

Command Timeout

Displays the number of seconds until the command times out, the execution of the command fails, and the DSP displays a notification about the error. Insufficient command timeouts are the main cause of timeout errors in DSP and this parameter may be increased to a high value to accommodate long running processes.

Schema Properties

Procedure Parameter Name Prefix

Displays the parameter prefix used for the data source. Parameters are usually prefixed to not conflict with table/view column names when writing a stored procedure. By registering this prefix at the data source level, the Platform adds the prefix to the column name when passing parameters to stored procedures.

 

Data Sources V: Local File

Data Sources H

This page contains the following tabs:

General tab

Field

Description

Test Connection

Click to test the connection to the file system. This process:

  • Verifies the User ID and Password are valid and/or verifies permissions have been granted to access the specified path in the file system.
  • Updates the permissions on the Permissions tab.

Data Source Type

Displays the type of data source: Local File.

Path Settings

Path

Displays the path where the local file is stored.

Permissions tab
Field Description
Can Read If checked, users have Read permissions to the local file. This field is set based on the permissions granted by the file system given the file path and credentials specified, and is updated when the Test Connection icon is clicked.
Can Write If checked, users have Write permissions to the local file. This field is set based on the permissions granted by the file system given the file path and credentials specified, and is updated when the Test Connection icon is clicked.
Can Delete If checked, users have Delete permissions to the local file. This field is set based on the permissions granted by the file system given the file path and credentials specified, and is updated when the Test Connection icon is clicked.

Data Sources V: OleDB

Data Sources H

This page contains the following tabs:

General tab

Field

Description

Test Connection

Click to test the connection to the Data Source by verifying that the User ID and Password are valid.

Recompile Objects

This feature is not supported for OleDB data source types.

Append Columns

This feature is not supported for OleDB data source types.

Data Source Type

Displays the type of data source: OleDB.

Connection Settings

Database Type

Displays the type of database.

Server Address

Displays address of a non-DSP server used to connect to the current system. The database name must be the host name of the database instance and cannot be the IP address. Although the IP address may test successfully, if the IP address is used for the CranSoft data source, then Collect downloads do not return the Record Count and the rules registered to Collect tables will not execute.

Database

Displays the database name exactly as it appears in the database.

Connection String

Displays the OLE database connection string.

DSN

Displays the Data Source Name (DSN) parameter, which can be used when the connection to the data source is not a SQL server connection. It is used primarily when defined by the web server control panel, or if the SQL server connection requires additional special parameters not supplied by the DSP standard connection.

User ID

Displays the user name used to connect to the database.

Password

Displays asterisks representing the password associated with the User ID used to connect to the database.

Advanced Properties tab

Field

Description

Active

If checked, the data source is active. If unchecked, the data source is inactive and system views cannot be created for the data source.

Protected

If checked, the Data Source is protected (read only) and features that make changes to the Data Source will be hidden/disabled (e.g., Recompile Objects, Append System Columns, building System Views, indexing, auditing, encryption, and building WebApps).

System Views

If checked, Systems Views are created in the data source by DSP®. System Views are views that are installed by the Platform in a data source that links back to certain tables or views in the CranSoft database.

This feature is often used for advanced WebApp development.

If unchecked, Systems Views are not created in the data source by DSP®.

Connection Properties

Connection Timeout

Displays the number of seconds until the connection times out and the DSP displays an error message stating that the connection failed. Generally, this value does not need to be changed to a value higher than 30 seconds, and adjustment to values above that should be made after checking with BackOffice Product Support.

Command Timeout

Displays the number of seconds until the command times out, the execution of the command fails, and the DSP displays a notification about the error. Insufficient command timeouts are the main cause of timeout errors in DSP and this parameter may be increased to a high value to accommodate long running processes.

Schema Properties

Procedure Parameter Name Prefix

Displays the parameter prefix used for the data source. Parameters are usually prefixed to not conflict with table/view column names when writing a stored procedure. By registering this prefix at the data source level, the Platform adds the prefix to the column name when passing parameters to stored procedures.

Data Sources V: Oracle

Data Sources H

This page contains the following tabs:

General tab

Field

Description

Test Connection

Click to test the connection to the Data Source, which verifies that the user ID and password are valid..

Recompile Objects

Click to verify the data is available in the database. Objects may need to be recompiled a few times. If the recompile fails after three attempts, submit an issue to BackOffice Support:

http://support.boaweb.com/.

Append Columns

This feature is not supported for Oracle data source types.

Click to append the BackOffice reserved columns to all tables in the data source that do not already contain them. The following are BackOffice reserved columns:

  • boaStatus
  • AddedOn
  • AddedBy
  • AddedVia
  • ChangedBy
  • ChangedOn
  • ChangedVia

Refer to Append BoA Reserved Columns to Tables for more information.

Data Source Type

Displays the type of data source.

Connection Settings

Server Address

Displays address of a non-DSP server used to connect to the current system. The database name must be the host name of the database instance and cannot be the IP address. Although the IP address may test successfully, if the IP address is used for the CranSoft data source, then Collect downloads do not return the Record Count and the rules registered to Collect tables will not execute.

Database

Displays the database name exactly as it appears in the database.

NOTE: If this field is populated, the Database Instance Name on the Advanced Properties tab must be blank.

User ID

Displays the user name used to connect to the database.

Password

Displays asterisks representing the password associated with the User ID used to connect to the database.

Advanced Properties tab

Field

Description

Active

If checked, the data source is active. If unchecked, the data source is inactive and system views cannot be created for the data source.

Protected

If checked, the Data Source is protected (i.e., read only) and features that make changes to the Data Source will be hidden/disabled (e.g., Recompile Objects, Append System Columns, building System Views, indexing, auditing, encryption, and building WebApps).

Connection Properties

Database Instance Name

Displays the Oracle instance name. This field is not required if using the Database Instance Name listed in the TNSNames.ora file for connection. If using the Database field on the General tab, this field should be empty.

Port

Displays the TCP/IP Port to use when connecting to this Oracle data source. This field is not required if using the Port listed in the TNSNames.ora file for the connection.

Trusted Connection

If checked, if the Server is configured to connect using Windows Authentication, the connection uses the hosting machine’s information to authenticate the connection and does not use the User ID and Password fields.

Connection Timeout

Displays the number of seconds until the connection times out and the DSP displays an error message stating that the connection failed. Generally, this value does not need to be changed to a value higher than 30 seconds, and adjustment to values above that should be made after checking with BackOffice Product Support.

Command Timeout

Displays the number of seconds until the command times out, the execution of the command fails, and the DSP displays a notification about the error. Insufficient command timeouts are the main cause of timeout errors in DSP and this parameter may be increased to a high value to accommodate long running processes.

Schema Properties

Procedure Parameter Name Prefix

Displays the parameter prefix used for the data source. Parameters are usually prefixed to not conflict with table/view column names when writing a stored procedure. By registering this prefix at the data source level, the Platform adds the prefix to the column name when passing parameters to stored procedures.

Sequences

This feature is not used.

Data Sources V: Remote File (FTP)

This page contains the following tabs:

General tab

Field

Description

Test Connection

Click to test the connection to the file system. This process:

  • Verifies the User ID and Password are valid and permissions have been granted to access the specified path in the file system
  • Updates the permissions on the Permissions tab

Data Source Type

Displays the type of data source: Remote File (FTP).

Path Settings

Server Address

Displays address of a non-DSP server used to connect to the current system.

Path

Displays the path where the remote file is stored.

Port

Displays the TCP/IP Port to use when connecting to the data source. FTP, HTTP, and databases can use non-default port for security and management.

User ID

Displays the user name used to connect to the file system.

Password

Displays asterisks representing the password associated with the User ID used to connect to the file system.

Permissions tab
Field Description
Can Read If checked, users have Read permissions to the remote file. This field is set based on the permissions granted by the file system given the file path and credentials specified, and is updated when the Test Connection icon is clicked.
Can Write If checked, users have Write permissions to the remote file. This field is set based on the permissions granted by the file system given the file path and credentials specified, and is updated when the Test Connection icon is clicked.
Can Delete If checked, users have Delete permissions to the remote file. This field is set based on the permissions granted by the file system given the file path and credentials specified, and is updated when the Test Connection icon is clicked.

Data Sources V: Remote File (HTTP)

This page contains the following tabs:

General tab

Field

Description

Test Connection

Click to test the connection to the file system. This process:

  • Verifies the User ID and Password are valid and permissions have been granted to access the specified path in the file system
  • Updates the permissions on the Permissions tab

Data Source Type

Displays the type of data source: Remote File (HTTP).

Path Settings

Server Address

Displays address of a non-DSP server used to connect to the current system..

Path

Displays the path where the data source is stored.

User ID

Displays the user name used to connect to the file system.

Password

Displays asterisks representing the password associated with the User ID used to connect to the file system.

Permissions tab
Field Description
Can Read If checked, users have Read permissions to the remote file. This field is set based on the permissions granted by the file system given the file path and credentials specified, and is updated when the Test Connection icon is clicked.
Can Write If checked, users have Write permissions to the remote file. This field is set based on the permissions granted by the file system given the file path and credentials specified, and is updated when the Test Connection icon is clicked.
Can Delete If checked, users have Delete permissions to the remote file. This field is set based on the permissions granted by the file system given the file path and credentials specified, and is updated when the Test Connection icon is clicked.

Data Sources V: Remote File (UNC)

This page contains the following tabs:

General tab

Field

Description

Test Connection

Click to test the connection to the file system. This process:

  • Verifies the User ID and Password are valid and permissions have been granted to access the specified path in the file system
  • Updates the permissions on the Permissions tab

Data Source Type

Displays the type of data source: Remote File (UNC).

Path Settings

Path

Displays the path where the remote file is stored.

User ID

Displays the user name used to connect to the file system.

Password

Displays asterisks representing the password associated with the User ID used to connect to the file system.

Permissions tab
Field Description
Can Read If checked, users have Read permissions to the remote file. This field is set based on the permissions granted by the file system given the file path and credentials specified, and is updated when the Test Connection icon is clicked.
Can Write If checked, users have Write permissions to the remote file. This field is set based on the permissions granted by the file system given the file path and credentials specified, and is updated when the Test Connection icon is clicked.
Can Delete If checked, users have Delete permissions to the remote file. This field is set based on the permissions granted by the file system given the file path and credentials specified, and is updated when the Test Connection icon is clicked.