ETL+ Job Page

Owned by Cortlandt _
Oct 06, 2023
8 min read

xxxx Job List panel xx|xx Job Steps panel xx|xx Job Properties panel x

Job Overview

A Job (formerly known as a Refresh Batch) allows the on-demand or on-schedule data loading of one or more data warehouse tables and/or running scripts in a certain order.

For instance, a Job loads sales and CRM tables, and refreshes the Sales Tableau Extract overnight; another Job refreshes GL tables and the Financials Tableau Extract every hour.

Jobs are shown in the Job List panel and the Job’s steps are shown in the Job Steps Panel.

The Job page is accessible from https://dataself.atlassian.net/wiki/spaces/ETL202208/pages/2032239184 .

  1. Find. Click to open the search box. (shortcut: Ctrl + F)

  2. Log. Click to open the ETL Log page. (shortcut Ctrl + G)

  3. Help. Click to open documentation for this ETL+ page in a web browser (shortcut F1)

  4. Settings. Click to open the Settings page.

  5. Version number: format: vYYYY.MM.DDBB.

    • Example: v2022.08.2901 means the 1st build on 08/29/2022.

  6. ETL+ User name for the current session.

  7. Back. Click to close this page and go back to the ETL page.
    To close without saving changes click Back and click Yes to the Leave without saving? prompt.

  8. Save. Click to save changes (shortcut Ctrl + S).

    • An asterisk indicates there are unsaved changes.

  9. Job List panel.

  10. Job Steps Panel

Job List Panel

  • ID: Job ID. Assigned by ETL+. Use this ID when running the job from a Window command line or shortcut.

  • Status. See Job Properties panel.

    • App Icon: Which App (DataSelf Agent or Windows Task Scheduler) has been assigned to run the Job on a schedule (if configured).

    • Agent Status: Offline, Ready, Running, Stopping, Disabled.

  • Load. Shows the setting of the Load type selected in the Job Properties panel.

    • Default: Uses the Load Type configuration on the ETL+ main page.

    • Forced Load All: Forces the job’s data warehouse tables to Load All. Example: A Job executes the default delta load of a table every hour, and another Job executes a Load All on this table overnight.
      Learn more at https://dataself.atlassian.net/wiki/spaces/ETL202208/pages/2032239737 .

  • Name. Job’s name. Double-click on a name to edit it (or use shortcut F2). By default:

    • The Job name is: DataSelf <entity-id> #<job-id>

    • When creating WTS tasks via ETL+, the task is named with this name.

    • When creating Windows shortcuts via ETL+, the shortcut is named with this name.

Button Icons and Actions

  • Run Job.

  • Add Job.

  • Job Properties. Opens Job Properties panel.

  • More Actions:

    • Run Job via Agent. If Agent is in Ready status, runs the Job via the Agent.

    • End Job. Stops the job on the selected row if it is currently running.

    • Rename Job (or shortcut F2).

    • Delete Job.

    • Create Win Shortcut. Creates a Windows Shortcut to execute the job. Creates the shortcut in the Windows folder where ETL+ is installed. Learn more at: https://dataself.atlassian.net/wiki/spaces/ETL202208/pages/2032245694

  • Start at. Summary of when the Job is scheduled to run.

  • Job Icons / Actions:

    • Refresh Job Status. Reloads Job List information.

    • Expand / Collapse. Click Expand to view additional Job List columns:

  • Last Run. Date-time of the last run.

  • Next Run. Date-time of next scheduled run.

  • Server. The MS Windows Server Name where the Job App is running (if applicable).

Job Steps Panel

Defines the steps for each job, including ETL+ Objects, and the maintenance of the following scripts: Tableau Extracts Refresh, Command Line, and Cloud Script.

This panel lists the steps, in the order of execution, that belong to the selected job on the Job List panel to the left. In other words, running a job from the Job List panel will execute the checked step in the Job Steps panel in the listed order.

  1. Step Checkboxes: Use the checkboxes to select the objects that will be executed by the job in the Job List panel.

  2. Object Type. The icon indicates the type of object in the row.

  3. Object Name: Lists the names of each ETL+ object.

  4. Job Icons / Actions:

    1. Move to Top or Move to Bottom. Changes the order of execution of the steps. Select a step and click to move it to the top or bottom of the list.

    2. Move Up or Move Down. Select a step and click to move the step up or down one row.

    3. Add Script: Click to open the pop-up script selection panel. Select one of the options and follow the prompts. For more see Type of Job Steps below.

    4. Delete Script. Select a step and click Delete Script to delete it.

    5. Run Script. Select a step and click Run Script to execute it.

    6. Script Properties. Select a step and click to change it’s properties. For more see Type of Job Steps below.

Types of Job Steps

Data Warehouse Tables

The tables are defined on thehttps://dataself.atlassian.net/wiki/spaces/ETL202208/pages/2032239184 .

Command Line Script

Runs a command line script on the computer where ETL+ is running.

Cloud Script

Runs a DataSelf Cloud Script (typically for running Tableau, Python and other data extractions or Automatic Distribution scripts). Contact DataSelf to discuss.

  • Enter the Script name.

  • When triggered, this runs the following on the dw3 cloud server:
    “C:\DataSelf\CloudScript\<EntityID>_<ScriptName>.bat”. (DataSelf dw3 cloud server)

Download to CSV

Downloads the data with the selected step into a .CSV file.

  • ETL+ assigns the Windows folder the file will download into.

Tableau Extract Refresh

Allows the refresh of Tableau Extracts directly from ETL+ either manually or as part of Jobs.

Currently, this feature only works when the Tableau Server and the data warehouse are hosted by DataSelf.

  • Extract Name. Name of an existing Tableau Extract.

  • Project (optional). Leave blank if the data source is stored in the Tableau Project with the same name as <ETL+ EntityID>.

  • Parent Project (optional). Leave blank if data sources are NOT stored in a Tableau sub-project.

  • Tableau Site (optional). Leave blank if your Tableau site = ETL+ EntityID.

  • This version assumes the Tableau Extracts are at:

Tableau Extract Refresh When Tableau is Hosted in a Private-cloud, On-premise or Online

Top of page xx|xx Job List panel xx|xx Job Steps panel xx

Properties

The Properties panel allows the configuration of a Job’s schedule, the Load Type of its data warehouse tables, and what App (application) runs the schedule.

Schedule. Enter the parameters to define if and how often the Job should run a schedule.

Load type

App. Defines what App (application) runs the Job’s schedule:

  • DataSelf Agent (Recommended): https://dataself.atlassian.net/wiki/spaces/ETL202208/pages/2032239065 provides a secure, easy, and powerful method to run Job schedules. It also provides remote ETL+ Job management:

    • Changes to Job properties become effective immediately, for instance, changing the schedule, load type, and which Agent runs a schedule.

    • Running or stopping a Job on demand.

  • Windows Task Scheduler (WTS): This allows users to create/overwrite WTS tasks to run ETL+ Jobs.

    • Once a WTS Job task is created on a server, changes to its schedule can only be done by overwriting the task via ETL+ or changing the schedule directly in WTS.

    • WTS tasks running ETL+ jobs can also be maintained directly in WTS.

    • Use this option if you want to run ETL+ Jobs with other scheduling apps such as MS SQL Agent.

App Setup for new ETL+ Installations

Case 1: The ETL+ installation will NOT run scheduled Jobs: There’s no need to set up the App.

Case 2: The ETL+ installation will run scheduled Jobs. For setting up this use-case, please open ETL+ with Run as administrator in Windows Explorer.

Recommended App: ETL+ Agent

  • Select Deploy the Agent on this device (<device name>) on the dropdown list.

    • Configure the Schedule portion as desired.

    • Enter a Windows Admin credential on the right panel. Be sure this user has the password set to “Never expire” (preferably, not a user’s account, but an account to run Windows services).

      • If there are multiple Jobs to run with the same Agent, check the Assign the Agent on this device to all Jobs box.

    • Click Apply.

    • Click Confirm if you receive Windows Security Account prompts.

Alternative App: WTS

  • Select WTS on the dropdown list.

    • Configure the Schedule portion as desired.

    • Enter a Windows Admin credential on the right panel. Be sure this user has the password set to “Never expire” (preferably, not a user’s account, but an account to run Windows services).

    • Click Apply.

    • Confirm if you receive Windows Security Account prompts.

 

Access this ETL+ page (window) from https://dataself.atlassian.net/wiki/spaces/ETL202208/pages/2032239184

Related Pages

 

v2022.08