Using JAMS Connections

Follow

What are JAMS Connections?

JAMS Connections are objects stored inside the Connection Store, which is available in JAMS Version 7.1.389 and higher.

The JAMS Connection Store can be utilized to store Connections for various connection types. In the article, you will learn about the following:

Database Connections

Oracle

SQL Server

File Transfer Connections

FTP/SFTP/SCP

Mailbox Connections

IMAP/POP3/EWS

 

You will also learn how to use Connections with the Properties, Source, or Triggers of a Job.

Adding a Connection to the Properties, Source or Triggers of a Job

 

ConnectType.png

 


 

Using the JAMS Connection Store

The JAMS Connection Store can be accessed from the Home screen by selecting the "Create a Connection" or within the Shortcut menu.

Home.png

Selecting the Connection Store Shortcut in the Shortcut menu allows for either adding a new connection or viewing an existing connection.

AddorView.png


 

Adding an Oracle Connection Store Definition

  1. From the Common Activities pane within the Home screen, choose "Create a Connection" or choose the the "Connection Store" icon from the Shortcuts menu. If the Shortcut is selected use the "+" sign in the blue ribbon bar to add a new Connection.
    JAMSHome.png
  2. Within the "Add a Connection Definition" dialogue define the Name (i.e. “OraDatabase”), Description (i.e. “Connection for Oracle Server”), and Type of Connection (“Oracle”). Select OK and edit the Connection Object. The Properties Dialogue will open.
    Ora_Connection_Definition.png
  3. Prepare your Oracle Connection String to the Oracle Database. Within the following string, replace the following:
      • HOST with the Banner database host name.
      • SID WITH THE Banner database service name.
(DESCRIPTION = (ADDRESS = (PROTOCOL = TCP)(HOST = <HOST>)(PORT = 1521))(CONNECT_DATA = (SERVICE_NAME = <SID>)));

Note: After updating the HOST and SID, copy the connection string as this will be needed as you update the Connection String field. Use tnsnames. ora as the reference to lookup the required values for the connection string.


4. Edit the Connection Object. Under the Properties Tab, put your Cursor in the Connection String Field. The Oracle Connection Properties will now show. Paste your Connection String in the "Data Source Field"


Note: Do not include Data Source = in the Connection String as JAMS inserts this automatically.


JobPropConnectionString.PNGORCLConnConfPaste.png

5. If you would like to utilize Credentials that are saved within JAMS to access the connection, the Credential information can be added in the "Credential" field via the drop down to select a Credential saved in JAMS. The connection can be tested by selecting "Test Connection."
TestConn.png


Note: If Oracle Credentials have not yet been saved in JAMS they can be saved by going to the Credentials Shortcut within the JAMS Shortcut Menu in the JAMS Client.


6. After completing your modifications to the Connection String, Data Source, and Credentials, select OK to save your changes.


 

Adding a SQL Server Connection Definition

  1. From the Common Activities pane within the Home screen, choose "Create a Connection" or choose the the "Connection Store" icon from the Shortcuts menu. If the Shortcut is selected use the "+" sign in the blue ribbon bar to add a new Connection.
    JAMSHome.png
  2. Within the "Add a Connection Definition" dialogue define the Name (i.e. “SQLDatabase”), Description (i.e. “Connection for SQL Server”), and Type of Connection (“SQL Server”). Select OK and edit the Connection Object. The Properties Dialogue will open.
    SQLConnType.png
  3. Select the Properties Tab and select a Impersonation User (this is used for testing the Connection String within the Connection String Builder if utilizing Integrated Security).Impersonation.png
  4. The Connection is not limited to just Integrated Security. The types of Connections for SQL are:
  • Integrated Security
  • SQL Authentication
  • Azure Authentication

SQLAuthMeth.png

5. Enter the SQLServer\Instance in the "Server Name" Field (i.e "(local)\JAMSTest"). Select the drop down in the "Database Name" Field to populate a list a Databases on the SQL Instance to select.

SQLDatabase.png

6. The Connection can now be tested utilizing the "Test Connection" Button. Once successful, select "Ok"

TestConnSQL.png

7. On the Properties of this Connection a Credential can be selected to always connect as a particular user that is saved within the JAMS Credential Shortcut found in the Shortcut menu. This can also be overridden on the Job Level.

SQLCreds.png

8. Select Save and Close (Check mark in the upper right hand corner)

SaveSQLDatabase.png


 

Adding a SFTP Connection Definition


Note: The same process can be utilized when creating an FTP or SCP Connection Definition. The only difference would be the Connection "Type"


1. From the Common Activities pane within the Home screen, choose "Create a Connection" or choose the the "Connection Store" icon from the Shortcuts menu. If the Shortcut is selected use the "+" sign in the blue ribbon bar to add a new Connection.
JAMSHome.png

  1. Within the "Add a Connection Definition" dialogue define the Name (i.e. “SFTP Connection”), Description (i.e. “Connection for SFTP Server”), and Type of Connection (“SFTP”). Select OK and edit the Connection Object. The Properties Dialogue will open.

SFTPType.png

2. Select the Properties Tab and define the values for the following fields:

Credentials - Select the SFTP User from the drop down

Address  - Enter the IP Address/Host Name of the SFTP Server in the Address Field

Port - Enter the Port Number for the SFTP Server (by default port 22 is utilized)


Note: Additional Connection details can be configured under the SSH, Compliance, and File Transfer Headings if needed.


3. Select Save and Close (Check mark in the blue ribbon bar)

SFTP_Connection.png


 

Adding an IMAP Connection Definition

From the Common Activities pane within the Home screen, choose "Create a Connection" or choose the the "Connection Store" icon from the Shortcuts menu. If the Shortcut is selected use the "+" sign in the blue ribbon bar to add a new Connection.
JAMSHome.png

  1. Within the "Add a Connection Definition" dialogue define the Name (i.e. “IMAP Connection”), Description (i.e. “Connection for IMAP Server”), and Type of Connection (“IMAP”). Select OK and edit the Connection Object. The Properties Dialogue will open.

IMAP.png

2. Select the Properties Tab and supply the Values for the Following Fields.

Address - Enter the Address of the IMAP Server (i.e "outlook.office365.com")

Port - Enter the Incoming Port Number for the IMAP Server (i.e. "993")

Mail Credentials - Select the Mail Credentials previously saved within the JAMS Credential Shortcut via the drop down

SSL Heading - Select any SSL Settings for the Particular IMAP Server if needed.

IMAP_Connection_Prop.png

3. Select Save and Close (The Check mark in the blue ribbon Bar)


 

Adding a Connection to the Properties, Source or Triggers of a Job.

A Connection can be utilized on the Properties, Source or Triggers within a JAMS Job Definiton. Below you will find some examples.

Oracle Connection

The below example of a JAMS Job utilizes the OracleStoredProc Execution Method. You can define the Oracle Connection Store Defintion within the Connection Store Field under the Source Tab of the job Definition.

OraSP.png

SQL Connection

The below example of a JAMS Job utilizes the SSISDirect Execution Method within JAMS. You can define the SQL Connection in the Stored Connection Field under the Source Tab of the Job Definition.

SSISDirect.png

File Transfer Connection

The below example of a JAMS Job utilizes the FileTransfer Execution Method within JAMS. You can define the File Transfer Connection in the File Transfer Connection Field under the Source Tab of the Job Definition.

Filetransfer.png

Mail Trigger Connection

The below example of a JAMS Job utilizes a Mail Trigger within JAMS. You can define the Mail Trigger Connection in the Mail Server Field within the Mail Trigger Schedule Object of the Job Definition under the Schedule Tab.

IMAPProp.png

Keep in mind that a Connection can also be defined on the Execution Method level to populate the Connection Property of any Job that would utilize that particular Execution Method. Open the Properties of an Execution Method and on the Properties Tab you can add the Connection. If the Connection property is not already visible it may be added by selecting the "Add" Button in the small blue ribbon bar.

AddProp.png

Execution_Method.png

The Property can also be added or overridden at the Folder Level. Any Property dictated at the Folder Level will override the Property on the Execution Method Level and will inherit to every Job Definition within the Folder.

Folder.png

The Property can also be set or overridden on any individual Job within JAMS by accessing the Jobs Properties Tab.

Job.png

 

 

 

Have more questions? Submit a request

Comments