Attribute Documentation
This chapter contains additional information on various attributes of the technology adapter. Note that this list does not contain all supported attributes and, depending on permissions and equipment used, it may also list attributes that are not supported for individual users.
The authoritative list of supported attributes for a particular user has to be queried using the attribute description endpoints such as for the Nesting Sheet Program Jobs API (see also Attribute Concept) This documentation of attributes only complements these API-based attribute descriptions.
We strive to make these articles usable as supplemental end user documentation for any client program using the Technology Adapter API. Therefore the models from the attribute description endpoints contain an 'EndUserDocumentationUrl' that can be used to provide context help on individual attributes in a user interface.
Of course there are some limitations that come with this approach:
-
Branding is not customizable so far.
-
Not cleanly separated from the actual API documentation yet.
-
Selection of languages is limited (only english so far).
-
Wording used for certain concepts may be different from that used in the client program.
But it helps keeping documentation in sync with the latest features of the Technology Adapter services and it is cheap and convenient to use in client programs.