OnBase Scope - Activities - Foundation 23.2 - Foundation 23.2 - Ready - Hyland RPA - external - Hyland-RPA/Activities/Foundation-23.2/Hyland-RPA-Activities/Hyland/OnBase/OnBase-Scope - 2025-04-03

Hyland RPA Activities

Platform
Hyland RPA
Product
Activities
Release
Foundation 23.2
License

Description

Activity that is used to connect to the OnBase REST API and Hyland Identity Provider (IdP). This is a scope activity for all other OnBase activities. It makes sure that all OnBase activities that are placed inside the scope can connect and authenticate to the REST API.

Properties

Analyst

  • Description: Optional text for documentation purposes.

Common

  • Continue On Error: Continues the execution of the workflow even if an error occurs during the execution of the activity.

  • Disable Log: Disables the logging functionality for this activity.

  • Disable Protocol: Disables the protocol functionality for this activity.

  • Timeout: Duration in milliseconds in which the activity tries to execute.

Expert

  • Connection: Optional output of the connection. If this property is set, use the DisposeActivity to close the existing connection later. If this property is not set, the OnBase Scope Activity will close the connection automatically.
  • Existing Connection: An existing connection that can be retrieved from another OnBase Scope Activity.

Input

  • ClientID: ID of the client that is used for authentication. This value can be managed in the IdP admin pane (for example https://<SERVERNAME>/identityprovider/admin).
  • Client Secret: ("Unhashed") Secret of the client that is used for authentication. This value can be managed in the IdP admin pane.
  • Identity Provider Tenant: Name of the Tenant that is going to be used. This value can be managed in the IdP admin pane.
  • Identity Provider URL: URL of the IdP server from which a token for the OnBase REST API will be requested (for example https://<SERVERNAME>/identityprovider)
  • Password: OnBase user password that is used for authentication.
  • URL: URL of the OnBase REST API (for example https://<SERVERNAME>/apiserver/onbase/core/)
  • Username: OnBase username that is used for authentication.

Tips and Tricks

  • Hyland IdP and OnBase REST API server will need to be installed and running for the OnBase scope activity to work.
  • If you are using self-signed certificates on the IdP and OnBase REST API server during testing make sure the client you are running the OnBase activities on trust these certificates (for example, by adding the certificate to the trusted certificates of the operating system and making sure to use the correct host name in the URL and Identity Provider URL properties).