Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Working With The New Developer Documentation

While we will continue to deliver the Anthology Developer Documentation via this GitHub repo, we are dropping the use of Jekykll for generating the static files delivered through GitHub Pages. Instead we will be using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
While we will continue to deliver the blackboard Developer Documentation via this GitHub repo, we are dropping the use of Jekykll for generating the static files delivered through GitHub Pages. Instead we will be using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.

With this move to Docusaurus we are adding full site search capability and looking forward to using the rich features of Docusaurus and React to improve our Developer documentation experience.

Expand Down
2 changes: 1 addition & 1 deletion blog/2020/2020-12-16-SOAP-EOL-Explained.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,6 @@ For self and managed-hosted clients that are on 3900.0.0 and are now upgrading u

Another common quesiton is from those using the Learn LIS 2.0 SIS integration, which is SOAP based. No, we are keeping the LIS 2.0 SIS integration in the product at this time. It will not be affected.

If you have additional questions, drop a line to developers@anthology.com and we'll update this blog post with the answer.
If you have additional questions, drop a line to developers@blackboard.com and we'll update this blog post with the answer.

Happy 2021!
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ if ( top != self )
}
```

In and of itself there's nothing wrong with it. We, at Anthology, have removed it from the default Ultra login page, but many clients use it in Original login pages, and so it's moved with them into Ultra.
In and of itself there's nothing wrong with it. We, at Blackboard, have removed it from the default Ultra login page, but many clients use it in Original login pages, and so it's moved with them into Ultra.

> If you are unsure whether you have a custom login page, visit [help.blackboard.com](https://help.blackboard.com/learn/Administrator/SaaS/User_Interface_Options/Ultra_Experience/Institution_Branding/Customize_the_Login_Page) for more information.

Expand Down Expand Up @@ -81,6 +81,6 @@ By now, I hope you are using LTI 1.3, but I know many are not. As a result, we a

We have validated this fix with one of the partners that was affected. If you are a developer, please fix the issue immediately! If you are an administrator of a Learn SaaS instance using Ultra, and you have UEF integrations, make sure you do not have that JavaScript snippet on your login page. And if you do, please remove it. Then let your UEF integration partners and developers know that this fix must be made as soon as possible.

Regardless of whether you are an administrator or a developer, please feel free to reach out to us at developers@anthology.com with any questions.
Regardless of whether you are an administrator or a developer, please feel free to reach out to us at developers@blackboard.com with any questions.

Happy coding!
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ When we started supporting LTI 1.3/Advantage (back in May of 2019) we chose to g

But the [IMS Global](https://imsglobal.org) community has moved away from that model and now suggests that tool vendors generate their own key pairs for LTI authentication and provide their public key via a [JWKS URL](https://datatracker.ietf.org/doc/html/rfc7517). This model is more secure because there is not copying of a private key and allows the LTI Tool provider to follow best practices with key rotation.

We decided to follow that suggestion. If you want to register a new tool with Learn, you have to provide the JWKS URL information. And if you have an existing tool that use the Anthology-generated private key, please keep in mind that we'll be terminating support in the near future.
We decided to follow that suggestion. If you want to register a new tool with Learn, you have to provide the JWKS URL information. And if you have an existing tool that use the Blackboard-generated private key, please keep in mind that we'll be terminating support in the near future.

NOTE: Once you've made the change, you must have our mutual clients redeploy your LTI 1.3 tool. Redeploy means the following:
1. Admin -> Integrations, LTI Tool Providers -> Register LTI 1.3/Advantage Tool
Expand All @@ -34,8 +34,8 @@ FAQ:
-> You will need to work with the individual schools to ensure that after you make the chage they redploy your tool as described above.
3. Will schools transition seamlessly once we transition from a static public key to keyset URL (JWKS), or does it require any intervention from the Black side or the school admins?
-> The school admins will need to redeploy your tool as described above.
4. Currently, both static public key and keyset URL (JWKS) are going through successfully. Is it because Anthology hasn’t yet discontinued supporting the static public key?
-> Anthology will continue supporting the keys that were originally provided until further notice, likely until the end of 2022*.
4. Currently, both static public key and keyset URL (JWKS) are going through successfully. Is it because Blackboard hasn’t yet discontinued supporting the static public key?
-> Blackboard will continue supporting the keys that were originally provided until further notice, likely until the end of 2022*.

As always, if you have any questions, check out the [contact us page](https://docs.anthology.com/docs/Community/community-contact_us) and let us know!

Expand Down
2 changes: 1 addition & 1 deletion blog/2022/2022-08-12-DevCon2022.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ hide_table_of_contents: false

# DevCon 2022 Presentations!

We will be adding sessions here as soon as we get the presentations! If you want to see your DevCon presentation, please write us at developers@anthology.com. All times are in ET.
We will be adding sessions here as soon as we get the presentations! If you want to see your DevCon presentation, please write us at developers@blackboard.com. All times are in ET.

> **Day 1 @ DevCon 2022**

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
slug: Anthology Integrations and Customer Experience
slug: Blackboard Integrations and Customer Experience
title: Integration Installation and Customer Experience
authors:
- name: Mark O'Neil
Expand All @@ -10,37 +10,37 @@ hide_table_of_contents: false

# Integration Installation and Customer Experience

Anthology has designed it's model for integrations in a manner which, when executed following our best practices, improves the Customer Integration Experience. Our goals in this area are multi-fold, yet all drive toward the best experience possible when Customers license, purchase, or develop integrations for enhancing their Anthology Products as campus differentiators and enablers in achieving their Teaching and Learning objectives for their Staff, Faculty, and Students.
Blackboard has designed it's model for integrations in a manner which, when executed following our best practices, improves the Customer Integration Experience. Our goals in this area are multi-fold, yet all drive toward the best experience possible when Customers license, purchase, or develop integrations for enhancing their Blackboard Products as campus differentiators and enablers in achieving their Teaching and Learning objectives for their Staff, Faculty, and Students.

## Why is Customer Experience Important?

Customer experience is important for Partners and Anthology Customers for many reasons. Most notably:
Customer experience is important for Partners and Blackboard Customers for many reasons. Most notably:

**Customer Retention**: Providing a positive customer experience can help improve customer retention rates. Customers are more likely to remain loyal to a brand if they have had a positive experience with the company.

**Brand Reputation**: A positive customer experience can enhance your company's reputation and help build a positive brand image. Word of mouth and online reviews are powerful marketing tools, and customers are more likely to share their positive experiences with others.

**Competitive Advantage**: Providing a superior customer experience can set a business apart from its competitors and give it a competitive advantage.

Overall, a positive customer experience is essential for building strong customer relationships, increasing customer loyalty, and improving the overall success of a business. This applies to our developer community as well as Anthology.
Overall, a positive customer experience is essential for building strong customer relationships, increasing customer loyalty, and improving the overall success of a business. This applies to our developer community as well as Blackboard.

In addition to the general integration functionality, for which the integration development team is ultimately responsible, the most significant impact on the Customer Experience is installation and support of your integration.

Installation of your integration is often the first experience customers will have with your business and first impressions are lasting and influence future interactions.

How clients discover and know whom to contact for Support is also a significant influencer of impressions of your business.

Anthology has built our integration experience and best practices, with these latter two concepts in mind.
Blackboard has built our integration experience and best practices, with these latter two concepts in mind.

## Integration Installation

Anthology has thought long about how to simplify the integration experience for customers in the world of SaaS. In doing so we arrived at a "Register once, deploy everywhere" model for Integration developers to deliver theirr solutions. This applies to LTI 1.3 and RESTful integrations alike, and greatly simplifies installation for our mutual customers.
Blackboard has thought long about how to simplify the integration experience for customers in the world of SaaS. In doing so we arrived at a "Register once, deploy everywhere" model for Integration developers to deliver theirr solutions. This applies to LTI 1.3 and RESTful integrations alike, and greatly simplifies installation for our mutual customers.

### SaaS changed everything...

In prior years you may have built integrations which ran on-prem or in-process alongside the Anthology product. This required customers to manage the software themselves. Under the more modern SaaS model, which is used by Anthology, the customer is no responsible for updating and maintaining the integration, as SaaS product consumers receive updates automatically.
In prior years you may have built integrations which ran on-prem or in-process alongside the Blackboard product. This required customers to manage the software themselves. Under the more modern SaaS model, which is used by Blackboard, the customer is no responsible for updating and maintaining the integration, as SaaS product consumers receive updates automatically.

To facilitate the SaaS model, the Anthology Developer Portal provides the means for you the Developer to register your integration once and deploy to multiple customers. Once your integration is registered in the Developer Portal an identifier is issued - this identifier is used by _all customers_ to install your integration.
To facilitate the SaaS model, the Blackboard Developer Portal provides the means for you the Developer to register your integration once and deploy to multiple customers. Once your integration is registered in the Developer Portal an identifier is issued - this identifier is used by _all customers_ to install your integration.

This means you have one instance of your integration and all customers use that instance. This of course imply some design concepts for your integration.

Expand All @@ -52,7 +52,7 @@ Register once and Deploy anywhere means there are some differences in how you de

> Note: The following pertains to development of integrations which are marketed to multiple customers. Only point 1 is pertinent to those who are developing campus-only solutions.

1. **Logs and data**: Integrations should maintain archives of customer logs and any integration specific data as those are not provided by Anthology products.
1. **Logs and data**: Integrations should maintain archives of customer logs and any integration specific data as those are not provided by Blackboard products.
2. **Multi-tenancy**: Integrations should follow a multi-tenant model vs single tenant. Multi-tenant means one integration service delivering your integration to all your customers vs requiring a new intetegration service per customer. This means you have to design into your integration the ability for enabling individual customer accounts, likely only administrator, for any customer specific configuration.
3. **Separation of Customer data**: Multi-tenancy means that in addition to running a single service for your customers you are likely using a single database. This dictates a secure separation of customer data using a unique customer identifier prefix on customer-centric data keys.

Expand All @@ -74,7 +74,7 @@ See <a href="https://docs.anthology.com/docs/developer-portal/community-dev_port

See our <a href="https://docs.anthology.com/docs/rest-apis/learn/getting-started/rest_apis-learn-getting-started-releasing_integration" target="_top">Releasing your Integration</a> guide for production release details.

Also see <a href="https://docs.anthology.com/docs/lti/lti-registration-deployment" target="_top">LTI Registration and Deployment with Learn</a> guide which describes Anthology's approach behind releasing LTI 1.3 integrations.
Also see <a href="https://docs.anthology.com/docs/lti/lti-registration-deployment" target="_top">LTI Registration and Deployment with Learn</a> guide which describes Blackboard's approach behind releasing LTI 1.3 integrations.

#### Customer Facing Documentation

Expand All @@ -88,15 +88,15 @@ Aside from it **_not_** being a best practice to ask your customer to register y

Instead, develop your integration following the Register once model, and hand off your integration Identifier to your customer. If you are an LTI 1.3 provider - you are done. Your customer adds your LTI integration and sets availability to their users and they are done. No passing around of Keys and Secrets or error prone multiple copy pasting of multiple configuration strings... you hand off one integration Id which you get when you register your integration on the portal and done.

Well almost... the current exception (see The Future is Bright(er) below) is if your integration uses our REST APIs. Then your integration documentation must provide Anthology administrators with a list of privileges that need to be added to the user which is associated with your integration. The APIs list entitlements, not privileges, and therein lay a problem for Customers.
Well almost... the current exception (see The Future is Bright(er) below) is if your integration uses our REST APIs. Then your integration documentation must provide Blackboard administrators with a list of privileges that need to be added to the user which is associated with your integration. The APIs list entitlements, not privileges, and therein lay a problem for Customers.

As the integration provider you want a great customer experience so you use the <a href="https://docs.anthology.com/docs/rest-apis/learn/admin/rest_apis-learn-admin-rest_and_learn#converting-entitlements-to-gui-privileges" target="_top"> bookmarklet tool</a> to determine the privileges you include in your documentation to provide guidance to admins installing your integration.

## Integration Support

### Who is responsible for your integration's support?

It probably goes without saying, but the integration vendor is responsible. Not Anthology.
It probably goes without saying, but the integration vendor is responsible. Not Blackboard.

When the vendor registers in the Developer Portal they provide email information which is seen by customers when they install the integration. That is why this email and contact information must be publicly reachable. That is also why it makes sense to have a specific account from which all your integrations are delivered.

Expand Down
2 changes: 1 addition & 1 deletion blog/2024/2024-03-15-bestpractices-emailsupport.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Below are the recommended best practices to ensure you receive the quickest, mos

- Opt for a descriptive subject line summarizing the issue concisely. We recommend using the following format:
- [Your Company Name] - [Domain Name]: [Brief Issue Description]
- Example: YourCompanyName-AnthologyLearn: Issue with Launching Textbook Tool
- Example: YourCompanyName-BlackboardLMS: Issue with Launching Textbook Tool

- Provide Relevant Information:

Expand Down
17 changes: 17 additions & 0 deletions docs/archive/b2/archive-b2-pages-deprecated.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
url,title,status
https://docs.anthology.com/docs/archive/b2/getting-started/archive-b2-gs-api_docs,"B2 API Documentation",deprecated
https://docs.anthology.com/docs/archive/b2/getting-started/archive-b2-gs-api_overview,"B2s and Java Permissions",deprecated
https://docs.anthology.com/docs/archive/b2/getting-started/archive-b2-gs-dev_life_cycle,"Development Life Cycle",deprecated
https://docs.anthology.com/docs/archive/b2/getting-started/archive-b2-gs-faqs,"'B2-FAQs'",deprecated
https://docs.anthology.com/docs/archive/b2/getting-started/archive-b2-gs-first_steps,"First Steps with learn B2s",deprecated
https://docs.anthology.com/docs/archive/b2/getting-started/archive-b2-gs-intro,"Introduction to Building Blocks",deprecated
https://docs.anthology.com/docs/archive/b2/getting-started/archive-b2-gs-rosetta_stone,"'Rosetta Stone'",deprecated
https://docs.anthology.com/docs/archive/b2/getting-started/archive-b2-gs-starter_b2,"Starter Building Block Readme",deprecated
https://docs.anthology.com/docs/archive/b2/resources/archive-b2-resources-enable_remote_debug,"Enabling Remote Debugging",deprecated
https://docs.anthology.com/docs/archive/b2/resources/archive-b2-resources-first_project_gradle,"'First Project: Gradle, Git and b2-starter-template'",deprecated
https://docs.anthology.com/docs/archive/b2/resources/archive-b2-resources-java_11,"Java 11 for Learn: FAQ",deprecated
https://docs.anthology.com/docs/archive/b2/resources/archive-b2-resources-prepare_for_java_11,"8 Steps to prepare for Java 11",deprecated
https://docs.anthology.com/docs/archive/b2/resources/archive-b2-resources-prep_learn_q2,"Preparing Your B2 for Blackboard Learn 9.1 Q2 2016",deprecated
https://docs.anthology.com/docs/archive/b2/resources/archive-b2-resources-moving_to_saas,"Preparing Your Building Blocks For Learn SaaS and Newer Learn Versions",deprecated
https://docs.anthology.com/docs/archive/b2/resources/archive-b2-resources-scan_tool,"Scan tool for Learn SaaS",deprecated
https://docs.anthology.com/docs/archive/b2/resources/archive-b2-resources-useful_links,"'Useful Links'",deprecated
2 changes: 1 addition & 1 deletion docs/archive/b2/getting-started/api-documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Blackboard](https:///blackboard.secure.force.com/) on the Download
Files page for each release.

If an API is not shown in the publicly available documentation, it is not a
public API. Anthology does not support its use and we do not guarantee any
public API. Blackboard does not support its use and we do not guarantee any
kind of ongoing maintenance or compatibility. Use unsupported APIs at your own
risk.

Expand Down
Loading
Loading