Organization Configuration

As the system administrator, you can configure organization properties at a global level to affect all organizations or at an organization level to affect a specific organization. Some properties can be overridden by the organization administrator for each organization.

You configure organization properties from the Organizations view:
  • To configure organization properties at a global level to affect all organizations, click the Global Configuration icon in the top toolbar:

  • To configure organization properties at an organization level to affect a specific organization, hover over the organization row, and then click the Configuration icon:

    Note: After you save organization properties for a specific organization, no subsequent change made at the global level applies to this organization.
You can configure the following organization properties:
Organization Property Description
Enable Time Series Analysis Enables Control Hub to store time series data for organizations which users can analyze when monitoring jobs.

When time series analysis is disabled, users can still view the total record count and throughput for a job, but cannot view the data over a period of time. For example, they can’t view the record count for the last five minutes or for the last hour.

Only system administrators can view and change this value.

Maximum number of jobs for the organization Maximum number of jobs in the organization.

Only system administrators can view and change this value.

System limit on the execution engine heartbeat interval Largest value that an organization administrator can set for the maximum number of seconds since the last reported execution engine heartbeat. If the last reported time exceeds this value, Control Hub considers the execution engine - Data Collector, Transformer, or Data Collector Edge - as unresponsive.

Only system administrators can view and change this value.

System limit on the maximum number of job runs Largest value that an organization administrator can set for the maximum number of job runs to retain the job history for.

Only system administrators can view and change this value.

System limit on the maximum number of days before job status history is purged Largest value that an organization administrator can set for the maximum number of days to retain the job history from each retained job run.

Only system administrators can view and change this value.

Maximum number of pipelines for the organization Maximum number of pipelines for the organization.

Only system administrators can view and change this value.

Enable scheduler purge Enables purging the details for scheduled task runs.

Only system administrators can view and change this value.

System limit on the maximum number of scheduler runs Largest value that an organization administrator can set for the maximum number of scheduled task runs to retain the details for.

Only system administrators can view and change this value.

System limit on the maximum number of days before scheduler runs are purged Largest value that an organization administrator can set for the maximum number of days to retain run details for each scheduled task.

Only system administrators can view and change this value.

Disable API Offset and Lengths Check Disables limiting the number of objects retrieved by API requests.

When selected, a single API request can return all results. Clear the property if API requests consume a large amount of resources. In most cases, you do not need to modify this property.

Only system administrators can view and change this value.

Maximum number of Data Collectors in the organization Maximum number of Data Collectors in the organization.

Only system administrators can view and change this value.

Maximum number of users in the organization Maximum number of users in the organization.

Only system administrators can view and change this value.

Disable SAML Backdoor Disables the SAML backdoor for organizations that have enabled SAML authentication.

As a best practice, Control Hub provides a SAML backdoor that allows administrators to log in using Control Hub credentials if the SAML IdP is incorrectly configured and users cannot log in using SAML authentication. SAML providers recommend having a backdoor available for administrators to use to access a locked system.

Disable the backdoor with caution. If disabled and the SAML IdP is incorrectly configured within Control Hub, you must work with StreamSets customer support to resolve the issue.

Only system administrators can view and change this value.

System limit on the maximum number of time series purge days Largest value that an organization administrator can set for the maximum number of days that a job can be inactive before the metrics for that job are deleted.

Only system administrators can view and change this value.

Maximum number of topologies for the organization Maximum number of topologies for the organization.

Only system administrators can view and change this value.

Enable events to trigger subscriptions Enables events so that Control Hub can trigger subscriptions for organizations. Disable events if you do not want users to use subscriptions.

An organization administrator can override this property for an organization.

Enable System Data Collector Enables users to select the system Data Collector as the authoring Data Collector for creating new pipelines.

Enable the system Data Collector as an authoring Data Collector to let users create pipelines when they cannot access a registered Data Collector that meets the requirements for an authoring Data Collector. The system Data Collector cannot be used for data preview or pipeline validation.

Only enable the system Data Collector if the system Data Collector is installed.

Disable the system Data Collector to force users to create pipelines with a registered Data Collector. Designing pipelines using an authoring Data Collector that is a newer version than the execution Data Collector can cause errors.

An organization administrator can override this property for an organization.

Enforce permissions during object access Enables permission enforcement to secure the integrity of organization data. Disable permission enforcement if you want all users in the organization to have full access to all objects.

An organization administrator can override this property for an organization.

Execution engine heartbeat interval Maximum number of seconds since the last reported execution engine heartbeat before Control Hub considers the execution engine - Data Collector, Data Collector Edge, or Transformer - as unresponsive. In most cases, the default value of 300 seconds, or five minutes, is sufficient.

An organization administrator can override this property for an organization.

The maximum value is the corresponding system limit.

Maximum number of days before job status history is purged Maximum number of days to retain the job history from each retained job run.

An organization administrator can override this property for an organization.

The maximum value is the corresponding system limit.

Maximum number of job runs Maximum number of job runs to retain the job history for.

An organization administrator can override this property for an organization.

The maximum value is the corresponding system limit.

Maximum number of scheduler runs Maximum number of scheduled task runs to retain the details for.

An organization administrator can override this property for an organization.

The maximum value is the corresponding system limit.

Maximum number of days before scheduler runs are purged Maximum number of days to retain run details for each scheduled task.

An organization administrator can override this property for an organization.

The maximum value is the corresponding system limit.

Inactivity period for session termination Maximum number of minutes that a user session can remain inactive before timing out.

An organization administrator can override this property for an organization.

Maximum number of days before time series metrics are purged Maximum number of days that a job can be inactive before the metrics for that job are deleted.

An organization administrator can override this property for an organization.

The maximum value is the corresponding system limit.

You can also configure all SAML identity provider (IdP) properties at the global or organization level. An organization administrator can override any of the IdP properties.