Company attribute rule

Rule type – Abstract

Purpose: Is considered 'passed' if at least one of the company and address attributes of the reference object matches the criteria for Company type and/or Companies (or child companies) defined statically in the configuration.

images/download/attachments/201665103/image-2025-3-26_13-23-52-version-1-modificationdate-1742991831153-api-v2.png

The Company attribute rule is considered 'passed' if at least one of the company and address attributes of the reference object matches the criteria for Company type and/or Companies (or child companies) statically defined in the configuration.

Only entities whose type supports the possession of company and address attributes can be considered as reference objects. By default, this applies to the following entity types:

The Companies and Company type parameters are optional, but are typically used in combination to check whether at least one of the specified Companies (or one of its child companies) is marked as 'involved' in the reference object via a company attribute that refers to a specified Company type. Systematically, there are four cases for the use of the two optional parameters:

Company type

Companies

Effective test criterion of the rule

Comment

images/s/-95e2zf/9012/8yg2g7/_/images/icons/emoticons/check.svg one or more
'company types' selected

images/s/-95e2zf/9012/8yg2g7/_/images/icons/emoticons/check.svg one or more
'company types' selected

Is at least one of the Companies (including child companies, if applicable) involved in the reference object via a company attribute with one of the Company types?

typical use

images/s/-95e2zf/9012/8yg2g7/_/images/icons/emoticons/error.svg no selection

images/s/-95e2zf/9012/8yg2g7/_/images/icons/emoticons/check.svg one or more
'company types' selected

Is at least one of the Companies (including child companies, if applicable) involved in the reference object via any company attribute?

special use

images/s/-95e2zf/9012/8yg2g7/_/images/icons/emoticons/check.svg one or more
'company types' selected

images/s/-95e2zf/9012/8yg2g7/_/images/icons/emoticons/error.svg no selection

Is there at least one company and address attribute with one of the selected Company types?

conditionally recommended
(see 'Configuration')

images/s/-95e2zf/9012/8yg2g7/_/images/icons/emoticons/error.svg no selection

images/s/-95e2zf/9012/8yg2g7/_/images/icons/emoticons/error.svg no selection

Reference object can in principle have attributes, but is not one of the following entity types:

limited usefulness

Configuration

The Company attribute rule expects a reference object that supports company and address attributes (see above).

NOTE◄ If the Company type and Companies parameters are not used, the Company attribute rule will still be considered as 'passed' (otherwise as 'failed') for most entity types (see table above) that can be 'attribute owners'.

The optional Company type parameter defines a static multiple selection for values from the dynamic enumeration for the Company type.

The criterion defined by the selection is considered to be met if the reference object has at least one company and address attribute whose Company type (companyType) appears in the multiple selection.

Whether the attribute in question actually refers to a particular company as a value or specifies an address or a company reference, is only relevant if the optional Companies parameter is additionally used to define a criterion for companies. A combination of both parameters is typical but not required.

images/s/-95e2zf/9012/8yg2g7/_/images/icons/emoticons/warning.svg CAUTIONimages/s/-95e2zf/9012/8yg2g7/_/images/icons/emoticons/warning.svg If only the Company type parameter is used, the rule is considered 'passed' even if the reference object has a company and address attribute without a value. If an existing assignment for a company and address attribute is deleted (e.g. within a data input form), the company and address attribute in question remains without a value. A Company attribute rule rule that checks only the Company type parameter may then pass even though there is no longer an assignment for the checked Company type.

IMPORTANT◄ If Dynamische Aufzählungsfilter are applicable for the Company type enumeration in the context of a session, they also restrict the selection for the Company type in the course of the configuration. However, Dynamische Aufzählungsfilter have no influence on the evaluation of the Company attribute rule at runtime.

images/download/attachments/201665103/image-2025-3-26_13-25-31-version-1-modificationdate-1742991930547-api-v2.png

  • In the example, the Company type 'Origin port' was selected. After that, a search for other types of ports was started by entering the text 'port'.

  • Additional or different company types can be selected using the features in the gray footer (see Multiselect combobox).

The optional Companies parameter defines a static multiple selection of Company accounts.

The criterion defined by the selection is considered to be met if the reference object has at least one company and address attribute that is expressed as a company attribute and thereby specifies one of the companies in the multiple selection as the 'company involved'. Whether the same attribute also specifies an address or reference as a value is irrelevant.

If the Company type parameter does not specify a selection for the Company type, all company attributes are evaluated. Specified Companies are then accepted without considering the type of their participation in the reference object.

NOTE◄ The selection of companies in the Companies parameter dropdown in the course of configuration is not automatically restricted based on the multiple selection for the Company type vs. the 'Company types' (companyTypes) field in the company account. All companies are always selectable for whose account there is at least read access in the respective session.

images/download/attachments/201665103/image-2025-3-26_13-26-33-version-1-modificationdate-1742991992122-api-v2.png

The option or any child company (all levels) allows, in addition to the companies directly specified via the Companies parameter, all companies that are directly or in directly subordinate to these in the company hierarchy to be entered as 'involved'.

In the example on the right, the parameters in combination qualify that the Company attribute rule as a whole should be considered as 'passed', if at least one company attribute in the reference object refers to a 'company' as 'Transit port' or 'Destination port', which is to be assigned to the region 'APAC' (Asia/Pacific). In the context of the example, the seaports are mapped as company accounts that specify one or more 'groups' (see Companies as groups in the Tutorial) as parent companies in order to map (among other things) the affiliation to certain regions ('APAC', 'EMEA', etc.).


NOTECompany accounts may reference other Company accounts via the property "Parent cmopanies" (parentCompanies). They are then called 'direct children' of the referenced company. If a cascade of such references defines a relation of two Company accounts within the same company hierarchy across a number of levels, they are referred to as indirect parents/children.

images/download/attachments/201665103/image-2025-3-26_13-27-57-version-1-modificationdate-1742992076661-api-v2.png