Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding extension for BAM #1278

Merged
merged 1 commit into from
May 2, 2024
Merged

Conversation

katallaxie
Copy link
Contributor

Fixes #

BAM is a method to track the progress of your business processes via the occurrence of business events in your organization. Famously, many companies used BizTalk to implement BAM in their organization, but with open standards like CloudEvents this is changing. This extension is necessary, as the payload of an event is processed by primary systems, like payment or ERP and the payload of these events should not change; but the progress should be tracked in an BAM system for business users to observe the processing and to control these transactions.

Proposed Changes

  • Add extension with attributes that support the implementation or use of a BAM system in an enterprise.

Release Note

Adds the business activity monitoring (BAM) known extension

@katallaxie katallaxie force-pushed the feat/bam-extension branch 2 times, most recently from ca17dc8 to 7b32a7d Compare April 18, 2024 09:14
@duglin
Copy link
Collaborator

duglin commented Apr 18, 2024

@katallaxie thanks for this. Seems reasonable to me and I left a few minor comments in there. I'll bring this to the attention of the team on today's call. Too new to vote today but hopefully next week.

@katallaxie katallaxie force-pushed the feat/bam-extension branch 3 times, most recently from 43647e0 to 28512e9 Compare April 18, 2024 16:17
@duglin
Copy link
Collaborator

duglin commented Apr 24, 2024

All, please review before tomorrow's call

@duglin
Copy link
Collaborator

duglin commented Apr 26, 2024

We discussed this on yesterday's call and overall there's no concern with adding it, however @JemDay was wondering about the length of some of those attributes. Would it be possible to use bam in there to shorten them?

Just tossing this out there:

bamtxid
bampid
bamptxid
bamptxpid
bamptxstatus
bamptxcompleted

Does there need to be a bamtxcompleted too?

@katallaxie katallaxie force-pushed the feat/bam-extension branch 2 times, most recently from 759ac2b to 1a77aaa Compare April 26, 2024 18:23
@katallaxie
Copy link
Contributor Author

@duglin great suggestion.

  • Updated the naming of the fields.
  • Provided a more in-depth explanation of how this works (like a state machine of the business process that is controlled by the events).
  • Fixed the link (they change the URL schema).

cloudevents/extensions/bam.md Outdated Show resolved Hide resolved
cloudevents/extensions/bam.md Show resolved Hide resolved
@katallaxie katallaxie force-pushed the feat/bam-extension branch 2 times, most recently from cca0dd6 to 6a12168 Compare April 27, 2024 16:11

## Attributes

### bamtxid (Business Transaction ID)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

minor thing, but I wonder if the stuff in parens should be BAM Transaction ID? Then all of the letters in the attribute name are correlated with the descriptive name - as of now we're missing the words for "am"

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ping @katallaxie, any thoughts on ^^ ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@duglin I changed it to BAM as we are defining the BAM term in the header. I think then this is consistent.

@duglin
Copy link
Collaborator

duglin commented Apr 30, 2024

@JemDay are you ok with the direction of the latest set of changes?

@JemDay
Copy link
Contributor

JemDay commented May 1, 2024

LGTM :-)

Signed-off-by: Sebastian Döll <[email protected]>
@duglin
Copy link
Collaborator

duglin commented May 2, 2024

thanks @katallaxie - and thanks for your patience.
Approved on the 5/2 call

@duglin duglin merged commit bf4b4a4 into cloudevents:main May 2, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants