The CData Sync App provides a straightforward way to continuously pipeline your Bugzilla data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.
The Bugzilla connector can be used from the CData Sync application to pull data from Bugzilla and move it to any of the supported destinations.
Create a connection to Bugzilla by navigating to the Connections page in the Sync App application and selecting the corresponding icon in the Add Connections panel. If the Bugzilla icon is not available, click the Add More icon to download and install the Bugzilla connector from the CData site.
Required properties are listed under the Settings tab. The Advanced tab lists connection properties that are not typically required.
You can use the Bugzilla developer's UI to establish a connection to your Bugzilla instance.
You can authenticate to your Bugzilla account using two parameters:
This section details a selection of advanced features of the Bugzilla Sync App.
The Sync App allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.
Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.
Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.
The Sync App offloads as much of the SELECT statement processing as possible to Bugzilla and then processes the rest of the query in memory (client-side).
See Query Processing for more information.
See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.
By default, the Sync App attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.
To specify another certificate, see the SSLServerCert property for the available formats to do so.
To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.
In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.
Set the following properties:
The CData Sync App models Bugzilla objects as relational tables and views. A Bugzilla object has relationships to other objects in the tables, and these relationships are expressed through foreign keys.
The following sections show the available API objects and provide more information on executing SQL to Bugzilla APIs.
Schemas for most database objects are defined in simple, text-based configuration files.
The Sync App offloads as much of the SELECT statement processing as possible to the Bugzilla APIs and then processes the rest of the query in memory. See SupportEnhancedSQL for more information on how the Sync App circumvents API limitations with in-memory client-side processing.
Views are composed of columns and pseudo columns. Views are similar to tables in the way that data is represented; however, views do not support updates. Entities that are represented as views are typically read-only entities. Often, a stored procedure is available to update the data if such functionality is applicable to the data source.
Queries can be executed against a view as if it were a normal table, and the data that comes back is similar in that regard.
Dynamic views, such as queries exposed as views, and views for looking up specific combinations of project_team work items are supported.
Name | Description |
Attachments | Get data about attachments, given a list of bugs and/or attachment IDs. Private attachments will only be returned if you are in the appropriate group or if you are the submitter of the attachment. |
BugCcDetail | Returns details of the CC of a certain Bug.
The 'SELECT * FROM BugCcDetail' query could be slow if you have a lot of Bugs. In that case, use 'IN' filtering for better performance. |
BugFields | Get information about valid bug fields. |
BugHistory | Returns information on the history of the bug you specified.
The 'SELECT * FROM BugHistory' query could be slow if you have a lot of Bugs. In that case, use 'IN' filtering for better performance. |
Bugs | Get information about your bugs. |
Comments | Allows you to get data about comments, given a bug ID or comment ID. |
CommentTags | Get information about the tags currently set for a comment. |
ComponentFlagTypes | Get information about the flag types of a component. |
Flags | Get information on either the flags of an attachment or the flags of a bug. |
Groups | Returns information about Bugzilla groups. |
ProductComponents | Get information on the components of a product.
Querying 'SELECT * FROM ProductComponents' could be slow because it retrieves all ProductIDs and then makes separate calls for each of them to get the ProductComponents. In that case use 'IN' filtering for better performance. |
ProductMilestones | Get information about milestones of a certain product.
Querying 'SELECT * FROM ProductMilestones' could be slow because it retrieves all ProductIDs and then makes separate calls for each of them to get the ProductMilestones. In that case use 'IN' filtering for better performance. |
Products | List the available products and get information about them.
By default this view will retrieve all accessible and selectable products. If you want to get only the products you can enter bugs against, you must use the 'type' filter like this: type='enterable' |
ProductVersions | Allows you to get information about versions of a certain product.
Querying 'SELECT * FROM ProductVersions' could be slow because it retrieves all ProductIDs and then makes separate calls for each of them to get the ProductVersions. In that case use 'IN' filtering for better performance. |
Users | Allows you to get information about user accounts. |
Get data about attachments, given a list of bugs and/or attachment IDs. Private attachments will only be returned if you are in the appropriate group or if you are the submitter of the attachment.
Name | Type | Description |
Id [KEY] | Int | The numeric ID of the attachment. |
FileName | String | The file name of the attachment. |
Data | String | The raw data of the attachment, encoded as Base64. |
Size | Int | The length (in bytes) of the attachment. |
BugId | Int | The numeric ID of the bug that the attachment is attached to. |
Summary | String | A short string describing the attachment. |
CreationTime | Datetime | The time the attachment was created. |
LastChangeTime | Datetime | The last time the attachment was modified. |
ContentType | String | The MIME type of the attachment. |
Creator | String | The login name of the user that created the attachment. |
IsPrivate | Boolean | 'true' if the attachment is private (only visible to a certain group called the |
IsObsolete | Boolean | 'true' if the attachment is obsolete, 'false' otherwise. |
IsPatch | Boolean | 'true' if the attachment is a patch, 'false' otherwise. |
Returns details of the CC of a certain Bug.
The 'SELECT * FROM BugCcDetail' query could be slow if you have a lot of Bugs. In that case, use 'IN' filtering for better performance.
Name | Type | Description |
Id [KEY] | Int | The ID of the cc list member. |
Name | String | The name of the cc list member. |
RealName | String | The 'real' name of the cc list member. |
String | The e-mail of the cc list member. | |
BugId | Int | The Id of the bug you're trying to get the CC details from. |
Get information about valid bug fields.
Name | Type | Description |
Id [KEY] | Int | An integer ID uniquely identifying this field in this installation only. |
Name | String | The internal name of this field. This is a unique identifier for this field. If this is not a custom field, then this name will be the same across all Bugzilla installations. |
DisplayName | String | The name of the field, as it is shown in the user interface. |
Type | Int | The number of the fieldtype. The following values are defined: '0' - Field type unknown, '1' - Single-line string field, '2' - Single value field, '3' - Multiple value field, '4' - Multi-line text value, '5' - Date field with time, '6' - Bug ID field, '7' - See Also field, '8' - Keywords field, '9' - Date field, '10' - Integer field |
IsCustom | Boolean | 'true' when this is a custom field, 'false' otherwise. |
IsMandatory | Boolean | 'true' if the field must have a value when filing new bugs. Also, mandatory fields cannot have their value cleared when updating bugs. |
IsOnBugEntry | Boolean | For custom fields, this is 'true' if the field is shown when you enter a new bug. For standard fields, this is currently always 'false', even if the field shows up when entering a bug. |
VisibilityField | String | The name of a field that controls the visibility of this field in the user interface. This field only appears in the user interface when the named field is equal to one of the values is VisibilityValues. Can be null. |
ValueField | String | The name of the field that controls whether or not particular values of the field are shown in the user interface. Can be null. |
VisibilityValues | String | This field is only shown when visibility_field matches one of these string values. When VisibilityField is null, then this is an empty array. |
Values | String | The legal values for select-type (drop-down and multiple-selection) fields. This is also populated for the Component, Version, TargetMilestone, and Keywords fields, but not for the Product field. |
Returns information on the history of the bug you specified.
The 'SELECT * FROM BugHistory' query could be slow if you have a lot of Bugs. In that case, use 'IN' filtering for better performance.
Name | Type | Description |
Who | String | The login name of the user who performed the bug change. |
When | Datetime | The date the bug activity/change happened. |
FieldName | String | The name of the bug field that has changed. |
Was | String | The previous value of the bug field which has been deleted by the change. |
Became | String | The new value of the bug field which has been added by the change. |
AttachmentId | Int | The ID of the attachment that was changed. This has a value only if the change was to an attachment. |
BugId | Int | The ID of the bug. |
Get information about your bugs.
Name | Type | Description |
Id | Int | The login name of the user who performed the bug change. |
Summary | String | The summary of this bug. |
AssignedTo | String | The login name of the user to whom the bug is assigned. |
Status | String | The current status of the bug. |
AliasAggregate | String | The unique aliases of this bug. |
ActualTime | Double | The total number of hours that this bug has taken so far. If you are not in the time-tracking group, this field will not be included in the return value. |
AssignedToId | Int | The Id of the user to whom the bug is assigned |
AssignedToRealName | String | The 'real' name of the user to whom the bug is assigned. |
Classification | String | The name of the current classification the bug is in. |
Component | String | The name of the component this bug belongs to. |
CreationTime | Datetime | When the bug was created. |
Creator | String | The login name of the person who filed this bug (the reporter). |
CreatorId | Int | The ID of the person who filed this bug (the reporter). |
Deadline | String | The day that this bug is due to be completed, in the format YYYY-MM-DD. |
DuplicateOf | Int | The bug ID of the bug that this bug is a duplicate of. If this bug isn't a duplicate of any bug, this will be null. |
EstimatedTime | Double | The number of hours that it was estimated that this bug would take. If you are not in the time-tracking group, this field will not be included in the return value. |
IsCcAccessible | Boolean | If true, this bug can be accessed by members of the CC list, even if they are not in the groups the bug is restricted to. |
IsConfirmed | Boolean | 'true' if the bug has been confirmed. Usually this means that the bug has at some point been moved out of the 'UNCONFIRMED' status and into another open status. |
IsOpen | Boolean | 'true' true if this bug is open, 'false' if it is closed. |
IsCreatorAccessible | Boolean | If true, this bug can be accessed by the creator of the bug, even if they are not a member of the groups the bug is restricted to. |
LastChangeTime | Datetime | When the bug was last changed. |
CreatorRealName | String | The real name of the person who filed this bug (the reporter). |
CreatorName | String | The name of the person who filed this bug (the reporter). |
CreatorEmail | String | The e-mail of the person who filed this bug (the reporter). |
OperatingSystem | String | The name of the operating system that the bug was filed against. |
Platform | String | The name of the platform (hardware) that the bug was filed against. |
Priority | String | The priority of the bug. |
Product | String | The name of the product this bug is in. |
QAContact | String | The login name of the current QA Contact on the bug. |
RemainingTime | Double | The number of hours of work remaining until work on this bug is complete. If you are not in the time-tracking group, this field will not be included in the return value. |
Resolution | String | The current resolution of the bug, or an empty string if the bug is open. |
Severity | String | The current severity of the bug. |
TargetMilestone | String | The milestone that this bug is supposed to be fixed by, or for closed bugs, the milestone that it was fixed for. |
UpdateToken | String | The token that you would have to pass to the process_bug.cgi page in order to update this bug. This changes every time the bug is updated. This field is not returned to logged-out users. |
URL | String | A URL that demonstrates the problem described in the bug, or is somehow related to the bug report. |
Version | String | The version the bug was reported against. |
Whiteboard | String | The value of the |
BlocksAggregate | String | The IDs of bugs that are |
CCAggregate | String | The login names of users on the CC list of this bug. |
DependsOnAggregate | String | The IDs of bugs that this bug |
KeywordsAggregate | String | Each keyword that is on this bug. |
SeeAlsoAggregate | String | The URLs in the See Also field on the bug. |
Allows you to get data about comments, given a bug ID or comment ID.
Name | Type | Description |
Id [KEY] | Int | The globally unique ID for the comment. |
BugId | Int | The ID of the bug that this comment is on. |
AttachmentId | Int | If the comment was made on an attachment, this will be the ID of that attachment. Otherwise it will be null. |
Text | String | The actual text of the comment. |
Count | Int | The number of the comment local to the bug. The Description is 0, comments start with 1. |
Creator | String | The login name of the comment's author. |
CreationTime | Datetime | The time (in Bugzilla's timezone) that the comment was added. |
IsPrivate | Boolean | 'true' if this comment is private (only visible to a certain group called the |
Get information about the tags currently set for a comment.
Name | Type | Description |
Tag | String | The comment tag that matched the specified query. |
Query | String | The query specified. |
Get information about the flag types of a component.
Name | Type | Description |
Id [KEY] | Int | The ID of the flagtype. |
FlagName | String | The name of the flagtype. |
Description | String | The description of the flagtype. |
CcList | String | The concatenated CC list for the flagtype, as a single string. |
SortKey | Int | The sortkey of the flagtype. |
IsActive | Boolean | Whether the flagtype is active or disabled. Flags being in a disabled flagtype are not deleted. It only prevents you from adding new flags to it. |
IsRequestable | Boolean | Whether you can request for the given flagtype (i.e. whether the '?' flag is available or not). |
IsRequesteeble | Boolean | Whether you can ask someone specifically or not. |
IsMultiplicable | Boolean | Whether you can have more than one flag for the given flagtype in a given bug/attachment. |
GrantGroup | Int | The group ID that is allowed to grant/deny flags of this type. If the item is not included all users are allowed to grant/deny this flagtype. |
RequestGroup | Int | The group ID that is allowed to request the flag if the flag is of the type requestable. If the item is not included all users are allowed request this flagtype. |
ProductName | String | The product that contains the component these flagtypes are in. |
ComponentName | String | The component these flagtypes are in. |
Type | String | Whether this flag type belongs to a 'bug' or an 'attachment' |
Get information on either the flags of an attachment or the flags of a bug.
Name | Type | Description |
Id [KEY] | Int | The ID of the flag. |
Name | String | The name of the flag. |
TypeId | Int | The type ID of the flag. |
Status | String | The current status of the flag. |
Setter | String | The login name of the user who created or last modified the flag. |
CreationDate | Datetime | The timestamp when this flag was originally created. |
ModificationDate | Datetime | The timestamp when the flag was last modified. |
BugId | Int | The ID of the flag. |
AttachmentId | Int | The ID of the flag. |
Returns information about Bugzilla groups.
Name | Type | Description |
Id [KEY] | Int | The unique integer ID that Bugzilla uses to identify this group. Even if the name of the group changes, this ID will stay the same. |
Name | String | The name of the group. |
Description | String | The description of the group. |
IsBugGroup | Int | Whether this group is to be used for bug reports or is only administrative specific. |
UserRegExp | String | A regular expression that allows users to be added to this group if their login matches. |
IsActive | Boolean | Whether this group is currently active or not. |
Membership | Int | Set this to 1 to get the Users of the group. This field holds no information. |
Users | String | User objects that are members of this group; only returned if the user sets the 'Membership' parameter to 1. |
Get information on the components of a product.
Querying 'SELECT * FROM ProductComponents' could be slow because it retrieves all ProductIDs and then makes separate calls for each of them to get the ProductComponents. In that case use 'IN' filtering for better performance.
Name | Type | Description |
Id [KEY] | Int | An integer ID uniquely identifying the component in this installation only. |
Name | String | The name of the component. This is a unique identifier for this component. |
Description | String | A description of the component, which may contain HTML. |
DefaulAssignedTo | String | The login name of the user to whom new bugs will be assigned by default. |
DefaultQAContact | String | The login name of the user who will be set as the QA Contact for new bugs by default. Empty string if the QA contact is not defined. |
SortKey | Int | Components, when displayed in a list, are sorted first by this integer and then secondly by their name. |
IsActive | Boolean | A boolean indicating if the component is active. Inactive components are not enabled for new bugs. |
ProductId | Int | The ID of the product this component belongs to. |
ProductName | String | The name of the product this component belongs to. |
Get information about milestones of a certain product.
Querying 'SELECT * FROM ProductMilestones' could be slow because it retrieves all ProductIDs and then makes separate calls for each of them to get the ProductMilestones. In that case use 'IN' filtering for better performance.
Name | Type | Description |
Id [KEY] | Int | An integer ID uniquely identifying this milestone. |
Name | String | The name of the milestone of the product. |
IsActive | Boolean | A boolean indicating if this milestone of the product is active. |
SortKey | Int | The sorting key of this milestone of the product. |
ProductId | Int | The ID of the product this milestone belongs to. |
ProductName | String | The name of the product this milestone belongs to. |
List the available products and get information about them.
By default this view will retrieve all accessible and selectable products. If you want to get only the products you can enter bugs against, you must use the 'type' filter like this: type='enterable'
Name | Type | Description |
Id [KEY] | Int | An integer ID uniquely identifying the product in this installation only. |
Name [KEY] | String | The name of the product. This is a unique identifier for the product. |
Description | String | A description of the product, which may contain HTML. |
IsActive | Boolean | A boolean indicating if the product is active. |
Classification | String | The classification name for the product. |
DefaultMilestone | String | The name of the default milestone for the product. |
HasUnconfirmed | Boolean | Indicates whether the UNCONFIRMED bug status is available for this product. |
Type | String | Return information about specific type of products such as 'accessible', 'selectable', or 'enterable' |
Allows you to get information about versions of a certain product.
Querying 'SELECT * FROM ProductVersions' could be slow because it retrieves all ProductIDs and then makes separate calls for each of them to get the ProductVersions. In that case use 'IN' filtering for better performance.
Name | Type | Description |
Id [KEY] | Int | An integer ID uniquely identifying the version of this product. |
Name | String | The name of the version of the product. |
IsActive | Boolean | A boolean indicating if this version of the product is active. |
SortKey | Int | The sorting key of this version of the product. |
ProductId | Int | The ID of the product this version belongs to. |
ProductName | String | The name of the product this version belongs to. |
Allows you to get information about user accounts.
Name | Type | Description |
Id [KEY] | Int | The unique integer ID that Bugzilla uses to represent this user. Even if the user's login name changes, this will not change. |
Name | String | The login name of the user. |
RealName | String | The actual name of the user. May be blank. |
String | The email address of the user. | |
CanLogin | Boolean | A boolean value to indicate if the user can login into Bugzilla. |
EmailEnabled | Boolean | A boolean value to indicate if bug-related mail will be sent to the user or not. |
LoginDeniedText | String | A text field that holds the reason for disabling a user from logging into Bugzilla. If empty then the user account is enabled; otherwise it is disabled/closed. |
SavedSearches | String | User's saved searches. |
SavedReports | String | User's saved reports. |
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
For more information on establishing a connection, see Establishing a Connection.
Property | Description |
URL | The URL to the Bugzilla server used for logging in. |
APIKey | An ApiKey to authenticate to your account. API keys can be created in the Preferences > API Keys section. |
Property | Description |
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
Property | Description |
FirewallType | The protocol used by a proxy-based firewall. |
FirewallServer | The name or IP address of a proxy-based firewall. |
FirewallPort | The TCP port for a proxy-based firewall. |
FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
FirewallPassword | A password used to authenticate to a proxy-based firewall. |
Property | Description |
ProxyAutoDetect | This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings. |
ProxyServer | The hostname or IP address of a proxy to route HTTP traffic through. |
ProxyPort | The TCP port the ProxyServer proxy is running on. |
ProxyAuthScheme | The authentication type to use to authenticate to the ProxyServer proxy. |
ProxyUser | A user name to be used to authenticate to the ProxyServer proxy. |
ProxyPassword | A password to be used to authenticate to the ProxyServer proxy. |
ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
Property | Description |
LogModules | Core modules to be included in the log file. |
Property | Description |
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
Property | Description |
IncludeCustomFields | Determines if Custom Fields should be included as table columns or not. |
MaxRows | Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time. |
Other | These hidden properties are used only in specific use cases. |
Pagesize | The maximum number of results to return per page from Bugzilla. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
RowScanDepth | The maximum number of rows to scan to look for the columns available in a table. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.
Property | Description |
URL | The URL to the Bugzilla server used for logging in. |
APIKey | An ApiKey to authenticate to your account. API keys can be created in the Preferences > API Keys section. |
The URL to the Bugzilla server used for logging in.
The URL to the Bugzilla server used for logging in.
An ApiKey to authenticate to your account. API keys can be created in the Preferences > API Keys section.
ApiKey
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
Property | Description |
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
The certificate to be accepted from the server when connecting using TLS/SSL.
If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.
This property can take the following forms:
Description | Example |
A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
A path to a local file containing the certificate | C:\cert.cer |
The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
The MD5 Thumbprint (hex values can also be either space or colon separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
The SHA1 Thumbprint (hex values can also be either space or colon separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
If not specified, any certificate trusted by the machine is accepted.
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.
Property | Description |
FirewallType | The protocol used by a proxy-based firewall. |
FirewallServer | The name or IP address of a proxy-based firewall. |
FirewallPort | The TCP port for a proxy-based firewall. |
FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
FirewallPassword | A password used to authenticate to a proxy-based firewall. |
The protocol used by a proxy-based firewall.
This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that by default, the Sync App connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.
Type | Default Port | Description |
TUNNEL | 80 | When this is set, the Sync App opens a connection to Bugzilla and traffic flows back and forth through the proxy. |
SOCKS4 | 1080 | When this is set, the Sync App sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted. |
SOCKS5 | 1080 | When this is set, the Sync App sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes. |
To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.
The name or IP address of a proxy-based firewall.
This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.
Note that the Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.
The TCP port for a proxy-based firewall.
This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.
The user name to use to authenticate with a proxy-based firewall.
The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.
A password used to authenticate to a proxy-based firewall.
This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.
This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.
Property | Description |
ProxyAutoDetect | This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings. |
ProxyServer | The hostname or IP address of a proxy to route HTTP traffic through. |
ProxyPort | The TCP port the ProxyServer proxy is running on. |
ProxyAuthScheme | The authentication type to use to authenticate to the ProxyServer proxy. |
ProxyUser | A user name to be used to authenticate to the ProxyServer proxy. |
ProxyPassword | A password to be used to authenticate to the ProxyServer proxy. |
ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.
The hostname or IP address of a proxy to route HTTP traffic through.
The hostname or IP address of a proxy to route HTTP traffic through. The Sync App can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.
If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.
By default, the Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.
The TCP port the ProxyServer proxy is running on.
The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.
The authentication type to use to authenticate to the ProxyServer proxy.
This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.
Note that the Sync App will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.
The authentication type can be one of the following:
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.
A user name to be used to authenticate to the ProxyServer proxy.
The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:
user@domain domain\user
A password to be used to authenticate to the ProxyServer proxy.
This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.
If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.
If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.
For SOCKS 5 authentication or tunneling, see FirewallType.
By default, the Sync App uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.
The SSL type to use when connecting to the ProxyServer proxy.
This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:
AUTO | Default setting. If the URL is an HTTPS URL, the Sync App will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option. |
ALWAYS | The connection is always SSL enabled. |
NEVER | The connection is not SSL enabled. |
TUNNEL | The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy. |
A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .
The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.
Note that the Sync App uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
Property | Description |
LogModules | Core modules to be included in the log file. |
Core modules to be included in the log file.
Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.
See the Logging page for an overview.
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
Property | Description |
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
A path to the directory that contains the schema files defining tables, views, and stored procedures.
The path to a directory which contains the schema files for the Sync App (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.
If left unspecified, the default location is "%APPDATA%\\CData\\Bugzilla Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:
This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.
This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Sync App.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Sync App.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
Property | Description |
IncludeCustomFields | Determines if Custom Fields should be included as table columns or not. |
MaxRows | Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time. |
Other | These hidden properties are used only in specific use cases. |
Pagesize | The maximum number of results to return per page from Bugzilla. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
RowScanDepth | The maximum number of rows to scan to look for the columns available in a table. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
Determines if Custom Fields should be included as table columns or not.
It is possible to create custom fields in Bugzilla. To retrieve their values you can set IncludeCustomFields=true as a connection property. Doing so will list the custom fields created as table columns.
Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
These hidden properties are used only in specific use cases.
The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.
Specify multiple properties in a semicolon-separated list.
DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
ConvertDateTimeToGMT | Determines whether to convert date-time values to GMT, instead of the local time of the machine. |
RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
The maximum number of results to return per page from Bugzilla.
The Pagesize property affects the maximum number of results to return per page from Bugzilla. Setting a higher value may result in better performance at the cost of additional memory allocated per page consumed.
This property indicates whether or not to include pseudo columns as columns to the table.
This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".
The maximum number of rows to scan to look for the columns available in a table.
The columns in a table must be determined by scanning table rows. This value determines the maximum number of rows that will be scanned.
Setting a high value may decrease performance. Setting a low value may prevent the data type from being determined properly, especially when there is null data.
The value in seconds until the timeout error is thrown, canceling the operation.
If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.
If Timeout expires and the operation is not yet complete, the Sync App throws an exception.
A filepath pointing to the JSON configuration file containing your custom views.
User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Sync App automatically detects the views specified in this file.
You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the Sync App.
This User Defined View configuration file is formatted as follows:
For example:
{ "MyView": { "query": "SELECT * FROM SampleTable_1 WHERE MyColumn = 'value'" }, "MyView2": { "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)" } }Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:
"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"