Share via


CRMArticleTemplate.Create Method

The Create method creates a new article template.

Syntax

[Visual Basic .NET]
Public Function Create(
  ByVal Caller As CUserAuth,
  ByVal ArticleTemplateXML As String
) As String
[C#]
public string Create(
  CUserAuth  Caller,
  string  ArticleTemplateXML
);
[C++]
public: String* Create(
  CUserAuth*  Caller,
  String*  ArticleTemplateXML
);

Parameters

Caller

Specifies the identity of the caller. The caller must have the prvCreateArticleTemplate privilege to perform this action. See CUserAuth.

ArticleTemplateXML

Specifies an XML string representing the article template. The XML schema is described by kbarticletemplate.xsd.

Return Value

Returns a String type that specifies the ID of the newly created article template.

Remarks

Create a value for the structure field that is meaningful for your application. Please note that these article templates do not work with the Microsoft CRM application, which uses a proprietary article template format.

If there is an error, SOAP throws an exception and the error message is reported in System.Web.Services.Protocols.SoapException.Detail.OuterXml.

All IDs passed to the platform are GUIDs wrapped in braces. For example: {6522D89A-A752-4455-A2B0-51494C6957C3}

Example

[C#]
// strServer should be set with the name of the platform Web server
string strServer = "myservername";

// virtualDirectory should be set with the name of the Microsoft CRM
// virtual directory on the platform Web server
string virtualDirectory = "mscrmservices";
string strDir = "https://" + strServer + "/" + virtualDirectory + "/";

// BizUser proxy object
Microsoft.Crm.Platform.Proxy.BizUser bizUser = new Microsoft.Crm.Platform.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";

// CRMArticleTemplate proxy object
Microsoft.Crm.Platform.Proxy.CRMArticleTemplate kbArticleTemplate = new Microsoft.Crm.Platform.Proxy.CRMArticleTemplate ();
kbArticleTemplate.Credentials = System.Net.CredentialCache.DefaultCredentials;
kbArticleTemplate.Url = strDir + "CRMArticleTemplate.srf";

string strErrorMsg;
try
{
   Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();

   // Set up the XML string for the article template
   string strXml = "<kbarticletemplate>";
   strXml += "<title>Article Template 1</title>";
   strXml += "<description>A description of the template.</description>";
   strXml += "<structurexml>some structure</structurexml>";
   strXml += "<formatxml>some format</formatxml>";
   strXml += "</kbarticletemplate>";

   string strArticleTemplateId = kbArticleTemplate.Create(userAuth, strXml);
}
catch (System.Web.Services.Protocols.SoapException err)
{
   // Process the platform error here
   strErrorMsg = ("ErrorMessage: " + err.Message + " " + err.Detail.OuterXml + " Source: " + err.Source );
}
catch (Exception err)
{
   // Process other errors here
   strErrorMsg = ("ErrorMessage: " + err.Message );
}

Requirements

Namespace: Microsoft.Crm.Platform.Proxy

Assembly: Microsoft.Crm.Platform.Proxy.dll

See Also

© 2005 Microsoft Corporation. All rights reserved.