MSBTS_ReceiveLocation (WMI)
Represents an individual receive location defined by Microsoft BizTalk Server.
Warning
Certificates must be installed on the box for the MSBTS_ReceiveLocation class to work. The only way to create receive locations without certificates is to use the Microsoft.BizTalk.ExplorerOMAPIs.
Declaration
class MSBTS_ReceiveLocation : MSBTS_Setting
Members
MSBTS_ReceiveLocation defines the following properties:
| Property | Description |
|---|---|
| MSBTS_ReceiveLocation.ActiveStartDT Property (WMI) | Contains the date when the receive location should activate. |
| MSBTS_ReceiveLocation.ActiveStopDT Property (WMI) | Contains the date when the receive location should deactivate. |
| MSBTS_ReceiveLocation.AdapterName Property (WMI) | Contains the name of the adapter used by the receive location. |
| Caption (Inherited from CIM_Setting) | For more information about the CIM_Setting class, see the Windows Management Instrumentation documentation at https://go.microsoft.com/fwlink/p/?LinkID=20246. |
| MSBTS_ReceiveLocation.CustomCfg Property (WMI) | Contains the adapter-specific configuration in XML format. |
| Description (Inherited from CIM_Setting) | For more information about the CIM_Setting class, see the Windows Management Instrumentation documentation at https://go.microsoft.com/fwlink/p/?LinkID=20246. |
| MSBTS_ReceiveLocation.EncryptionCert (WMI) | Contains the Name of the certificate used for outbound encryption. |
| MSBTS_ReceiveLocation.HostName Property (WMI) | Contains the name of the receive handler used by the receive location. |
| MSBTS_ReceiveLocation.InboundAddressableURL Property (WMI) | Contains a URL that can be used by external parties to send documents to the receive location. |
| MSBTS_ReceiveLocation.InboundTransportURL Property (WMI) | Contains an adapter-specific URL which the given instance of the receive location is listening to. |
| MSBTS_ReceiveLocation.IsDisabled Property (WMI) | Enables or disables a receive function. |
| MSBTS_ReceiveLocation.IsPrimary Property (WMI) | Specifies a primary receive function to use for correlation. |
| MSBTS_ReceiveLocation.MgmtDbNameOverride Property (WMI) | Overrides the initial catalog part of the BizTalk Management database connect string, and represents the database name. This property was not implemented for BizTalk Server and is reserved for future use. |
| MSBTS_ReceiveLocation.MgmtDbServerOverride Property (WMI) | Overrides the data source part of the BizTalk Management database connect string. This property was not implemented for BizTalk Server and is reserved for future use. |
| MSBTS_ReceiveLocation.Name Property (WMI) | Contains the name of the receive location. |
| MSBTS_ReceiveLocation.OperatingWindowEnabled (WMI) | Enables or disables a service window, which is defined by the SrvWinStartDT and SrvWinStopDT properties. |
| MSBTS_ReceiveLocation.PipelineName Property (WMI) | Contains the name of the pipeline that will process the document before the document is submitted to the MessageBox database. |
| MSBTS_ReceiveLocation.ReceivePortName Property (WMI) | Contains the name of the receive port used by the receive location. |
| MSBTS_ReceiveLocation.SendPipeline (WMI) | Contains the name of the send pipeline used by the receive location. |
| MSBTS_ReceiveLocation.SendPipelineData (WMI) | Contains the custom configuration data for the SendPipeline in XML format. |
| SettingID (Inherited from CIM_Setting) | For more information about the CIM_Setting class, see the Windows Management Instrumentation documentation at https://go.microsoft.com/fwlink/p/?LinkID=20246. |
| MSBTS_ReceiveLocation.SrvWinStartDT Property (WMI) | Contains the start time of a service window when the receive location should activate. |
| MSBTS_ReceiveLocation.SrvWinStopDT Property (WMI) | Contains the end time of a service window when the receive location should deactivate. |
| MSBTS_ReceiveLocation.StartDateEnabled (WMI) | Enables or disables the active start date specified by ActiveStartDT property. |
| MSBTS_ReceiveLocation.StopDateEnabled (WMI) | Enables or disables the active stop date specified by ActiveStopDT property. |
MSBTS_ReceiveLocation defines the following methods:
| Method | Description |
|---|---|
| MSBTS_ReceiveLocation.Disable Method (WMI) | Disables a receive location. |
| MSBTS_ReceiveLocation.Enable Method (WMI) | Enables a receive location. |
Remarks
Note
If a send port or receive location is updated using the BizTalk Explorer object model or a WMI script, the Receive Port Properties and Send Port Properties property pages in BizTalk Explorer will display an incorrect Address (URI). The Address (URI) used internally is the Address (URI) set by the script, so the script works as expected. To update the property pages to display the correct Address (URI), update the Address (URI) field in BizTalk Explorer with the new value.
Note
This class wraps the managed Microsoft.BizTalk.ExplorerOM.ReceiveLocation class.
Requirements
Header: Declared in BTSWMISchemaXP.mof.
Namespace: Included in \root\MicrosoftBizTalkServer.