Skip to main content

Configure the Studio for Petrel Extractor

To configure the Studio for Petrel extractor, you must create a configuration file. This file must be in YAML format. The configuration file is split into sections, each represented by a top-level entry in the YAML format.

You can use the sample minimal configuration file as a starting point for your configuration settings.

You can also use substitutions with environment variables in the configuration files. The values wrapped in ${} are replaced with environment variables with that name. For example, ${COGNITE_PROJECT} will be replaced with the value of the environment variable called COGNITE_PROJECT.

`idp-authentication`:
project: ${COGNITE_PROJECT}
idp-authentication:
tenant: ${COGNITE_TENANT_ID}
client-id: ${COGNITE_CLIENT_ID}
secret: ${COGNITE_CLIENT_SECRET}
scopes:
- ${COGNITE_SCOPE}

Cognite

Include the cognite section to configure which CDF project the extractor will load data into and how to connect to the project. This section is mandatory and should always contain the project and authentication configuration.

ParameterDescription
cdf-file-storageSet the cloud blob storage engine that will store Petrel data objects. Valid options are azure and google.
cdf-base-urlInsert the base URL of the CDF project. The default value is https://api.cognitedata.com.
cdf-projectInsert the CDF project name you want to ingest data into.
cdf-api-keyWe've deprecated API-key authentication and strongly encourage customers to migrate to authentication with IdP.
cdf-oidc-authorityInsert the credentials for authenticating to CDF using an external identity provider. You must enter either an API key or use IdP authentication.
cdf-oidc-client-idEnter the client ID from the IdP.
cdf-oidc-secretEnter the client secret from the IdP.
cdf-oidc-tenantEnter the Azure tenant.
cdf-oidc-scopesList the scopes.
cdf-raw-databaseEnter the CDF RAW database name that will store Studio for Petrel objects state store. If the database doesn't already exist, the extractor creates a database.
data-set-idEnter the data set ID for the CDF Files. Set to 0 or no value if you don't want to add a data set ID.
state-dbSelect which database to store the extractor state. If you don't use this parameter, the extractor uses an in-memory state store.
api-version-cacheBefore the extractor serializes a record from Studio for Petrel, a call goes to the API to verify if the object has been loaded. This cache holds the last state for quicker restarts. The default value is state\api-version-cache.dat"

Cache

Include the cache section to enable or disable caching of data to disk. Use these parameters to avoid intermittent failures.

ParameterDescription
enable-cacheSet to true to enable caching of data to disk and avoid intermittent failures.
cache-locationSet the path to store cached objects. You can specify this as
  • C:\cache - fully qualified
  • cache - relative to the installation folder.

  • If the remaining disk space is less than 10 GB, caching is automatically turned off. You need Modify permissions on the folder.

    Logging

    Include the logging section to set up logging to a standard output, such as a terminal window.

    ParameterDescription
    log-to-consoleSet to true to log to a console. This parameter is used if you're running the extractor from a terminal, such as Powershell.
    log-to-fileSet to true to log to a file.
    log-filenameAdd a prefix string in the name for the generated log files. This is an optional parameter.
    retentionSpecify the maximum number of days the log files are retained in the log folder.
    levelSelect the verbosity level for logging. Valid options are verbose, debug, information, warning, error, fatal. The default value is information.

    Petrel-studio

    Include the petrel-studio section to configure the connection to Studio for Petrel.

    ParameterDescription
    serverInsert the hostname or IP address of the Studio for Petrel server.
    license-serverIf you're running the extractor as a Windows service, uncomment and specify the license server if the environment variable SLBSLS_LICENSE_FILE isn't set or unavailable.
    ProviderEnter the name of the database type, such as Oracle or SQL Server. The default value is SQL Server.
    PortInsert the SQL server port. The default value is 1433.
    use-integrated-securitySet to true to use Windows integrated security to authenticate to Studio for Petrel server. The default value is false.
    usernameEnter the username to Studio for Petrel if you're not using integrated security.
    passwordEnter the password to Studio for Petrel if you're not using integrated security.
    data-source-nameInsert the Studio for Petrel data source name.
    service-nameEnter the service name if this is specified in the data source.
    node-idNode ID - string. The default value is 1.
    throttle-timeInsert the time in milliseconds to wait between pulling data. The default value is 1000.
    operation-modeSelect an operation mode:
    1. Extract all objects, but limited by primary-batch-size. This is the default value.
    2. Extract only objects with business tags or a valid data status but limited by primary-batch-size.
    3. Extract first objects with business tags or a valid data status, limited by primary-batch-size, then extract any objects limited by secondary-batch-size.
    primary-batch-sizeLimit the number of objects to extract from an object type before moving to the next type. The valid range is from 0 to 10000. The default value is 0, indicating no limit.
    secondary-batch-sizeLimit the number of objects to extract from an object type before moving to the next type. The valid range is from 0 to 10000. The default value is 0, indicating no limit.
    connector-instanceEnter the connector instance name or ID to configure studio repositories to extract data from on the API side. If you set repositories in configuration here, it overrides the configured repositories in the API.
    repositoriesEnter the Studio for Petrel repositories to extract data from.
    data-typesList the Petrel data types to be sent to CDF. An example list is available here.