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

Create intersystems-iris.md - patch 3 #540

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

jbolinsky
Copy link
Contributor

Add in documentation page for Intersystems IRIS connector

@prmerger-automator prmerger-automator bot added the do-not-merge Don't merge this yet label May 13, 2024
Copy link
Contributor

@jbolinsky : Thanks for your contribution! The author(s) have been notified to review your proposed change.

Copy link
Contributor

Learn Build status updates of commit 61e58dc:

⚠️ Validation status: warnings

File Status Preview URL Details
powerquery-docs/connectors/intersystems-iris.md ⚠️Warning Details

powerquery-docs/connectors/intersystems-iris.md

  • Line 4, Column 9: [Warning: author-not-found - See documentation] Invalid value for author: 'Julie Bolinsky' is not a valid GitHub ID.
  • Line 59, Column 175: [Warning: bookmark-not-found] Cannot find bookmark '#help' in 'connectors/intersystems-iris.md'.
  • Line 7, Column 12: [Suggestion: ms-author-invalid - See documentation] Invalid value for 'ms.author', 'jbolinsk' is not a valid Microsoft alias.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

@Jak-MS
Copy link
Contributor

Jak-MS commented May 13, 2024

@jbolinsky - i can't find you in the Microsoft personnel db, but if you're a microsoft content contributor, you should be using the private repo to submit new articles. Otherwise, we'll have @DougKlopfenstein review your article.

@DougKlopfenstein

  • Can you review this PR?
  • IMPORTANT: When this content is ready to merge, you must add #sign-off in a comment or the approval may get overlooked.

Note: because this a new article, the commits in this PR should be moved to the private repo so we can do a full review with Acrolinx and staging. thanks, and let us know if you need assitance.

#label:"aq-pr-triaged"
@MicrosoftDocs/public-repo-pr-review-team

Copy link
Contributor

Learn Build status updates of commit 054367a:

⚠️ Validation status: warnings

File Status Preview URL Details
powerquery-docs/connectors/intersystems-iris.md ⚠️Warning Details

powerquery-docs/connectors/intersystems-iris.md

  • Line 4, Column 9: [Warning: author-not-found - See documentation] Invalid value for author: 'Julie Bolinsky' is not a valid GitHub ID.
  • Line 53, Column 174: [Warning: bookmark-not-found - See documentation] Cannot find bookmark '#help' in 'connectors/intersystems-iris.md'.
  • Line 7, Column 12: [Suggestion: ms-author-invalid - See documentation] Invalid value for 'ms.author', 'jbolinsk' is not a valid Microsoft alias.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

* *I'm getting the following error: "Expression.Error: the field 'Value' of the record wasn't found"*

This error appears when you're trying to use the connector from a system that doesn't have the InterSystems IRIS ODBC driver installed. As we can't package the ODBC driver inside the connector, it has to be downloaded from the [WRC distributions page](https://wrc.intersystems.com/wrc/coDistGen.csp) and installed separately. Note that it will typically have been installed automatically if your workstation also has an InterSystems IRIS instance installed.
The InterSystems Caché and Ensemble ODBC drivers isn't recognized by the connector.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is "Caché" supposed to be "Caché"?


Yes. The connector is based on standard ODBC connectivity and therefore works with any version of InterSystems IRIS. Only for browsing the InterSystems IRIS BI catalog, certain limitations apply:
* The BI cube metadata is queried through an API that is new in 2019.2. If that API isn't present, a best-effort fallback query is baked into the connector. You can also [request a patch](#help) (CatalogQueries.xml) that adds the API to earlier versions of InterSystems IRIS and can be imported into the namespace you'll be connecting to.
* Prior to 2019.1, the links between the fact and dimension tables was expressed through a proprietary relationship mechanism that isn't automatically read by the connector. If you are using BI cubes on a version earlier than 2019.1, you'll have to define these relationships manually. (We are evaluating alternative approaches to address this issue.)
Copy link
Collaborator

Choose a reason for hiding this comment

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

If the connector is being deprecated, why mention that "We are evaluating alternative approaches to address this issue."?


* *Can I connect to Caché or Ensemble?*

Support for accessing Caché or Ensemble instances using the InterSystems IRIS ODBC driver is planned for a later release in 2019. For other functional limitations, see the section above.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Again, why mention that support for "accessing Caché or Ensemble instances using the InterSystems IRIS ODBC driver is planned for a later release in 2019.", since this isn't going to happen due to the connector being deprecated.

Also, the section above is "Capabilities supported", so the second sentence needs to be more explicit about where to go (or remove it if the information is no longer available or relevant).

@DougKlopfenstein
Copy link
Collaborator

In addition to the comments above, the following issues need to be addressed:

  • If the connector is being deprecated, then "(Deprecated)" needs to be added to the heading.
  • The connector needs to be added to the table of contents since this connector was never documented before (toc.yml). The connector name in the table of contents should be "Intersystems IRIS (Deprecated)".
  • The connector needs to be added to the list of all connectors (connectors/index.md) because the connector was never documented before. Be sure to add a link to the Intersystems IRIS connector article. The connector name in the list of all connectors should be "Intersystems IRIS (Deprecated)".

---
title: Intersystems IRIS
description: Provides basic details for the Intersystems IRIS connector for Power BI.
author: Julie Bolinsky
Copy link
Collaborator

Choose a reason for hiding this comment

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

The author metadata should be your GitHub account name - jbolinsky.

author: Julie Bolinsky
ms.topic: conceptual
ms.date: 5/3/2024
ms.author: jbolinsk
Copy link
Collaborator

Choose a reason for hiding this comment

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

The ms.author metadata must be a Microsoft employee. You can use my Microsoft alias for this metadata - dougklo

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants