Excel Macro to click on publish button of Master Data Services Add-in

Question

I am creating an excel macro to perform extra validation and defaults whilst the user is editing the MDS entity. It will be added as a workbook add-in. At the end of the macro I would like to be able to launch publish. The MDS addin is a ribbon.
Does anyone have an example of how I can simulate a click on the Publish button or what the call that the button does is?
David Roseneder

Answer 1

Hi David
here is a code sample to add mds actions with excel Buttons
you can find the connection class separately, by downloading my sample project (C#) on codeplex :
http://mdsmanager.codeplex.com
(I use this MDS connection class for many projects)
using System;
using System.Collections.Generic;
using System.Data;
using System.Linq;
using System.Text;
using System.Windows.Forms;
using System.Xml.Linq;
using Microsoft.VisualStudio.Tools.Applications.Runtime;
using Excel = Microsoft.Office.Interop.Excel;
using Office = Microsoft.Office.Core;
using System.Xml;
using System.Collections.ObjectModel;
using Common.ServiceReference1;
namespace ExcelToMDS
public partial class Sheet1
public const string mdsEndPoint = "http://yourMDSEndpointUrl:4040/Service/Service.svc";
ServiceClient c = null;
International intl = new International();
OperationResult or = new OperationResult();
Metadata md = null;
private void Sheet1_Startup(object sender, System.EventArgs e)
using (var c = Common.MDS_WSConnect.CreateMdsProxy("yourdomain", "yourlogin", "yourpassword", mdsEndPoint))
c.Open();
International intl = new International();
OperationResult or = new OperationResult();
md = GetMetaData(intl, ref or);
cbModels.Items.Clear();
foreach (Model mo in md.Models)
cbModels.Items.Add(mo.Identifier);
cbModels.DisplayMember = "Name";
cbEntities.Visible = true;
private Metadata GetMetaData(International intl, ref OperationResult or)
MetadataResultOptions mro = new MetadataResultOptions();
MetadataSearchCriteria msc = new MetadataSearchCriteria();
msc.Models = new Collection<Identifier>() { new Identifier() };
msc.Versions = new Collection<Identifier>() { new Identifier() };
msc.SearchOption = SearchOption.UserDefinedObjectsOnly;
mro.Models = ResultType.Identifiers;
mro.Versions = ResultType.Identifiers;
cbModels.Items.Clear();
Metadata md = c.MetadataGet(intl, mro, msc, out or);
return md;
private void Sheet1_Shutdown(object sender, System.EventArgs e)
if (c != null && c.State != System.ServiceModel.CommunicationState.Closed)
c.Close();
#region VSTO Designer generated code
/// <summary>
/// Required method for Designer support - do not modify
/// the contents of this method with the code editor.
/// </summary>
private void InternalStartup()
this.btGetMDSData.Click += new System.EventHandler(this.btGetMDSData_Click);
this.btGetTransactions.Click += new System.EventHandler(this.btGetTransactions_Click);
this.btUpdateAttribute.Click += new System.EventHandler(this.btUpdateAttribute_Click);
this.cbModels.SelectedIndexChanged += new System.EventHandler(this.cbModels_SelectedIndexChanged);
this.cbMembers.SelectedIndexChanged += new System.EventHandler(this.cbMembers_SelectedIndexChanged);
this.cbEntities.SelectedIndexChanged += new System.EventHandler(this.cbEntities_SelectedIndexChanged);
this.cbVersions.SelectedIndexChanged += new System.EventHandler(this.cbVersions_SelectedIndexChanged);
this.cbAttributes.SelectedIndexChanged += new System.EventHandler(this.cbAttributes_SelectedIndexChanged);
this.btReverseTran.Click += new System.EventHandler(this.btReverseTran_Click);
this.Shutdown += new System.EventHandler(this.Sheet1_Shutdown);
this.Startup += new System.EventHandler(this.Sheet1_Startup);
#endregion
private void btGetMDSData_Click(object sender, EventArgs e)
Cursor.Current = Cursors.WaitCursor;
DisplayEntityMembers(c);
Cursor.Current = Cursors.Default;
private void DisplayEntityMembers(ServiceClient c)
EntityMembers em = GetEntityMembers(c);
if (em != null)
Member[] members = em.Members.ToArray();
((Excel.Range)this.Cells[2, 2]).Value2 = "MemberName";
((Excel.Range)this.Cells[2, 3]).Value2 = "AttributeName";
((Excel.Range)this.Cells[2, 4]).Value2 = "AttributeValue";
for (int i = 0; i < members.Length; i++)
((Excel.Range)this.Cells[i + 3, 2]).Value2 = members[i].MemberId.Name;
int cptAtt = 0;
foreach (Common.ServiceReference1.Attribute att in members[i].Attributes)
((Excel.Range)this.Cells[i + 3, cptAtt + 3]).Value2 = att.Identifier.Name.ToString();
((Excel.Range)this.Cells[i + 3, cptAtt + 4]).Value2 = att.Value != null ? att.Value.ToString() : "";
cptAtt += members[i].Attributes.Count();
private EntityMembers GetEntityMembers(ServiceClient c)
if (cbModels.SelectedItem != null && cbEntities.SelectedItem != null && cbVersions.SelectedItem != null)
EntityMembersGetCriteria emGetCrit = new EntityMembersGetCriteria();
emGetCrit.ModelId = new Identifier() { Name = ((Identifier)cbModels.SelectedItem).Name };
emGetCrit.EntityId = new Identifier() { Name = ((Identifier)cbEntities.SelectedItem).Name };
emGetCrit.VersionId = new Identifier() { Name = ((Identifier)cbVersions.SelectedItem).Name };
//ExportView[] ev = c.ExportViewListGet(new International(), out or);
EntityMembersInformation emi = new EntityMembersInformation();
emGetCrit.DisplayType = DisplayType.CodeName;
EntityMembers em = c.EntityMembersGet(intl, emGetCrit, out emi, out or);
return em;
else
MessageBox.Show("Please select model, version and entity in comboboxes");
return null;
private void btGetTransactions_Click(object sender, EventArgs e)
if (cbModels.SelectedItem != null)
this.Rows.Clear();
using (var c = Common.MDS_WSConnect.CreateMdsProxy("yourdomain", "yourlogin", "yourpassword", mdsEndPoint))
c.Open();
DisplayTransactions(c);
c.Close();
else
MessageBox.Show("Please select Model in combos");
private void DisplayTransactions(ServiceClient c)
string versionName = "VERSION_1";
if (cbVersions.SelectedItem != null)
versionName = ((Identifier)cbVersions.SelectedItem).Name;
TransactionSearchCriteria trSrchCrit = new TransactionSearchCriteria();
trSrchCrit.ModelId = new Identifier() { Name = ((Identifier)cbModels.SelectedItem).Name };
//trSrchCrit.EntityId = new Identifier() { Name = ((Identifier)cbEntities.SelectedItem).Name };
trSrchCrit.EntityId = new Identifier();
trSrchCrit.VersionId = new Identifier() { Name = versionName };
//ExportView[] ev = c.ExportViewListGet(new International(), out or);
EntityMembersInformation emi = new EntityMembersInformation();
int totalTranCount = 0;
Collection<Transaction> transactions = new Collection<Transaction>();
OperationResult or = c.TransactionsGet(intl, trSrchCrit, out totalTranCount, out transactions);
int startY = 4;
int startDataY = startY + 1;
int startX = 4;
((Excel.Range)this.Cells[startY, startX]).Value2 = "TransactionID";
((Excel.Range)this.Cells[startY, startX + 1]).Value2 = "Code";
((Excel.Range)this.Cells[startY, startX + 2]).Value2 = "Name";
((Excel.Range)this.Cells[startY, startX + 3]).Value2 = "MemberType";
((Excel.Range)this.Cells[startY, startX + 4]).Value2 = "Date";
((Excel.Range)this.Cells[startY, startX + 5]).Value2 = "AttributeName";
((Excel.Range)this.Cells[startY, startX + 6]).Value2 = "PriorValue";
((Excel.Range)this.Cells[startY, startX + 7]).Value2 = "NewValue";
for (int i = 0; i < transactions.Count(); i++)
((Excel.Range)this.Cells[i + startDataY, startX]).Value2 = transactions[i].Id.ToString();
((Excel.Range)this.Cells[i + startDataY, startX + 1]).Value2 = transactions[i].MemberId.Code;
((Excel.Range)this.Cells[i + startDataY, startX + 2]).Value2 = transactions[i].MemberId.Name;
((Excel.Range)this.Cells[i + startDataY, startX + 3]).Value2 = transactions[i].MemberId.MemberType.ToString();
((Excel.Range)this.Cells[i + startDataY, startX + 4]).Value2 = transactions[i].Date.ToString();
((Excel.Range)this.Cells[i + startDataY, startX + 5]).Value2 = transactions[i].AttributeId.Name;
((Excel.Range)this.Cells[i + startDataY, startX + 6]).Value2 = transactions[i].PriorValue;
((Excel.Range)this.Cells[i + startDataY, startX + 7]).Value2 = transactions[i].NewValue;
private void btUpdateAttribute_Click(object sender, EventArgs e)
Cursor.Current = Cursors.WaitCursor;
using (var c = Common.MDS_WSConnect.CreateMdsProxy("yourdomain", "yourlogin", "yourpassword", mdsEndPoint))
c.Open();
EntityMembers em = GetEntityMembers(c);
Member[] members = em.Members.ToArray();
for (int i = 0; i < members.Length; i++)
((Excel.Range)this.Cells[i + 3, 2]).Value2 = members[i].MemberId.Name;
foreach (Common.ServiceReference1.Attribute att in members[i].Attributes)
if (att.Identifier.Name == "ValidDandT")
att.Value = DateTime.Now;
c.EntityMembersUpdate(intl, em);
DisplayEntityMembers(c);
c.Close();
Cursor.Current = Cursors.Default;
private void cbModels_SelectedIndexChanged(object sender, EventArgs e)
Identifier i = (Identifier)cbModels.SelectedItem;
if (md != null)
cbVersions.Items.Clear();
foreach (Common.ServiceReference1.Version v in md.Versions)
if (v.Identifier.ModelId.Id == i.Id)
cbVersions.Items.Add(v.Identifier);
cbVersions.DisplayMember = "Name";
private void cbVersions_SelectedIndexChanged(object sender, EventArgs e)
Identifier iVer = (Identifier)cbVersions.SelectedItem;
ModelMembersGetCriteria mmgc = new ModelMembersGetCriteria();
mmgc.Models = new Collection<Identifier>() { new Identifier() { Name = ((Identifier)cbModels.SelectedItem).Name } };
ModelMembersResultCriteria mmrc = new ModelMembersResultCriteria();
mmgc.Versions = new Collection<Identifier>() { new Identifier() { Id = iVer.Id } };
mmrc.IncludeLeafMembers = true;
cbEntities.Items.Clear();
cbMembers.Items.Clear();
Collection<EntityMembers> colEm = c.ModelMembersGet(intl, mmgc, mmrc, out or);
foreach (EntityMembers em in colEm)
cbEntities.Items.Add(em.EntityId);
cbEntities.DisplayMember = "Name";
private void cbEntities_SelectedIndexChanged(object sender, EventArgs e)
DisplayEntityAttributesCombo(c);
DisplayEntityAttributesAndMembersInSheet();
private void DisplayEntityAttributesAndMembersInSheet()
EntityMembers em = GetEntityMembers(c);
Member[] members = em.Members.ToArray();
((Excel.Range)this.Cells[2, 2]).Value2 = "MemberName";
((Excel.Range)this.Cells[2, 3]).Value2 = "AttributeName";
((Excel.Range)this.Cells[2, 4]).Value2 = "AttributeValue";
if (members.Count() > 0)
int ii = 0;
//attributes name on header line
foreach (Common.ServiceReference1.Attribute att in members[0].Attributes)
((Excel.Range)this.Cells[3, ii + 3]).Value2 = att.Identifier.Name.ToString();
ii++;
//members Data
int cptnbAttributes = members[0].Attributes.Count();
for (int i = 0; i < members.Length; i++)
for (int j = 0; j < cptnbAttributes - 1; j++)
((Excel.Range)this.Cells[i + 4, j + 3]).Value2 = members[i].MemberId.MemberType;
private void DisplayEntityAttributesCombo(ServiceClient c)
EntityMembers em = GetEntityMembers(c);
Member[] members = em.Members.ToArray();
if (members.Count() > 0)
cbAttributes.Items.Clear();
foreach (Common.ServiceReference1.Attribute a in members[0].Attributes)
cbAttributes.Items.Add(a.Identifier);
cbAttributes.DisplayMember = "Name";
cbAttributes.Visible = true;
private void cbMembers_SelectedIndexChanged(object sender, EventArgs e)
Identifier idMember = (Identifier)cbMembers.SelectedItem;
EntityMembers em = GetEntityMembers(c);
Member[] members = em.Members.ToArray();
Member m = members.FirstOrDefault(p => p.MemberId.Id == idMember.Id);
cbAttributes.Items.Clear();
foreach (Common.ServiceReference1.Attribute att in m.Attributes)
cbAttributes.Items.Add(att.Identifier);
cbAttributes.DisplayMember = "Name";
cbAttributes.Visible = true;
private void cbAttributes_SelectedIndexChanged(object sender, EventArgs e)
private void btReverseTran_Click(object sender, EventArgs e)
using (var c = Common.MDS_WSConnect.CreateMdsProxy("yourdomain", "yourlogin", "yourpassword", mdsEndPoint))
c.Open();
UpdateTransaction(c);
DisplayTransactions(c);
c.Close();
private void UpdateTransaction(ServiceClient c)
string versionName = "VERSION_1";
if (cbVersions.SelectedItem != null)
versionName = ((Identifier)cbVersions.SelectedItem).Name;
TransactionSearchCriteria trSrchCrit = new TransactionSearchCriteria();
trSrchCrit.ModelId = new Identifier() { Name = ((Identifier)cbModels.SelectedItem).Name };
//trSrchCrit.EntityId = new Identifier() { Name = ((Identifier)cbEntities.SelectedItem).Name };
trSrchCrit.EntityId = new Identifier();
trSrchCrit.VersionId = new Identifier() { Name = versionName };
//ExportView[] ev = c.ExportViewListGet(new International(), out or);
EntityMembersInformation emi = new EntityMembersInformation();
int totalTranCount = 0;
Collection<Transaction> transactions = new Collection<Transaction>();
OperationResult or = c.TransactionsGet(intl, trSrchCrit, out totalTranCount, out transactions);
Collection<ReplacementId> transactionReversed = new Collection<ReplacementId>();
or = c.TransactionsReverse(intl, new Collection<int>() { transactions.First().Id }, out transactionReversed);
Xavier Averbouch
Microsoft Community Contributor
Avanade , FRANCE
If a post answers your question, please click "Mark As Answer" on that post and "Vote as Helpful".