EntityCollaborationClass.AddCollaboration Method

Creates a collaboration workspace site for a business External Item.

Namespace:  OBA.Server.EntityCollaboration
Assembly:  OBA.Server.Common (in OBA.Server.Common.dll)

Syntax

'Declaration
Public Shared Function AddCollaboration ( _
    baseSiteUrl As String, _
    entityCenterSiteTemplate As String, _
    entityCenterSiteTitle As String, _
    entityCenterSiteDesc As String, _
    entityInstanceSiteTemplate As String, _
    entityInstanceSiteTitle As String, _
    entityInstanceSiteDescription As String, _
    lobSystemInstance As String, _
    entityNamespace As String, _
    entityName As String, _
    entityInstanceId As Identity _
) As String
'Usage
Dim baseSiteUrl As String
Dim entityCenterSiteTemplate As String
Dim entityCenterSiteTitle As String
Dim entityCenterSiteDesc As String
Dim entityInstanceSiteTemplate As String
Dim entityInstanceSiteTitle As String
Dim entityInstanceSiteDescription As String
Dim lobSystemInstance As String
Dim entityNamespace As String
Dim entityName As String
Dim entityInstanceId As Identity
Dim returnValue As String

returnValue = EntityCollaborationClass.AddCollaboration(baseSiteUrl, _
    entityCenterSiteTemplate, entityCenterSiteTitle, _
    entityCenterSiteDesc, entityInstanceSiteTemplate, _
    entityInstanceSiteTitle, entityInstanceSiteDescription, _
    lobSystemInstance, entityNamespace, _
    entityName, entityInstanceId)

public static string AddCollaboration(
    string baseSiteUrl,
    string entityCenterSiteTemplate,
    string entityCenterSiteTitle,
    string entityCenterSiteDesc,
    string entityInstanceSiteTemplate,
    string entityInstanceSiteTitle,
    string entityInstanceSiteDescription,
    string lobSystemInstance,
    string entityNamespace,
    string entityName,
    Identity entityInstanceId
)

Parameters

• baseSiteUrl
  Type: System.String

  Specifies the URL of the parent site under which the business External Content Type center site is created. The business external content type center site is the top-level (root) site under which all collaboration workspace sites for business External Items belonging to a specific business External Content Type are created.

• entityCenterSiteTemplate
  Type: System.String

  Specifies the site template to use when creating the business External Content Type center site. Pass null for creating the site with the default template.

• entityCenterSiteTitle
  Type: System.String

  Specifies the title to use for the business External Content Type center site. Can be null or empty. If entityCenterSiteTitle is null or empty the site is created with an empty title.

• entityCenterSiteDesc
  Type: System.String

  Specifies a description of the business External Content Type center site. Can be null or empty. If entityCenterSiteDesc is null or empty the site is created with an empty description.

• entityInstanceSiteTemplate
  Type: System.String

  Specifies the site template to use for the collaboration workspace site. Can be null or empty. If entityInstanceSiteTemplate is null or empty the site is created with the standard team site template available in SharePoint.

• entityInstanceSiteTitle
  Type: System.String

  Specifies the title to use for the collaboration workspace site. Can be null or empty. If entityInstanceSiteTitle is null or empty the site is created with an empty title.

• entityInstanceSiteDescription
  Type: System.String

  Specifies the description to use for the collaboration workspace site. Can be null or empty. If entityInstanceSiteDescription is null or empty the site would be created with an empty description.

• lobSystemInstance
  Type: System.String

  Specifies the LobSystemInstance to use when checking for permissions on the business External Item in the external system for the user who invokes this method.

• entityNamespace
  Type: System.String

  Specifies the namespace of the business External Content Type as specified in the Business Data Connectivity (BDC) service service Metadata Store.

• entityName
  Type: System.String

  Specifies the name of the business external content type as specified in the Business Data Connectivity (BDC) service Metadata Store.

• entityInstanceId
  Type: Microsoft.BusinessData.Runtime.Identity

  Specifies the unique identifier for the business External Item for which the collaboration workspace site will be created.

Return Value

Type: System.String
The URL to the collaboration workspace site.

Remarks

If the collaboration workspace site already exists, this method returns a URL to the existing site. If the site that is created is the first instance for a specific business External Content Type, an External Content Type center site is also provisioned.

The baseSiteUrl, lobSystemInstance, entityNamespace, entityName, and entityInstanceId parameters are required. If any of these are missing (null or empty) then an ArgumentNullException exception is thrown. For all other error scenarios, an EntityCollabException exception is thrown.

For more information about the category of the error, see the ErrorInfo property.

See Also

Reference

EntityCollaborationClass Class

EntityCollaborationClass Members

OBA.Server.EntityCollaboration Namespace