Automating Symitar in JAMS


In This Article:

  • Installing the Symitar Add-on
  • Creating a Symitar Job
  • Defining a Symitar Job using the Workflow Interface
  • Symitar Activities

Installing the Symitar Add-on

If the JAMS Add-on for Symitar is not installed, run the JAMS Installer and check the "JAMS Add-on for Symitar" component in the Feature Selection step.

NOTE: Un Checking other components will uninstall those components.


NOTE: In some installations, the host.config file must be configured in order to allow a machine to access the Symitar server.

Creating a Symitar Job

  1. Create a Job in the Desired folder and choose the Workflow Execution Method
  2. Set notification and run-as options as desired.
  3. Leave the Job Source blank. The Source will be edited after initially saving the Job.
  4. Leave the Job Schedule blank. The Schedule will be set after the Job Source is configured.
  5. On the "Finish adding a new Job" step, check "Edit the Job definition after adding", then click Finish.
  6. JAMS will open the Job Properties. Select the Source tab, and define the Job using the Workflow Interface.
    (Keep reading for more information on the Workflow Interface)
  7. Edit other properties as necessary, then use the Save and Close button to save the Symitar Job. 

Defining a Symitar Job using the Workflow Interface

Workflow Interface

The source for a Symitar Job displays the Workflow Interface. This interface is comprised of three panels: the Toolbox panel, Activity panel, and Properties panel. Symitar Activities can be found in the Toolbox panel, under the "SYM" group. Activities will be used to define the Symitar Job.

Toolbox Panel
The Toolbox Panel contains dozens of grouped Activities that can be used in the workflow. These activities are the building blocks of a Workflow Job. Activities may be used exclusively, or combined with other activities to create a workflow.

Activity Panel
The Activity Panel is the Designer section of the workflow. Drag activities from the toolbox to this area to add them to the workflow, or move those activities around in the workflow window. Right-click on items in this panel to get additional options.

Properties Panel
Shows the available properties of any selected element or activity. The properties of each activity can be quickly set from this panel.

Building Symitar Workflows

A single Symitar Activity can be utilized by dragging one of the available activities from the Toolbox Panel into the Activity Panel and setting the properties for that Activity.

To utilize multiple activities in a workflow, JAMS requires a Parent Activity to contain other activities. Note that JAMS will automatically add "Sequences" to the workflow if another parent activity is not set. Sequences may be nested inside of other Sequences or Parent Activities in a workflow. 

Automatically Add Sequences

  1. With at least one activity in the Activity panel, drag another activity from the toolbox panel to the Activity panel.
  2. Hover the new activity over any existing activity. Grey bars will appear to show possible placement locations.
  3. Release the activity in the desired location. A sequence will be added if necessary.
    Note that moving existing activities will also cause the placement location bars to appear, and will also result in the creation Sequences when necessary.

Passing Parameters to a Symitar Job

Typically, executing a Symitar job involves responding to a series of prompts; for example, what is the job name?. . . the queue?, etc.

A Symitar job may include other prompts that are unique to the job. When starting a Symitar job, if JAMS encounters an unexpected prompt, it looks for a workflow variable/JAMS parameter named "SymParam1". If this parameter is found, JAMS inserts its value as the response to the prompt. However, if this variable/parameter is not found, JAMS uses the default value defined in the Symitar job.

Note: When looking for a “SymParam”, JAMS searches first for a Workflow variable with that name. If that variable doesn’t exist, it then looks for a JAMS Parameter with that name. Each time JAMS looks for a parameter it increments the number, so the second parameter would be "SymParam2”, etc.

Symitar Activities

A small overview of properties and function of each Symitar Activity can be found in the Symitar Documentation. When defining Symitar Activities, it is important to keep in mind:

  • Symitar pathways will be case sensitive in UNIX or LINUX environments
  • DateTime values are formatted as YYYYMMDD

Still have questions about Symitar or Workflows? Try watching our JAMS Workflow Video.

Have more questions? Submit a request