Skip to main content

Data Source

Follow the instructions below to create a new data flow that ingests data from an Oracle PBCS source in Nexla.
orpbcs_api.png

Oracle PBCS

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the Oracle PBCS connector tile from the list of available connectors. Then, select the credential that will be used to connect to your Oracle PBCS account, and click Next; or, create a new Oracle PBCS credential for use in this flow.

  3. In Nexla, Oracle PBCS data sources can be created using pre-built endpoint templates, which expedite source setup for common Oracle PBCS endpoints. Each template is designed specifically for the corresponding Oracle PBCS endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    Oracle PBCS sources can also be configured manually, allowing you to ingest data from Oracle PBCS endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Oracle PBCS endpoints. Each template is designed specifically for the corresponding Oracle PBCS endpoint, making data source setup easy and efficient.

Endpoint Settings​

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

    Get API Versions

    This endpoint template returns information about which REST APIs are available and supported in your Oracle PBCS instance. Multiple versions may be supported simultaneously. Use this template when you need to discover available API versions before using other Oracle PBCS endpoints.

    • This endpoint automatically retrieves all available API versions from your Oracle PBCS instance. No additional configuration is required beyond selecting this endpoint template.

    This endpoint returns information about which REST APIs are available and supported in your Oracle PBCS instance. The response includes details about available API versions, which can be used with other Oracle PBCS endpoints that require an API version parameter.

    For detailed information about API versions, API access, and available endpoints, see the Oracle EPM REST API documentation.

    Migration API: Get all Files

    This endpoint template lists the files in the Planning repository and returns information about the available file and application snapshots. Use this template when you need to discover available files and snapshots before downloading them.

    • Enter the API version in the API Version field. This should be the API version you want to use for this request (e.g., v11, v12). The API version determines which version of the Oracle PBCS API will be used. You can find available API versions by using the "Get API Versions" endpoint.

    This endpoint lists the files in the Planning repository and returns information about available file and application snapshots. The response includes file names, snapshot names, and other metadata that can be used with the "Migration API: Download File Content" endpoint to download specific files.

    For detailed information about file management, API response structures, and available file data, see the Oracle EPM REST API documentation.

    Migration API: Download File Content

    This endpoint template downloads a file from the repository to the local environment. Use this template when you need to download specific files or application snapshots from your Oracle PBCS Planning repository.

    • Enter the API version in the API Version field. This should be the API version you want to use for this request (e.g., v11, v12). The API version determines which version of the Oracle PBCS API will be used.
    • Enter the application snapshot name or file name in the Application Snapshot Name or File Name field. This should be the name of the snapshot or file you want to download (e.g., Artifact Snapshot or s112.csv). The snapshot or file name determines which file will be downloaded from the repository.
    • Select the file content type from the File Content Type pulldown menu. Available options include CSV, JSON, Text, XML, and ZIP file. If the file is a zip file, select the content type of the unzipped files. The file content type determines how the downloaded file will be processed.

    This endpoint downloads a file from the Planning repository to the local environment. If the content type of the response is application/JSON, then an error with details is displayed on the server. Otherwise, the content of the file is streamed through the response. The endpoint supports various file types including CSV, JSON, Text, XML, and ZIP files.

    For detailed information about file downloads, API response structures, and available file types, see the Oracle EPM REST API documentation.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually​

Oracle PBCS data sources can be manually configured to ingest data from any valid Oracle PBCS API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex Oracle PBCS sources, such as sources that use chained API calls to fetch related data or sources that require custom query parameters or headers.

API Method​

  1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Oracle PBCS API from the Method pulldown menu. Oracle PBCS API typically uses GET method for retrieving data from endpoints.

API Endpoint URL​

  1. Enter the URL of the Oracle PBCS API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including your base URL (from your credential), the API path (e.g., /interop/rest, /interop/rest/v11/applicationsnapshots), and any required query parameters. Include any required query parameters in the URL.

Ensure the API endpoint URL is correct and accessible with your current credentials. The Oracle PBCS API endpoint URL should include your base URL and the appropriate API path. You can test the endpoint using the Test button after configuring the URL.

Response Data Path​

  1. Enter the JSONPath expression in the Response Data Path field to specify which part of the API response should be treated as the relevant data by Nexla. For Oracle PBCS API responses, use $.items[*] to extract all items from the items array, depending on your endpoint.

The JSONPath expression must correctly reference the structure of your Oracle PBCS API response. Oracle PBCS API responses may have different structures depending on the endpoint. Ensure your JSONPath expression matches the structure returned by your specific endpoint. The JSONPath expression determines which data will be extracted and processed by Nexla.

Save the Data Source​

  1. Once all of the relevant steps in the above sections have been completed, click the Next button to proceed with the rest of the data flow configuration, or click Save to save the data source configuration for later use.