activities
latest
false
UiPath logo, featuring letters U and I in white
Classic Integrations Activities
Last updated Nov 8, 2024

Jira Scope

UiPath.Jira.Activities.JiraScope

Important: This Jira activity package supports only Jira Cloud instances.

The Jira activities use either OAuth 2.0 or Token Authentication to establish a connection between UiPath and your Jira environment. This connection authorizes a Robot to call the Jira APIs and access resources on your behalf.

For more information and before you build your first automation project, see the Setup guide.

You select the type of authentication that you want to use (Authentication Type) and enter the URL of your Jira server (Server URL) into the Jira Scope activity.

Then enter in either your OAuth Credentials (ClientID and ClientSecret) or your Token Credentials (Api Token and Username) to complete the information needed to establish an authenticated connection to your Jira application.

After establishing a connection, a parent Jira Scope activity can output a record of the connection in a Jira Connection object (Jira Connection) that you can use in subsequent child scope activities.

How it works

The following steps and message sequence diagram is an example of how the activity works from design time (i.e., the activity dependencies and input/output properties) to run time.

  1. Complete the Setup steps.
  2. Add the Jira Scope activity to your project.
  3. Select your Authentication Type and enter value for either your OAuth Authentication or Token Authentication properties.
  4. Create and enter a Jira Connection variable for Output property.
    • You can use this variable in subsequent uses of the Jira Scope activity.



Properties

Authentication
  • Authentication Type - The type of authentication for Jira services. Select one of the three available options: Api Token, OAuth 2.0, or Existing Jira Connection.
  • Server URL - The URL of the Jira site on which the activities operate. This field supports only Strings or String variables.
Common
  • Continue On Error - This field only supports boolean values (True, False). The default value in this field is False. As a result, if this field is blank and an error is thrown, the execution of the project stops. If the value is set to True, the execution of the project continues regardless of any error.
  • DisplayName - The display name of the activity. This field supports only strings or String variables.
Existing Jira Connection
  • Existing Connection - The connection from an existing Jira Scope to use rather than creating a new connection. This field supports only Jira variables.
Misc
  • Private - If selected, the values of variables and arguments are no longer logged at Verbose level.
OAuth 2.0 Authentication
  • Client ID - The Client ID of the Jira application. This field is required only if the selected authentication type is OAuth 2.0. This field supports only String variables.
  • Client Secret - The Client Secret of the Jira application. This field is required only if the selected authentication type is OAuth 2.0. This field supports only SecureString variables.
Output
  • Jira Connection - The authenticated Jira connection, which can be passed to another Jira Scope. This field supports only Jira variables.
Token Authentication
  • API Token - The token generated for your account. This field is required only if the selected authentication type is Api token. This field supports only SecureString variables.
  • Username - Your email address. This field is required only if the selected authentication type is API token. This field supports only String variables.
  • How it works
  • Properties

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.