Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In business logic metadata or in the code it is often desirable to refer to a piece of information from an outside source.  This may be a common piece of information that's useful to a variety of your process flow inputs, or it may be a piece of information that's cumbersome to pass around to every process flow that may need it.  Input Context Objects are designed to solve this problem.   Aptify provides two Input Context objects today.

...

By now you should have seen examples of using Input Context data in your business logic metadata. The overview on Business Logic Metadata covers this.  But we will recap it again here.   You refer to the particular input context object you want in metadata by prefacing it with the @ symbol and removing 'InputContext' from the name.   Then you add a period.   And then you put whatever property you want from that context object after it.   For example:

If you have an end point with an input property of OrderId

...

  • AuthenticatedPrincipalEntity - the name of the entity for the authenticated principal. Currently, this is always 'Persons'.
  • AuthenticatedPrincipalRecordId - the record id in the AuthenticatedPrincipalEntity entity. If the authenticated user is tied to Persons record 1, this value will be 1.
  • ServiceApplicationName - the name of the Service Application executing this request.
  • IsAnonymous - true if the AuthenticatedPrinicpalRecordId is the record id for the anonymous user of this service application.

...

This area is still being worked on.   For now, you should prefer using the context objects through metadata rather than depending on them in code.  But some information is provided for now.  

...