Logo
  1. Potens.io
  2. Magnus
  3. Meet Magnus

Articles > Quick Start

  • Release Notes
  • Introduction
  • Features
  • Quick Start
  • Rich Editor

Login

a. Follow provided link

It is recommended to use Google Chrome browser for the best experience

b. Click Login button

01.png

c. If asked - Sign in with your Google account

02.png

d. While working with Tool, you can be asked for re-authentication

Just click Login button in pop-up and you are done 
or don't forget to Grant Offline Access (next step) 

03.png

Set Default Time Zone

a. The date and time in Magnus UI are displayed in server time zone.

To display the date and time in a different time zone, select the time zone in the dropdown list.  You selection is saved locally in your browser’s cookie.  So if you clear your cookies or use a different device, you will have to select your time zone again. This time zone only affects how the date and time are displayed in Magnus UI.  This does not affect Workflow time zone.  To specify time zone of your Workflows, you need to update the time zone of your Workflow in Workflow Editor.

sh5.png

Grant Offline Access

 a. After authentication is completed you will be presented with below screen

Click Grant Offline Access button
Note: you need to grant offline access only one time when you start working with tool

04a.png

b. Click Accept button in pop-up window

05.png

c. Copy code in yet another pop-up window

06.png

d. Switch back to Tool and paste code in textbox that appeared in place of Grant Offline Access button


07.png

e. Click OK button and you ready to go with below screen

08.png

 

Add New Workflow

a. Click Add Workflow Menu Item

09.png

b. Enter all input fields in Workflow Panel

sh2.png

Input Fields:

Workflow ID Unique (across all Workflows present in Tool) workflow identifier. Case-sensitive
Description Free text describing Workflow
Owner User created workflow. Can be changed only by Admins if requested. When workflow run via Scheduler - it is run under Owner's account and billed to respective billing project
Delegates Comma-separated list of users who are granted (by owner or other delegates) edit access and all execution rights to given Workflow.
With very few exceptions - delegates can do all the same as owner. Delegates can see respective workflow in Workflow History and execution details
Share With Comma-separated list of users who are granted (by owner or other delegates) view access and restricted execution right to given workflow. Users from "Share With" list can run the Workflow via Execute Workflow Task only.
Lifetime

Define Start and End Dates for schedule

Set Lifetime should be checked
Setting End data to Until Forever is retired

12.png

Schedule

Define Schedule. 
Note: for workflow to be run via Scheduler - Lifetime (see above) must be Set and Schedule must be Enabled(see below)

Please consider: Try not to schedule on the exact hour, half hour, or quarter hour. 
Spread the time out such as 9:04 or 9:32 instead of 9:00 or 9:30
  
Simple Scheduling provides drop down options for when to run
Options include when and on what day
13.png
14.png
15.png
 
 Advanced schedule is done with Quartz Cron - just check Advanced checkbox and enter desired schedule using Quartz Cron syntax
 
16.png
Time Zone

By default, the Workflow is executed in Magnus’ server time zone, which is US/Eastern.  You can change the time zone in which to execute the Workflow.  This affects when the Workflow is executed and the time-related built-in parameters.

If the Workflow with US/Eastern time zone is scheduled to run at each day at 5 AM from 6/1/2018 to 6/2/2018, then it will run on 6/1/2018 and 6/2/2018 at 5 AM US/Eastern time.  The following built-in parameters will reflect the date and time in US/Eastern time zone during the execution: var_date, var_daydate, var_year, var_month, var_day, var_hour, var_yesterday, var_timezone. 
Note: 
- The time zone selected in not applied to Script Task, so you will need to utilize the built-in parameter <var_timezone> in your script body to do any date time manipulations.
- The time zone selected is not inherited by the child Workflow in Execute Workflow Task.  For example, if the parent Workflow has US/Eastern time zone and the child Workflow has US/Pacific time zone, then during execution the parent Workflow will be executed with US/Eastern time zone and thus its built-in parameters will reflect the date and time in US/Eastern time zone, while the child Workflow will be executed with US/Pacific time zone and its built-in parameters will reflect the date and time in US/Pacific time zone.
-The time zone selected only applies to this Workflow. If you want to change the time zone for other Workflows, you will have to update each of them individually.

Billing Project From

By Default - user running workflow is billed to user's respective billing project any time workflow is run (manually or remotely)
Note: when workflow run via Scheduler - Owner is considered as a running user

17.png

Billing Project can be set to be a billing project of the workflow's owner - no matter who runs workflow 
Note: running user still need to have permission to run jobs in respective project

18.png

Finally, user can choose which project to bill that is not assigned by default to this user in Magnus
Project can be entered manually in respective entry

19.png

or picked from selection list (all projects where user has job execute permission are presented here)

20.png

Enabled

Enable/Disable workflow's schedule

Public

Checked - the workflow is viewable by all users in owner's billing project 
Unchecked - the workflow is viewable only by its owners/delegates/shared users

Save Save new or modified Workflow
Exit Exit workflow.  Prompts to save if there are unsaved changes
Run Runs workflow.  Automatically saves if there are unsaved changes

Workflow will run under Owner Account when scheduled
Workflow will run under User Account who Manually Run Workflow (see Billing Project From for more options)

 

c. Click Save button

Save buttons can be found both at the upper right and lower left of the workflow  or in toolbar on the left

21.png

Add New Task

a. Click button with Task you want to add to Workflow

22.png

BigQuery Task – Executes BigQuery Query

23.png

If BigQuery Legacy SQL is used - Advanced panel provides ability to set UDF Source:

either as JavaScript code in Google Cloud Storage

24.png

or as Inline Code

25.png

 

View as Destination

26.png

 

Parameter as Destination

27.png

 

Datasets / Tables / Views Browsing 

Destination Table or View can be entered manually or can be picked from BQ Selector

28.png

 

Parameters in Query and Destination and other entry fields

29.png

  • Static and Dynamic
  • Built-In and Custom

 Go-To Task – Decision making based on some condition
Which next task to execute or leave Workflow (with or without failure)

30.png

 GS Export Task – Export GBQ Table to Google Cloud Storage

31.png

b. Common Tasks' Fields/Elements 32.png

Task ID Unique (within given Workflow) Task identifier
Description Free text describing Task
Dependencies

For future releases, but even now can be used to visually track Tasks dependencies
Click on Dependencies entry for pop-up to appear to manage dependencies 
33.png

For some Tasks selecting Dependency pre-populates respective entries with Output Parameter of dependency Task , for example:

34.png

Enabled Check box - Enable/Disable Task within Workflow for All (Scheduled, Manual or Remote) Run

Icons
35.png

Respectively:
Flip Side (Advanced Options, Formats, etc.) 
Move Task Up and Down - Note: Tasks executed in order from top to bottom
Delete Task
Ignore Failure

If not checked - when Task fails - whole workflow fails

If checked - when Task failed - workflow does not fail and flow jumps to next Task. 
At the same time Failure Info gets available in respective magic parameters and can be used to control next flow

Breakpoint  If there are any Task(s) with checked on Breakpoint - behavior of workflow failure is changed and flow jumps to the first such task after point of workflow failure
This feature can be used to mimic try-catch, or finalize or sort of web-hooks, etc

 

c. Parameters:

36.png
Built-In Parameters
 
Allows using pre-built parameters in user's Workflow/Tasks
They are mostly self explanatory

var_runid auto increment; counts workflow executions
var_time and var_prevTime hold respectively execution start and previous execution start time
var_timezone  Basis for Date/Time related Parameters set in Run-Time

Design Time values are used for Tasks validations
37.png Parameters with reset icon can be reset to 0 or empty string

Task Output Parameters

Task output is a built-In parameter that does not appear in built-in parameters list  

Whenever a new task is created – there is a linked parameter available: var_<TaskID>_output
For example a task ID of getTableNames would have a task output parameter of var_getTableNames_output

The output generated by the task can be referenced in other tasks.
For example a new BQTask can reference the output of getTableNames by adding SELECT * FROM [<var_My_First_Task_output>] to the query area
This is an alternative to referencing the destination table of the getTableNames task

Custom Parameters
Allows setting and using user's custom parameters to support logic implementation
Click Add button in below Panel

38.png

Enter Parameter Name in Pop-up; "var_" will be added if name you entered is not started with it

BigQuery data types are available to set parameter's type to support typed substitution.  They include

  1. String
  2. Number
  3. Boolean 
  4. Record

Note: Timeslice data type used to be supported in conjunction with Time Slice Tasks which is retired now

Parameters Usage 
Prefix parameter name (ie :var_parameterName) with colon to get its typed value
Surround parameter name in angle brackets (ie <var_parameterName >) for text substitution for building source or destination names and dynamic SQL

Browse Workflows

a. Click Workflows Menu Item

39.png

b. Browse / Sort / Filter / etc. available workflows

40.png

User can switch between Owned, Delegated, Shared and Public Workflows. Get Started Examples are also available as a separate group
41.pngUser can View, Edit, Explore, Archive or Browse Execution history of selected Workflow using respective icons

Browse History

a. Click Workflows History Menu Item

 42.png

b. Browse / Sort / Filter / etc. available execution history (last 7 days /last 1000 entries)

43.png



48.png49.png50.png51.png52.png53.png indicate respectively -  Scheduled Run, Manual Run, Run via Execute Workflow Task (as shared workflow), Run via Execute Workflow Task, Run as Trigger, Remote Run via Queue

c. Details for selected history item is available by clicking on Details Icon

45.png

46.png

d. Task Level Details are available under respective Links in Workflow Run Pop-up 47.png

 

Potens.io
Launch Magnus | Goliath