Establishing a Connection
Oracle Sales Cloud uses Basic authentication over SSL; after setting the following connection properties, you are ready to connect:
- Username: Set this to the user name that you use to log into your Oracle Cloud service.
- Password: Set this to your password.
- HostURL: Set this to the Web address (URL) of your Oracle Cloud service.
Customizing the SSL Configuration
By default, the provider 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.
Connecting Through a Firewall or Proxy
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:
- To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
- To tunnel the connection, set FirewallType to TUNNEL.
- To authenticate, specify FirewallUser and FirewallPassword.
- To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.
Troubleshooting the Connection
To show provider activity from query execution to network traffic, use Logfile and Verbosity. The examples of common connection errors below show how to use these properties to get more context. Contact the support team for help tracing the source of an error or circumventing a performance issue.
- Authentication errors: Typically, recording a Logfile at Verbosity 4 is necessary to get full details on an authentication error.
- Queries time out: A server that takes too long to respond will exceed the provider's client-side timeout. Often, setting the Timeout property to a higher value will avoid a connection error. Another option is to disable the timeout by setting the property to 0. Setting Verbosity to 2 will show where the time is being spent.
- The certificate presented by the server cannot be validated: This error indicates that the provider cannot validate the server's certificate through the chain of trust. If you are using a self-signed certificate, there is only one certificate in the chain.
To resolve this error, you must verify yourself that the certificate can be trusted and specify to the provider that you trust the certificate. One way you can specify that you trust a certificate is to add the certificate to the trusted system store; another is to set SSLServerCert.
Custom Fields and Objects
Schemas for standard Oracle Sales Cloud tables are internally stored in Lyftron Provider for Oracle Sales Cloud and used to minimize the amount of sent requests and payload received. By default, Lyftron Provider for Oracle Sales Cloud will use these tables and not expose any of your instance's custom fields or objects.
The Lyftron Provider for Oracle Sales Cloud supports dynamically retrieving schemas for custom fields and objects from within your Oracle Sales Cloud specific instance following the steps described below.
Including Custom Fields
In case your schema needs to include custom fields (columns) added to Oracle Sales Cloud standard objects (tables), you can use the IncludeCustomFields connection property. Setting this property to true will result in one or more extra calls being issued and will affect Lyftron Provider for Oracle Sales Cloud behavior in the following ways:
- Custom fields will be retrieved and listed along with the rest of the columns in your schema.
- All internally stored columns will be replaced with dynamically generated columns based on the latest API version.
Including Custom Objects
In case you need to access custom objects (tables), created to your Oracle Sales Cloud instance, you can use the IncludeCustomObjects connection property. By default, this property is set to false, and when queries are attempted on custom objects, they will fail to execute due to the internal schema being used. Similarly to IncludeCustomFields, setting this property to true, will issue one or more extra requests.
Generating Schema Files
If you need to regularly work with custom fields and/or custom objects, you can use the GenerateSchemaFiles connection property to store locally a dynamically generated schema and avoid constantly using IncludeCustomFields and IncludeCustomObjects, which in return will decrease execution time and payload.
Note: Setting GenerateSchemaFiles=OnStart/OnUse alone, will only generate a schema containing custom fields for all standard tables but not any custom tables. Using GenerateSchemaFiles combined with IncludeCustomObjects enables you to generate a schema containing both custom fields and objects.