This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > ENSLIB namespace > Ens.Config.BusinessPartner

Ens.Config.BusinessPartner

persistent class Ens.Config.BusinessPartner extends %Library.Persistent, %XML.Adaptor

SQL Table Name: Ens_Config.BusinessPartner

Defines data about an Ensemble Business Partner Profile.
A Business Partner is any organization or application that an Ensemble production connects to. You can use the Business Partner table to hold additional information about such partners. The data in this data is informational only. It does has no effect on the running of the system.

Property Inventory

Method Inventory

Parameters

parameter DOMAIN = Ensemble;
Use our own domain for localization

Properties

property AlternativeContact as Ens.Config.BusinessPartnerContact;
Details on the alternative contact for this Business Partner.
Property methods: AlternativeContactGet(), AlternativeContactGetObject(), AlternativeContactGetObjectId(), AlternativeContactGetStored(), AlternativeContactGetSwizzled(), AlternativeContactIsEmpty(), AlternativeContactIsValid(), AlternativeContactNewObject(), AlternativeContactSet(), AlternativeContactSetObject(), AlternativeContactSetObjectId(), AlternativeContactUnSwizzle()
property Description as %String (MAXLEN = 5000, XMLPROJECTION = "ELEMENT");
Description of this Business Partner.
Property methods: DescriptionDisplayToLogical(), DescriptionGet(), DescriptionGetStored(), DescriptionIsValid(), DescriptionLogicalToDisplay(), DescriptionLogicalToOdbc(), DescriptionNormalize(), DescriptionSet()
property PartnerName as %String (MAXLEN = 255, XMLPROJECTION = "ATTRIBUTE") [ Required ];
Name of this Business Partner. This must be unique.
Property methods: PartnerNameCheck(), PartnerNameDelete(), PartnerNameDisplayToLogical(), PartnerNameExists(), PartnerNameGet(), PartnerNameGetStored(), PartnerNameIsValid(), PartnerNameLogicalToDisplay(), PartnerNameLogicalToOdbc(), PartnerNameNormalize(), PartnerNameOpen(), PartnerNameSQLCheckUnique(), PartnerNameSQLExists(), PartnerNameSQLFindPKeyByConstraint(), PartnerNameSQLFindRowIDByConstraint(), PartnerNameSet()
property PrimaryContact as Ens.Config.BusinessPartnerContact;
Details on the primary contact for this Business Partner.
Property methods: PrimaryContactGet(), PrimaryContactGetObject(), PrimaryContactGetObjectId(), PrimaryContactGetStored(), PrimaryContactGetSwizzled(), PrimaryContactIsEmpty(), PrimaryContactIsValid(), PrimaryContactNewObject(), PrimaryContactSet(), PrimaryContactSetObject(), PrimaryContactSetObjectId(), PrimaryContactUnSwizzle()

Methods

classmethod %Export(pName As %String, pFile As %String = "", pVerbose As %Boolean = 1) as %Status
Export a Business Partner definition to an xml file.
classmethod %ExportAll(pFile As %String = "", pVerbose As %Boolean = 1) as %Status
Export all Business Partner definitions to an xml file.
classmethod %Import(pFile As %String, pReplace As %Boolean = 0, pVerbose As %Boolean = 1, pKill As %Boolean = 0) as %Status
Import Business Partner definitions from an xml file.
If pReplace is true, replace an existing item with the same name.
If pVerbose is true, write status to the console.
If pKill is true, then delete all existing items before import!

Queries

query List()
SQL Query:
Select PartnerName,Description,PrimaryContact_Name As PrimaryContact, PrimaryContact_PhoneNumber As Phone from Ens_Config.BusinessPartner

Indexes

index (PartnerName on PartnerName) [IdKey, PrimaryKey, Type = key];
Index methods: PartnerNameCheck(), PartnerNameDelete(), PartnerNameDisplayToLogical(), PartnerNameExists(), PartnerNameGet(), PartnerNameGetStored(), PartnerNameIsValid(), PartnerNameLogicalToDisplay(), PartnerNameLogicalToOdbc(), PartnerNameNormalize(), PartnerNameOpen(), PartnerNameSQLCheckUnique(), PartnerNameSQLExists(), PartnerNameSQLFindPKeyByConstraint(), PartnerNameSQLFindRowIDByConstraint(), PartnerNameSet()

Inherited Members

Inherited Methods

Storage

Storage Model: CacheStorage (Ens.Config.BusinessPartner)

^Ens.Config.BusinessPartnerD(ID)
=
%%CLASSNAME
Description
PrimaryContact
AlternativeContact