SSJS code to fetch automation details issue

automationautomationstudiomarketing-cloudssjswsproxy

I am using the below SSJS WSproxy code to extract the automation details like name, status,start time etc. to create a dashboard

<script runat="server">

Platform.Load("Core","1");

  var prox = new Script.Util.WSProxy();

  var cols = ["Name","Status","StartTime","AutomationID"];

  var filter1 = {
      Property:"Name",
      SimpleOperator:"EQUALS",
      Value: "My_Test_Automation"
  };
  var res = prox.retrieve("AutomationInstance",cols,filter1);

  if (res.Results.length > 0) {
      
      var statusObj = {
  "-1":"Error",
  "0":"BuildingError",
  "1":"Building",
  "2":"Ready",
  "3":"Running",
  "4":"Paused",
  "5":"Stopped",
  "6":"Scheduled",
  "7":"Awaiting Trigger",
  "8":"InactiveTrigger"
}
      
      
      Write('<table align="center" border="1" cellpadding="5" ><tr><th colspan="3">Automation Dashboard</th></tr>')
      for (var i = 0; i < res.Results.length; i++) {
          var autoName = res.Results[i].Name;
          var autoStatusNum = res.Results[i].Status;
          var autoStatus = statusObj[autoStatusNum];
          var StartTime = res.Results[i].StartTime;
           var ID = res.Results[i].AutomationID;
        
          
          Write('<tr><td>' + autoName + '</td><td>' + autoStatus + '</td></tr>'+'<tr><td>' + StartTime+'<tr><td>' + ID)
      }
      Write('</table>')
  }

</script>

I am referring the SFMC documentation to extract the properties of AutomationInstance object – https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/automationinstance.html

I am facing following issues –

I can fetch a single automation details right now as I am using a filter but I would like to extract all automation available in the BU. Please can anyone let me know how I can do this by modifying the filter or the code?
I am able to get values for all the properties but for AutomationID it returns null. Please can someone point out what I am doing wrong here?

Best Answer

Welcome!

If you want to extract all automations available in BU, then you can use Status / IN filter to have all the possibilities. Also when you change "AutomationID" in cols with "ProgramID" it's going to pop up.

<script runat="server">

  Platform.Load("Core","1");

  var prox = new Script.Util.WSProxy();

  var cols = ["Name","Status","StartTime","ProgramID"];

  var filter1 = {
      Property:"Status",
      SimpleOperator:"IN",
      Value: [-1,0,1,2,3,4,5,6,7,8]
  };
  var res = prox.retrieve("Automation",cols,filter1);

  if (res.Results.length > 0) {
      
      var statusObj = {
  "-1":"Error",
  "0":"BuildingError",
  "1":"Building",
  "2":"Ready",
  "3":"Running",
  "4":"Paused",
  "5":"Stopped",
  "6":"Scheduled",
  "7":"Awaiting Trigger",
  "8":"InactiveTrigger"
}
      
      
      Write('<table align="center" border="1" cellpadding="5" ><tr><th colspan="3">Automation Dashboard</th></tr>')
      for (var i = 0; i < res.Results.length; i++) {
          var autoName = res.Results[i].Name;
          var autoStatusNum = res.Results[i].Status;
          var autoStatus = statusObj[autoStatusNum];
          var StartTime = res.Results[i].StartTime;
           var ID = res.Results[i].ObjectID;
        
          
          Write('<tr><td>' + autoName + '</td><td>' + autoStatus + '</td></tr>'+'<tr><td>' + StartTime +'<tr><td>' + ID)
      }
      Write('</table>')
  }

</script>

Related Solutions

[SalesForce] SSJS Functions in Automation Studio

Platform.Load (used to load the core library) is case sensitive. You will need to use Platform.Load instead of platform.load.

Also, I would recommend removing the comma after the Field 3 object in your array. It will work if you include it, but it's not strictly valid.

The following code works. However, note that the script will fail if a DE already exists with the same name and external key.

<script runat="server">
Platform.Load("core","1.1");
var deObj = {
    "CustomerKey" : "demoDE",
    "Name" : "My Demo DE",
    "Fields" : [
      { "Name" : "Field 1", "FieldType" : "Number", "IsPrimaryKey" : true, "IsRequired" : true },
      { "Name" : "Field 2", "FieldType" : "Text", "MaxLength" : 50 },
      { "Name" : "Field 3", "FieldType" : "Date", "Ordinal" : 2 }
    ]
 };

var myDE = DataExtension.Add(deObj);
</script>

SSJS WSProxy code is unable to access SFMC object – AutomationActivityInstance

First, let's see what you would get in the response using Write(Stringify(res)):

{
   "Status":"Error: AutomationActivityInstance is not a valid ObjectType.",
   "RequestID":"abcdefgh-abcd-1234-8b81-9ea00884b879",
   "Results":null,
   "HasMoreRows":false
}

Looks like the API does not recognize this object.

Let's see if we can do retrieve operations on it by checking the documentation: Supported Operations for Objects and Methods

Given that it's not listed, we can only assume we can't access it, but being a bit mistrustful about the documentation, we just do a describe operation to make sure:

var prox = new Script.Util.WSProxy();
var res = prox.describe("AutomationActivityInstance");
Write(Stringify(res));

the results are disappointing:

{
   "RequestID":"abcdefgh-abcd-1234-8b81-9ea00884b879",
   "Results":[null]
}

So no, it does not seem we can work with this object at all - you would get the same response if you looked for Unobtainium.

Can we find this data with the REST API?

there's a undocumented automation endpoint (credits go to Gortonington) where you can do a discovery GET request: /automation/v1/rest

In response you will get a collection of all automation routes, but there seems to be none connected to the AutomationActivityInstance, but maybe check for yourself, maybe you will find something useful there.

Best Answer

Related Solutions

[SalesForce] SSJS Functions in Automation Studio

SSJS WSProxy code is unable to access SFMC object – AutomationActivityInstance

Related Topic