DominoArea.org [Archive]

Add a button to the Inbox view

To add a button to the action bar in the Inbox view, we'll edit the Custom_JS_Lite subform in the Extension Forms File. First, we'll remove the comment tags around the inclusion of the subform API_ActionsHelper_Subform_Lite:

<NotesComment>
// Expose this comment block to include actions helper routines for Lite mode
<InsertNotesSubForm>
</NotesComment>


Then, we'll add code in the Custom_Scene_Actions_Lite function to add a button.



// Only add the menu item if we're in the mail view

if (-1 == s_MenuID.indexOf("mailview"))

return false;


// Add the button

var add1 = [{title:"Run Agent", find_id: "new", id: "agent1", before: true,

action:"runAnAgent{}", help_text:"Run an agent on the server" }];

addActionsLite( s_MenuID, true, add1);




The preceding code adds a button called "Run Agent". When the user clicks the button, the function runAnAgent will be called. We'll add this function to Custom_JS_Lite:



function runAnAgent(sId) {


// Get the UNIDs of the selected documents

var unids = API_GetSelectedDocs_Lite();


// Create an XMLHttpRequest object

if (window.XMLHttpRequest)

{

xhr = new XMLHttpRequest(); // Firefox, Safari, ...

}

else if (window.ActiveXObject) // ActiveX version

{

xhr = new ActiveXObject("Microsoft.XMLHTTP"); // Internet Explorer

}


// Set the function to be called when the request finishes

xhr.onreadystatechange = function()

{

if(xhr.readyState == 4)

{

if(xhr.status == 200) { // success

// Set status message and/or pop up an alert

AAA.EVI.sr (2, "", "Received:" + xhr.responseText, true);

alert("Agent completed");

// Refresh the Inbox

AAA.DSq.ELU(null, 'e-actions-mailview-inbox', 'ESV');

}

else // error

AAA.EVI.sr (2, "", "Error code " + xhr.status, true);

alert("Error running agent. Error code: " + xhr.status);

}

};


// Set the POST params

var params = "%25%25Nonce=" + AAA.HHT() + "&unid=" + unids;


// Send the request

xhr.open("POST", "./?EditDocument&Form=s_RunAgent&PresetFields=AgentName;MyAgent,CommonAgent;2", true);

xhr.setRequestHeader("Content-type", "application/x-www-form-urlencoded");

xhr.send(params);

}





The function first calls the helper function API_GetSelectedDocs_Lite to get the UNIDs of the selected documents in the view. To use API_GetSelectedDocs_Lite, we need to remove the comment tags in the following code:

<NotesComment>
//
// ============================================================
// Expose this comment block to include general helper routines
// ============================================================
//
<InsertNotesSubForm>
</NotesComment>