Get the name of the Data Extension you are working with : Custom Activity

Question

I'm developping a custom activity in NodeJS and I would like to know how can I get the name of the Data Extension I'm working with to put the name here :

payload['arguments'].execute.inArguments = [{
            'campaignNameKey': campaignNameKey,
            'csvName': csvName,
            "Prenom": "{{Contact.Attribute.DE_NAME.Prenom}}",
            "Nom": "{{Contact.Attribute.DE_NAME.Nom}}",
            "Mobile": "{{Contact.Attribute.Contacts.Mobile}}",
            "Campagne": "{{Contact.Attribute.Contacts.Campagne}}",
            "stopSMS": "{{Contact.Attribute.Contacts.stopSMS}}"
        }];

For the moment, I'm using the name of my test Data Extension ("Contacts") but I would like to be able to use this payload on any Data Extension. Thanks !

EDIT : my customActivity.js

define(function (require) {
var Postmonger = require('postmonger');
var connection = new Postmonger.Session();
var payload = {};
var steps = [
    {'key': 'eventdefinitionkey', 'label': 'Event Definition Key'}
];

//HERE it works 
//connection.trigger('requestSchema');

var currentStep = steps[0].key;
var deName;
$(window).ready(function () {
    connection.trigger('ready');
});

function initialize(data) {
    if (data) {
        payload = data;
    }
}

function onClickedNext() { //SAVE USED HERE
    if (currentStep.key === 'eventdefinitionkey') {
        save();                       
    } else {
        connection.trigger('nextStep');
    }
}

function onClickedBack () {
    connection.trigger('prevStep');
}

function onGotoStep (step) {
    showStep(step);
    connection.trigger('ready');
}

function showStep (step, stepIndex) {
    if (stepIndex && !step) {
        step = steps[stepIndex - 1];
    }

    currentStep = step;

    $('.step').hide();

    switch  (currentStep.key) {
    case 'eventdefinitionkey':
        $('#step1').show();
        $('#step1 input').focus();
        break;
    }
}



function save() { //SAVE FUNCTION
    console.log('save');
    connection.trigger('requestSchema'); //NOT SHOWN IN CONSOLE

    let campaignNameKey = $('#select-campaign-name').val();
    let csvName = $('#select-csv-name').val();

    console.log("DE NAME " + deName);
    payload['arguments'] = payload['arguments'] || {};
    payload['arguments'].execute = payload['arguments'].execute || {};

    payload['arguments'].execute.inArguments = [{
        'campaignNameKey': campaignNameKey,
        'csvName': csvName,
        "Prenom": "{{Contact.Attribute."+ deName +".[\"Prénom\"]}}",
        "Nom": "{{Contact.Attribute." + deName +".Nom}}",
        "Mobile": "{{Contact.Attribute." + deName +".Mobile}}",
        "Campagne": "{{Contact.Attribute." + deName +".Campagne}}",
        "stopSMS": "{{Contact.Attribute." + deName +".stopSMS}}"
    }];

    payload['metaData'] = payload['metaData'] || {};
    payload['metaData'].isConfigured = true;
    //console.log(JSON.stringify(payload));
    connection.trigger('updateActivity', payload);
}

connection.on('requestedSchema', function (data) {    //CONNECTION ON
    // save schema
    console.log('*** Schema ***', JSON.stringify(data['schema']));
    let schema = JSON.stringify(data['schema']);
});
connection.on('initActivity', initialize);
connection.on('clickedNext', onClickedNext);
connection.on('clickedBack', onClickedBack);
connection.on('gotoStep', onGotoStep);
});

Answer 1

You can use undocumented 'requestSchema' Postmonger event to retrieve schema of event data source:

connection.trigger('requestSchema');

Than use response from Journey Builder:

connection.on('requestedSchema', function (data) {
   // save schema
   console.log('*** Schema ***', JSON.stringify(data['schema']));
});

Extract relevant information and save it in inArguments.
Example of schema:

[{
    "key": "Event.APIEvent-cbf6ce98-ba4f-a5c1-cc68-503ca1f60c39.Id",
    "type": "Text",
    "length": 18,
    "default": null,
    "isNullable": null,
    "isPrimaryKey": null
}, {
    "key": "Event.APIEvent-cbf6ce98-ba4f-a5c1-cc68-503ca1f60c39.Name",
    "type": "Text",
    "length": 50,
    "default": null,
    "isNullable": null,
    "isPrimaryKey": null
}, {
    "key": "Event.APIEvent-cbf6ce98-ba4f-a5c1-cc68-503ca1f60c39.Mobile",
    "type": "Text",
    "length": 50,
    "default": null,
    "isNullable": null,
    "isPrimaryKey": null
}]

Answer 2

You can use requestedTriggerEventDefinition Postmonger event, it will return a schema that will return information about the Journey builder(Name,dataExtensionId,...) to you.

You need the field eventDefinitionKey and use it instead of your data extension 'Contacts'.

Here is an example of what it would be like

var eventDefinitionKey;
connection.trigger('requestTriggerEventDefinition');

connection.on('requestedTriggerEventDefinition',
function(eventDefinitionModel) {
    if(eventDefinitionModel){

        eventDefinitionKey = eventDefinitionModel.eventDefinitionKey;
        console.log(">>>Event Definition Key " + eventDefinitionKey);
        /*If you want to see all*/
        console.log('>>>Request Trigger', 
        JSON.stringify(eventDefinitionModel));
    }

});

And then in function save :

payload['arguments'].execute.inArguments = [{
    'campaignNameKey': campaignNameKey,
    'csvName': csvName,
    "Prenom": "{{Contact.Attribute."+ eventDefinitionKey+".\"Prénom\"}}",
    "Nom": "{{Contact.Attribute." + eventDefinitionKey+".\"Nom\"}}",
    "Mobile": "{{Contact.Attribute." + eventDefinitionKey+".\"Mobile\"}}",
    "Campagne": "{{Contact.Attribute." + eventDefinitionKey 
    +".\"Campagne\"}}",
    "stopSMS": "{{Contact.Attribute." + eventDefinitionKey +".\"stopSMS\"}}"
}];

Answer 3

You may also use requestInteraction which is part of the Postmonger events.

var eventDefinitionKey;
connection.trigger('requestInteraction');

connection.on('requestedInteraction', function(settings){
    eventDefinitionKey = settings.triggers[0].metaData.eventDefinitionKey;
});

So in your function save you can use the eventDefinitionKey variable to reference to your entry source DE

payload['arguments'].execute.inArguments = [{
  "campaignNameKey": campaignNameKey,
  "csvName": csvName,
  "Prenom": "{{Event."+ eventDefinitionKey +".Prenom}}",
  "Nom": "{{Event."+ eventDefinitionKey +". Nom}}",
  "Mobile": "{{Event."+ eventDefinitionKey +". Mobile}}",
  "Campagne": "{{Event."+ eventDefinitionKey +". Campagne}}",
  "stopSMS": "{{Event."+ eventDefinitionKey +". stopSMS}}"
}];

For more information:

Postmonger Events Reference