Package psdi.app.site

An organization is a legal entity within a company that can have one or more sites.

See: Description

Interface Summary

Interface	Description
AddressRemote	Remote Interface to the Address object.
AddressSetRemote	Remote Interface to the set of Address objects.
BilltoShiptoRemote	Remote Interface to the BilltoShipto object.
BilltoShiptoSetRemote	Remote Interface to the set of BilltoShipto objects.
OrganizationRemote	Remote Interface to the Organization object.
OrganizationSetRemote	Remote Interface to the set of Organization.
SiteEComRemote	Remote Interface to the SiteECom object.
SiteEComSetRemote	Remote Interface to the set of SiteEComs.
SiteRemote	Remote Interface to the Site object.
SiteServiceRemote	Remote Interface to the SiteService object.
SiteSetRemote	Remote Interface to the set of Site Constants for relationships defined in the 'MAXRELATIONSHIP' table are declared here.

Class Summary

Class	Description
Address	MBO to represent an Address.
AddressSet	Represents the set of Address objects.
BilltoShipto	MBO to represent BilltoShipto.
BilltoShiptoSet	Represents the set of BilltoShipto objects.
FldAddressCode	This class evaluates an AddressCode.
FldBilltoAddressCode	This class evaluates an AddressCode.
FldCrewAvailabilityFactor
FldLocationPrimarySystem	Validation class for nonpersistent RELATIONJOINREQUIRED attribute in MaxIntObjDetail object.
FldOrganizationClearingAcct	Field class for organization.clearingacct
FldOrganizationCompanySetId	Verifies that the company set identifier is a valid set in the sets table, of type "COMPANY".
FldOrganizationID	Common validation class for OrgId fields.
FldOrganizationItemSetId	Verifies that the company set identifier is a valid set in the sets table, of type "ITEM".
FldPrimarySystem	This class evaluates a location systemid for use as a primary system.
FldShiptoAddressCode	This class evaluates an AddressCode.
FldSiteActive	Ensures that a site that is not active cannot be enabled if its organization is not active.
FldSiteAddressCode	The constructor sets the list criteria to restrict address codes to those belonging to the current organization.
FldSiteBillToShipTo	Toggle BillTo/ShipTo checkboxes.
FldSiteBillToShipToDefaults	Toggle BillToDefaults/ShipToDefaults checkboxes.
FldSiteContact	Prototype field class for site.contact
FldSiteContactGroup	Prototype field class for site.contactgroup
FldSiteEComMktplcId	SiteECom validation class: Checks that the MKTPLCID is unique to all sites.
FldSiteEComVendor	Validate the vendor for SiteECom; the vendor must be enabled for e-commerce.
FldSiteID	Common Validation Class for: site identifiers - SiteID.
FldSiteLaborcode	The constructor sets the list criteria to restrict address codes to those belonging to the current organization.
FldSiteOrgid	Verifies that an active organization is associated with this site.
FldSiteSiteid	Validates that the entered siteid is unique, is not the same as the orgid and is not null.
Organization	MBO to represent an organization.
OrganizationSet	Represents the set of Organizations.
SaaSOrgSiteCronTask	A MAXIMO SaaS crontask used for creating default Org and Site data for GA/Landlord and tenants when on-boarded This crontask should run only once per tenant
Site	MBO to represent a site.
SiteCache	Site cache.
SiteCacheFactory	Factory or Site Cache.
SiteECom	Mbo object to represent SiteECom.
SiteEComSet	Represents the set of SiteEComs.
SiteService	The site package service object.
SiteSet	Represents the set of Site.

Package psdi.app.site Description

An organization is a legal entity within a company that can have one or more sites. Each organization has a chart of accounts that is shared by the sites within that organization. The sites within an organization share information such as base currencies, items, purchase agreements, labor, exchange rates and companies. They share the same options for work orders, equipment, labor, and other types of data. A MAXIMO database can have any number of organizations.

A site is a subdivision of an organization that may track equipment, inventory, invoices, job plans, preventive maintenance, purchase orders, purchase requests, quote requests, work orders, etc. separately from other sites. Most site information is unique to the site and is not visible to other sites, even though they may belong to the same organization and share the same database. Site identifiers allow multiple sites to run on the same MXServer implementation. Sites should not be confused with locations or location groups.

Package Specification

The main objects included in the Site package are:

• Organization -- This class defines an organization, which is a legal entity within a company. Every organization must have a unique identifier; a primary currency, BaseCurrency1; an item set, ItemSetId; and a company set, companySetId. An organization may also include an optional description or secondary currency, BaseCurrency2. The MAXIMO database does not limit the number of organizations that may be created, but at least one organization must be defined.
• Site -- This class defines a site, which is a subdivision of an organization. Sites are grouped together under their organization. A given site will belong to only one organization, although an organization may contain multiple sites. At least one site must be defined for each organization. Every site must have a unique identifier. It may also include an optional description, ship to labor code, ship to address code, bill to labor code, or bill to address code.
• Address -- This class defines an address within an organization. Addresses are defined at the organization level. Each address consists of a mandatory unique address code, an optional description, and 5 optional address lines.

Some other generally useful classes are:

• SiteService.getOrgForSite -- This method returns the organization identifier for a given site identifier.
• FldSiteID -- This is the common validation class for the site identifier on other MBOs.
• FldOrganizationID -- This is the common validation class for the organization identifier on other MBOs.

Related Documentation:

• MboSetInfo.getSiteOrgType -- The table's "SiteOrgType" attribute on the MboSetInfo object. This is the same data as found in MaxTables2, but easier to get at runtime.
• UserInfo -- Identifies a logged-on user and the user's current site and organization.
• MboSet.getMultiSiteWhere -- This method is used to create a "where" clause to get a MboSet. This method automatically appends the correct organization or site restriction to the "where" clause based on the user's current site and the table's SiteOrgType.

Last updated: Thursday, November 14, 2003