3.2.5.2 Configuring output, logging, and properties files

Note:

For information about generating the Client ID and Client Secret values required in user-input.properties, see Create an Integrated (Confidential) Application. This topic explains how to create a Confidential Application in Oracle Identity Domains / IDCS (OCI IAM) and retrieve the credentials needed to generate OAuth tokens for public API calls.

All three environment variables below are mandatory — earlier default fallback paths (conf/pbsm-automate.props, ./pbsm-automate.out, ./pbsm-automate.log) have been removed. If a variable is unset, empty, or invalid, the utility throws an error and exits before any API call is made. Using distinct paths per environment also lets you run multiple pbsm-automate instances in parallel without their output/log files interfering with each other.

The utility requires the following environment variables:

Table 3-14 Environment Variables

Environment Variable	Value	Behavior
pbsm_automate_props	Absolute path to the properties file	Used to connect to the target tenant environment. Invalid or empty value → error and exit.
pbsm_automate_output	Absolute path to the output file	Holds only the raw JSON response of the last command — not beautified. The file is overwritten on every run. Write-permission is validated before any API call. Invalid or empty value → error and exit.
pbsm_automate_log	Absolute path to the log file	Console log entries are appended, each prefixed with a timestamp. Write-permission is validated before any API call. Invalid or empty value → error and exit.

For example:

pbsm_automate_props='C:\\Users\\user\\Downloads\\user-input.properties'

Example — configuring all three variables (Linux/macOS):

export pbsm_automate_props=./conf/pbsm-prod.props
export pbsm_automate_output=/scratch/pbsm/prod/pbsm-prod.out
export pbsm_automate_log=./log/pbsm-prod.log

The utility returns exit status `0` when an operation succeeds and `1` when it fails.