Alteryx Server Knowledge Base

Definitive answers from Server experts.

How to view the history of a scheduled workflow

d_vansell
Alteryx
Alteryx
Created

How to view the history of a scheduled workflow

When you need to see the history of a scheduled workflow on your server, this can quickly be done by creating a workflow in Designer that will read the MongoDB and show you the results.

Prerequisites

  • Alteryx Server
    • Versions: All

Procedure

1. You will need to get the workflow number

          A) Access the admin account by clicking on the dropdown under your name and then 'Admin.'

image.png

          B) Click on 'Jobs' in the left-hand column

image.png

          C) In the middle, click on the tab 'Scheduled Workflows'
               image.png
          D) Click on the workflow that you need the history
          E) At the top, in the HTTP address bar, you will see the address for the scheduled workflow.  Copy the string after '/schedule/' for later use.
                    image.png
** NOTE ** It will be best to copy and paste the necessary information into a text document for ease of use when you use it later in the steps.


2. Next, you will need to get the password for your MongoDB.  If you do not have it, follow Step 2's instructions on how to get it.   If you already have it, you can move on to Step 3.
         ** NOTE ** There are a couple of ways to get to the Alteryx System settings.   Follow A1 or A2 to access the same settings.

          A1) Click on your Window's icon, search for Alteryx System settings, and click on it.
                    image.png
                                                       *** OR ***

         A2)  Open Designer -> Click on Options at the top -> Select Advance Options -> then Select System Settings
                    image.png


          B) Click on Next 4 times until you are under Controller -> Persistence
                    image.png
          C) (If you don't have it) Under the section for 'Database,' copy down the 'Host:' information
          D) Under the section for 'Database,' the last one will say 'Password: ********' -> Click on the eye icon to the left of the password to show the password
          E) Copy this password down for later use.
                    image.png
3. Next, you will want to open up Alteryx Designer
          A) Create a new Workflow
          B) Pull down a 'MongoDB Input' icon to the workflow
                    image.png
          C) Click on the MongoDB Icon 
                    1) Server:  Fill in the address to your Alteryx Server & port number.   There should be a ':' between the two. (Normally, the port number should be 27018 unless manually changed)
                    2) Put 'user' in the 'User Name' box
                    3) Put the password we retrieved from Section 2 into the 'Password (Optional)' box
                    4) Under Database: type in (case sensitive) 'AlteryxService' into the window.
                    5) Under Collection: click the drop-down - > Select 'AS_Queue'
                    6) Check the box for 'Include Mongo _id Field.'
                              image.png
          D). Drag a 'Filter Tool' icon to the workflow and connect it to the MongoDB Input
          E) Drag a 'Browse Tool' icon and connect it to the 'T' portion of the 'Filter' icon
          F) Click on 'Run' so the filter can get the fields from the MongoDB Input
                    image.png
          G) Click on the Filer Icon
                    1) Select the 'Basic Filter.'
                    2) In the first drop-down, select 'AS_Schedules__ID.'
                    3) In the second drop-down, select 'Equals.'
                    4) In the third drop-down paste/type in the <Workflow's Number>, we gathered earlier
                           image.png
          H. Run the Workflow
          
    Click on the Browse icon to view the 'Results' - This will list the history for your scheduled workflow.  
    This workflow can be changed to view other workflow's history by changing the <Workflow's Number> in the filter and running the workflow.


 

No ratings