Configuring the Jira actor adapter

You configure an adapter in Grid Manager. Adapter configuration determines how the adapter interacts with JIRA. You can configure multiple JIRA adapters with the same adapter type to use different configuration properties. However, each adapter must have a unique name.

You configure an adapter using a form view or an XML view. You can switch to the XML view to configure elements and attributes that are not available as fields on the form view. After you switch to the XML view and save the adapter configuration, you cannot use the form view for editing it later.

Before you start working with the Jira adapter, you must also install and activate AutoPilot-OA-Common_Utilities module on the Grid Manager. For more information, see Common-OA-utilities.

To configure the actor adapter

1. On Grid Manager, go to Manage > Adapters.
2. From the Adapters in Repository list, select the ro-adapter-jira adapter, and click Add to Grid to add it in the Adapters on Grid list.
3. Click Configure.
4. Enter a unique name and an optional description. 
   The default name of the adapter is Jira Adapter.

5. Provide the following information for configuring the adapter. 

   UI label	XML element	Description	Required
   URL	<url>	Specifies the rest API endpoint URL for the JIRA server. Example: https://jira.com/rest/auth/1/session	No
   Username	<username>	Specifies the username required to log in to JIRA.	No
   Password	<password>	Specifies the password.	No
   Request Timeout	<request-timeout>	Specifies the timeout period, in seconds, after which the connection expires. Default value: 60	No
   Character Set	<character-set>	Specifies the supporting CharSet to encode or decode the characters Also called character set, it includes identifiers describing a series of universal characters. Examples: - UTF-8 - Shift_JIS: Japanese character set - Big5: Traditional Chinese character set - ISO-8859-2: ISO character set for Central European languages Note: If you do not specify the supporting character set, the adapter response is parsed based on the character set in the HTTP response header.	No
   None	<signature-properties>	Contains the elements that specify information about the public key (X.509 certificate) and the private key that are used for the digital signature  The <signature-properties> element can contain the mode attribute that specifies the format in which the public (X.509 certificate) and private keys are provided for signing the HTTP request.  You can provide the keys using one of the following formats: Java Keystore (JKS) Privacy Enhanced Mail (PEM) Definite Encoding Rules (DER) files Base64-encoded PEM  Valid values: <signature-properties mode="keystore"> (default) <signature-properties mode="key-files"> <signature-properties mode="key-data">	No
   None	<keystore-file>	Specifies the path to the JKS that contains the client certificate	Conditional; required when the signature mode is keystore
   None	<keystore-password>	Specifies the password to the JKS	Conditional; required when the signature mode is keystore
   None	<private-key-file>	Specifies the file containing the private key, which is used to sign the HTTP request  The adapter supports the following formats: Base64-encoded PEM DER	Conditional; required when the signature mode is key-files
   None	<certificate-file>	Specifies the file containing the public key (X509 Certificate)  The adapter supports the following formats: Base64-encoded PEM DER	Conditional; required when the signature mode is key-files
   None	<private-key-data>	Contains an XML specifying the private key in an Base64-encoded PEM format  For example:  <private-key-data> ---- BEGIN PRIVATE KEY ----  MIICdQIBADANBgkqhkiG9w0  BAQEFAASCAl8wggJbAgEAAo  GBAKomKro6VbW4PeQtUhNz  ZpSH26vbBTBtH1r4EjnIv4vnh  SyyA62ewpROVNn0Spvjo  BFwE88HcX3tXym/zbVgtd  Pke9K+SYHP6CWdiLqn  ........  ---- END PRIVATE KEY ----</private-key-data>	Conditional; required when the signature mode is key-data
   None	<certificate-data>	Contains an XML specifying the public key (X509 Certificate) in an Base64-encoded PEM format  For example:  <certificate-data> ---- BEGIN CERTIFICATE ----  MIICdzCCAeCgAwIBAgIFXseN1xYwDQYJKoZIhvcNAQEFBQ  AwUzELMAkGA1UEBhMCVVMxEzARBgNVBAoTCkFtYXpvbi5jb20x DDAKBgNVBAsTA0FXUzEhMB8GA1UEAxMY  ........  ---- END CERTIFICATE ----</certificate-data>	Conditional; required when the signature mode is key-data
   Download directory	<download-directory>	Specifies the full path where the attached file must be downloaded  Default value: Temporary directory of the Java virtual machine of the peer	No

   Warning

   Note

   You can configure the adapter by specifying only the empty <config /> element, and provide the connection details dynamically in the adapter request later.

6. (Optional) To specify the adapter configuration in an XML, click Switch to XML view and provide the XML configuration that matches your environment. 

   Sample JIRA adapter configuration XML

   <config>
   <url>https://jira.com/rest/auth/1/session<url>
   <user-name>allen</user-name>
   <password>ZFu8cjwQ</password>
   <request-timeout>60</request-timeout>
   </config>
7. Click OK and save the adapter configuration. 
   The newly configured adapter is now listed in the Adapters on Grid list. 

Enabling custom logging

To enable custom logging for the adapter, you must specify a log file name. You can also provide additional parameters for logging.

• Log File Name: Provide a name for the log file.
  This file will be stored in the AO_HOME/tomcat/logs directory. If Log File Max Backup Index value is greater than 0, the log file name is suffixed with the backup index. For example, if the parameter value is a.log, backup log files will have names, such as a.log.1, a.log.2.
• Log File Size: Specify a size limit for the log file. 
  If the value specified for Log File Max Backup Index is greater than 0, when the specified size is reached, the current file is renamed with the suffix .1. Otherwise, the log file will be reset and over-written. The default value is 10MB. The available units are KiloBytes (KB), MegaBytes (MB) or GigaBytes (GB).
• Log File Max Backup Index: Enter the maximum number of backup files allowed. The default value is 10.
• Log File Append: Select this option to append new log information to the existing information in the file. If unselected, the file will be overwritten with new log information.

• Log Level: Enter the logging level using one of the following choices:

  Logging level	Description
  DEBUG	The most detailed logging level; logs low-level messages, normal execution, recoverable erroneous conditions, and unrecoverable erroneous conditions
  INFO (default)	Logs normal execution, recoverable erroneous conditions, and unrecoverable erroneous conditions
  WARN	Logs recoverable erroneous conditions and unrecoverable erroneous conditions
  ERROR	The least detailed logging level; logs only error conditions that are not usually recoverable

Encrypting an element's contents

You can add the attribute secure="true" to an XML adapter element XML view to ensure that the element's contents is encrypted when displayed.