Primeur Online Docs
Data Shaper
Data Shaper
  • 🚀GETTING STARTED
    • What is Primeur Data Shaper
      • What is the Data Shaper Designer
      • What is the Data Shaper Server
      • What is the Data Shaper Cluster
    • How does the Data Shaper Designer work
      • Designer Views and Graphs
      • Data Shaper Graphs
      • Designer Projects and Sandboxes
      • Data Shaper Designer Reference
    • How do the Data Shaper Server and Cluster work
      • Data Shaper Server and Cluster
      • Data Shaper Server Reference
    • VFS Graph Components
      • DataOneFileDescriptor (DOFD) metadata
      • Passing parameters from Data One Contract to Data Shaper graph
      • Inheriting Data One context attributes in Data Shaper graph
  • DATA SHAPER DESIGNER
    • Configuration
      • Runtime configuration
        • Logging
        • Master Password
        • User Classpath
      • Data Shaper Server Integration
      • Execution monitoring
      • Java configuration
      • Engine configuration
      • Refresh Operation
    • Designer User Interface
      • Graph Editor with Palette of Components
      • Project Explorer Pane
      • Outline Pane
      • Tabs Pane
      • Execution Tab
      • Keyboard Shortcuts
    • Projects
      • Creating Data Shaper projects
      • Converting Data Shaper projects
      • Structure of Data Shaper projects
      • Versioning of server project content
      • Working with Data Shaper Server Projects
      • Project configuration
    • Graphs
      • Creating an empty graph
      • Creating a simple graph
        • Placing Components
        • Placing Components from Palette
        • Connecting Components with Edges
    • Execution
      • Successful Graph Execution
      • Run configuration
      • Connecting to a running job
      • Graph states
    • Common dialogs
      • URL file dialog
      • Edit Value dialog
      • Open Type dialog
    • Import
      • Import Data Shaper projects
      • Import from Data Shaper server sandbox
      • Import graphs
      • Import metadata
    • Export
      • Export graphs to HTML
      • Export to Data Shaper Server sandbox
      • Export image
      • Export Project as Library
    • Graph tracking
      • Changing record count font size
    • Search functionality
    • Working with Data Shaper server
      • Data Shaper server project basic principles
      • Connecting via HTTP
      • Connecting via HTTPS
      • Connecting via Proxy Server
    • Graph components
      • Adding components
      • Finding components
      • Edit component dialog box
      • Enable/disable component
      • Passing data through disabled component
      • Common properties of components
      • Specific attribute types
      • Metadata templates
    • Edges
      • Connecting Components with Edges
      • Types of Edges
      • Assigning Metadata to Edges
      • Colors of Edges
      • Debugging Edges
      • Edge Memory Allocation
    • Metadata
      • Records and Fields
        • Record Types
        • Data Types in Metadata
        • Data Formats
        • Locale and Locale Sensitivity
        • Time Zone
        • Autofilling Functions
      • Metadata Types
        • Internal Metadata
        • External (Shared) Metadata
        • SQL Query Metadata
        • Reading Metadata from Special Sources
      • Auto-propagated Metadata
        • Sources of Auto-Propagated Metadata
        • Explicitly Propagated Metadata
        • Priorities of Metadata
        • Propagation of SQL Query Metadata
      • Creating Metadata
        • Extracting Metadata from a Flat File
        • Extracting Metadata from an XLS(X) File
        • Extracting Metadata from a Database
        • Extracting Metadata from a DBase File
        • Extracting Metadata from Salesforce
        • SQL Query Metadata
        • User Defined Metadata
      • Merging Existing Metadata
      • Creating Database Table from Metadata and Database Connection
      • Metadata Editor
        • Opening Metadata Editor
        • Basics of Metadata Editor
        • Record Pane
        • Field Name vs. Label vs. Description
        • Details Pane
      • Changing and Defining Delimiters
      • Editing Metadata in the Source Code
      • Multi-value Fields
        • Lists and Maps Support in Components
        • Joining on multivalue fields (Comparison Rules)
    • Connections
      • Database Connections
        • Internal Database Connections
        • External (Shared) Database Connections
        • Database Connections Properties
        • Encryption of Access Password
        • Browsing Database and Extracting Metadata from Database Tables
        • Windows Authentication on Microsoft SQL Server
        • Snowflake Connection
        • Hive Connection
        • Troubleshooting
      • JMS Connections
      • QuickBase Connections
      • Hadoop Connections
      • Kafka Connections
      • OAuth2 Connections
      • MongoDB Connections
      • Salesforce Connections
    • Lookup Tables
      • Lookup Tables in Cluster Environment
      • Internal Lookup Tables
      • External (Shared) Lookup Tables
      • Types of Lookup Tables
    • Sequences
      • Persistent Sequences
      • Non Persistent Sequences
      • Internal Sequences
      • External (Shared) Sequences
      • Editing a Sequence
      • Sequences in Cluster Environment
    • Parameters
      • Internal Parameters
      • External (Shared) Parameters
      • Secure Graph Parameters
      • Graph Parameter Editor
      • Secure Graph Parameters
      • Parameters with CTL2 Expressions (Dynamic Parameters)
      • Environment Variables
      • Canonicalizing File Paths
      • Using Parameters
    • Internal/External Graph Elements
    • Dictionary
      • Creating a Dictionary
      • Using a Dictionary in Graphs
    • Execution Properties
    • Notes in Graphs
      • Placing Notes into Graph
      • Resizing Notes
      • Editing Notes
      • Formatted Text
      • Links from Notes
      • Folding Notes
      • Notes Properties
    • Transformations
      • Defining Transformations
      • Transform Editor
      • Common Java Interfaces
    • Data Partitioning (Parallel Running)
    • Data Partitioning in Cluster
      • High Availability
      • Scalability
      • Graph Allocation Examples
      • Example of Distributed Execution
      • Remote Edges
    • Readers
      • Common Properties of Readers
      • ComplexDataReader
      • DatabaseReader
      • DataGenerator
      • DataOneVFSReader
      • EDIFACTReader
      • FlatFileReader
      • JSONExtract
      • JSONReader
      • LDAPReader
      • MultiLevelReader
      • SpreadsheetDataReader
      • UniversalDataReader
      • X12Reader
      • XMLExtract
      • XMLReader
      • XMLXPathReader
    • Writers
      • Common Properties of Writers
      • DatabaseWriter
      • DataOneVFSWriter
      • EDIFACTWriter
      • FlatFileWriter
      • JSONWriter
      • LDAPWriter
      • SpreadsheetDataWriter
      • HIDDEN StructuredDataWriter
      • HIDDEN TableauWriter
      • Trash
      • UniversalDataWriter
      • X12Writer
      • XMLWriter
    • Transformers
      • Common Properties of Transformers
      • Aggregate
      • Concatenate
      • DataIntersection
      • DataSampler
      • Dedup
      • Denormalizer
      • ExtSort
      • FastSort
      • Filter
      • Map
      • Merge
      • MetaPivot
      • Normalizer
      • Partition
      • Pivot
      • Rollup
      • SimpleCopy
      • SimpleGather
      • SortWithinGroups
      • XSLTransformer
    • Joiners
      • Common Properties of Joiners
      • Combine
      • CrossJoin
      • DBJoin
      • ExtHashJoin
      • ExtMergeJoin
      • LookupJoin
      • RelationalJoin
    • Others
      • Common Properties of Others
      • CheckForeignKey
      • DBExecute
      • HTTPConnector
      • LookupTableReaderWriter
      • WebServiceClient
    • CTL2 - Data Shaper Transformation Language
    • Language Reference
      • Program Structure
      • Comments
      • Import
      • Data Types in CTL2
      • Literals
      • Variables
      • Dictionary in CTL2
      • Operators
      • Simple Statement and Block of Statements
      • Control Statements
      • Error Handling
      • Functions
      • Conditional Fail Expression
      • Accessing Data Records and Fields
      • Mapping
      • Parameters
      • Regular Expressions
    • CTL Debugging
      • Debug Perspective
      • Importing and Exporting Breakpoints
      • Inspecting Variables and Expressions
      • Examples
    • Functions Reference
      • Conversion Functions
      • Date Functions
      • Mathematical Functions
      • String Functions
      • Mapping Functions
      • Container Functions
      • Record Functions (Dynamic Field Access)
      • Miscellaneous Functions
      • Lookup Table Functions
      • Sequence Functions
      • Data Service HTTP Library Functions
      • Custom CTL Functions
      • CTL2 Appendix - List of National-specific Characters
      • HIDDEN Subgraph Functions
    • Tutorial
      • Creating a Transformation Graph
      • Filtering the records
      • Sorting the Records
      • Processing Speed-up with Parallelization
      • Debugging the Java Transformation
  • DATA SHAPER SERVER
    • Introduction
    • Administration
      • Monitoring
    • Using Graphs
      • Job Queue
      • Execution History
      • Job Inspector
    • Cluster
      • Sandboxes in Cluster
      • Troubleshooting
  • Install Data Shaper
    • Install Data Shaper
      • Introduction to Data Shaper installation process
      • Planning Data Shaper installation
      • Data Shaper System Requirements
      • Data Shaper Domain Master Configuration reference
      • Performing Data Shaper initial installation and master configuration
        • Creating database objects for PostgreSQL
        • Creating database objects for Oracle
        • Executing Data Shaper installer
        • Configuring additional firewall rules for Data Shaper
Powered by GitBook
On this page
  • Internal JMS Connections
  • Creating Internal JMS Connections
  • Externalizing Internal JMS Connections
  • Externalizing Multiple JMS Connections at once
  • Exporting Internal JMS Connections
  • External (Shared) JMS Connections
  • Creating External (Shared) JMS Connections
  • Linking External (Shared) JMS Connection
  • Internalizing External (Shared) JMS Connections
  • Edit JMS Connection Wizard
  • Encrypting the Authentication Password
  1. DATA SHAPER DESIGNER
  2. Connections

JMS Connections

PreviousTroubleshootingNextQuickBase Connections

Last updated 1 month ago

JMS Connection serves for receiving and sending JMS messages.

Connections can be:

  • Internal (saved in the graph): See Internal JMS Connection can be created from outline. See . The internal connection can be made usable by other graphs by:

    • Externalization: See .

    • Export: See .

  • External (shared): See . External JMS connection can be created using Edit JMS Connection Wizard. See . To use an external (shared) JMS connection in the current graph you can:

    • Link the connection to the graph: See .

    • Internalize the connection: See .

Note: JMS Connections, metadata, parameters or database connections can be internal or external (shared).

Authentication password can be encrypted using Secure parameters. See or .

Internal JMS Connections

An Internal JMS Connection is a JMS Connection being a part of a graph. The Internal JMS Connection is contained in the graph and can be seen in its source tab.

Creating Internal JMS Connections

The Internal JMS connection is created in the Outline pane.

  1. Right click the Connections group or any connection item.

  2. Select Connections > Create JMS connection.

  3. The Edit JMS connection wizard opens. Here, you can define the JMS connection. Both the wizard and the instructions on setting up the connection are described in .

Externalizing Internal JMS Connections

Any existing Internal JMS Connection can be converted (externalized) to the External JMS Connection. This gives you the ability to use the same JMS connection across multiple graphs.

How to Externalize JMS Connection

  1. Right-click an internal connection item in the Outline pane and select Externalize connection from the context menu.

  2. A new wizard will be opened. The wizard offers location for the new external (shared) connection configuration file in conn directory of your project and file name for external JMS Connection. If a file with the connection file name already exists, you can change the suggested name of the connection configuration file.

  3. Finish the wizard by clicking the OK button.

  4. A new configuration file appears in the conn subfolder of the project (visible in the Project Explorer pane). Internal connection item in the Outline pane is converted to link to the newly created external (shared) connection.

Externalizing Multiple JMS Connections at once

You can even externalize multiple internal connection items at once.

  1. Choose JMS Connections to be externalized in the Outline pane.

  2. Right-click and select Externalize connection from the context menu.

  3. A new wizard will be opened. The wizard offers the conn folder of your project as the location for the first of the selected internal connection items.

  4. Click the OK button to continue.

  5. The same wizard will be opened for each of the selected connection items until all selected connections are externalized. The wizard works in the same way as when externalizing a single connection.

Hint!

To choose adjacent connection items press Shift and move the Down Cursor or the Up Cursor key. To choose non-adjacent items, use Ctrl+Click at each of the desired connection items instead.

The same approach is valid for both database and JMS connections.

Exporting Internal JMS Connections

This case is somewhat similar to that of externalizing an internal JMS connection. But, while you create a connection configuration file that is outside the graph in the same way as externalizing, the file is not linked to the original graph. Only the connection configuration file is being created.

You can use such a file for more graphs as an external (shared) connection configuration file as mentioned in the previous sections.

How to Export JMS Connection

  1. Choose JMS Connection in Outline.

  2. Right-click and choose Export connection.

  3. After the export of JMS Connection the Outline pane connection folder remains the same. The newly created connection configuration file appears in the conn directory in the Project Explorer pane.

Exporting multiple selected internal JMS connections is analogous to externalizing multiple JMS connections described in the previous section.

External (Shared) JMS Connections

External (shared) JMS connections are connections usable across multiple graphs. The external connections are stored outside the graph and that is why they can be shared.

Creating External (Shared) JMS Connections

  1. To create an external (shared) JMS connection select File > New Other.

  2. Select Data Shaper > Connection > JMS connection item.

  3. When all properties of the connection has been set, you can validate your connection using the Validate connection button.

  4. Choose the project, its conn subfolder, choose the name for your external JMS connection file.

  5. Click the OK button to finish the wizard.

Linking External (Shared) JMS Connection

Existing external (shared) connections can be linked to any graph you would like to use them in.

  1. Right-click either the Connections group or any of its items.

  2. Select Connections > Link JMS connection from the context menu.

  3. URL Dialog has been opened. Expand the conn folder in the dialog and choose the desired connection configuration file. You can link multiple external (shared) connection configuration files at once: select multiple connection files in the dialog.

The same approach is valid for linking of both the database and JMS connections.

Internalizing External (Shared) JMS Connections

Any shared (external) JMS Connection can be internalized (converted to the internal connection). To internalize Exported JMS Connections link the JMS Connection to the graph first.

How to Internalize Exported JMS Connection

  1. Right-click a linked external (shared) connection item in the Outline pane.

  2. Select Internalize connection from the context menu.

  3. The selected JMS Connection in the outline have been converted from external to internal. The file with External JMS Connection stays unaffected.

You can even internalize multiple linked external (shared) connection configuration files at once. To do this, select the desired linked external (shared) connection items in the Outline pane.

You can select adjacent items when you press Shift and then the Down Cursor or the Up Cursor key. If you want to select non-adjacent items, use Ctrl+Click at each of the desired items instead.

However, the original external (shared) connection configuration files still remain to exist in the conn subfolder (visible in the Project Explorer pane).

The same approach is valid for linking of both the database and JMS connections.

Edit JMS Connection Wizard

Edit JMS Connection dialog enables to set up JMS connection.

The Edit JMS connection wizard contains eight text areas that must be filled:

  • Name - name of the connection

  • Initial ctx [context] factory class - fully qualified name of the factory class creating the initial context

  • Libraries - use the plus button to add libraries

  • URL

  • Connection factory JNDI name - implements javax.jms.ConnectionFactory interface

  • Destination JNDI - implements javax.jms.Destination interface

  • User - your authentication username

  • Password - password to receive and/or produce the messages

  • Validate connection - Validates the connection. The connection is validated locally even if the project is remote.

If you are creating the external (shared) JMS connection, you must select a filename for this external (shared) JMS connection and its location.

Encrypting the Authentication Password

It is recommended to encrypt your authentication passwords. Otherwise, it remains stored and visible in the configuration file (shared connection) or in the graph itself (internal connection). Thus, the authentication password could be seen in one of these two locations.

Use the wizard in the same way as in the case of .

The Edit JMS connection wizard opens. See .

The dialog can be opened from Outline Pane (See ) or from Project Explorer (See ).

The authentication password can be encrypted using Secure Parameters. Encrypt the password and store the encrypted value in the graph parameter. The parameter has to be marked as secure. See .

Secure Graph Parameters
Secure Graph Parameters
Internal JMS Connections
Creating Internal JMS Connections
Externalizing Internal JMS Connections
Exporting Internal JMS Connections
External (Shared) JMS Connections
Creating External (Shared) JMS Connections
Linking External (Shared) JMS Connection
Internalizing External (Shared) JMS Connections
Encrypting the Authentication Password
Edit JMS Connection Wizard
externalization of JMS connection
Edit JMS Connection Wizard
Creating Internal JMS Connections
Creating External (Shared) JMS Connections