Known Issues in online RN

Starting from August 2020, the sorting algorithm for Known Issues (KI) items during RN generation requires specific wiki coding. The KI items are sorted and displayed in the following order:

1. Recommendation KI items.
2. KI items without JIRA IDs.
3. Regular KI items with Found In and Fixed In values.
   KI items with release numbers are sorted on descending order starting from the latest release. If two or more KI items have similar release number, they are sorted by JIRA IDs in descending order.
4. KI items for Engineering Requests (ER prefix).
5. Documentation KI items.

Format Regular KI Items

Make sure that every KI item has

<!--  Beginning of known issues item -->

and

<!--  End of known issues item -->

tags.

Otherwise, on the next RN generation KI list might get corrupted. It is a good idea to do a history check on the KI page after new RN generation to make sure that only expected changes were made. If some KI items where not formatted properly, there might be some unexpected updates and not necessary to this item. For example, JIRA ID or the release number was modified by the tool in the KI item that was previously correctly displayed.

There are no changes to the {{RNKI}} template for regular KI items.

Format Recommendations and no JIRA ID Items

To ensure the RN Automation tool sorts KIs automatically, writers must adopt the following guidelines for issues such as recommendations and KI without JIRA IDs.

• Every recommendation and every no JIRA ID item on the KI page must follow the following structure:

  <!--  Beginning of known issues item -->
  <Placeholder for the KI content>
  <!-- {{RNKI|||}} -->
  <hr class="item-separator">
  <!--  End of known issues item -->

  Important

  The {{RNKI}} template is commented out for recommendations and no JIRA ID items.

• If the item is a recommendation, replace the third line with <!-- {{RNKI|RECOM-1||}} -->.
  The subsequent recommendations will follow the sequence as RECOM-2, RECOM-3, etc.
  Example:

  <!--  Beginning of known issues item -->
  PostgreSQL deployments require JDBC4.1 Driver Version 9.4.1211.
  <!-- {{RNKI|RECOM-1||}} -->
  <hr class="item-separator">
  <!--  End of known issues item -->

• If the item is a KI without a JIRA ID, replace the third line with <!-- {{RNKI|NOID-1||}} -->.
  The subsequent KI without a JIRA ID will follow the sequence as NOID-2, NOID-3, etc. JIRA IDs can follow after the NOID-1 string.

  <!--  Beginning of known issues item -->
  By default, user data transformation supports date and time only in ISO 8601 format: YYYY-MM-DDTHH:MI:SS. Note that the character 'T' between DD (date) and HH (hour) is required.
  <!-- {{RNKI|NOID-1||}} -->
  <hr class="item-separator">
  <!--  End of known issues item -->

Example

The first item on the https://docs.genesys.com/Documentation/RN/9.0.x/pulse90rn/pulse90KI page is a known issue without JIRA ID.

The code for it is:

<!--  Beginning of known issues item -->
Single Sign-On (SSO) is not supported until GWS Auth services are available on premise.
<!-- 
{{RNKI|NOID-1||}}-->
<hr class="item-separator">

Under Investigation

The following questions are under investigations:

• Can I use <!-- {{RNKI|RECOM-3 GIM-11283, GIM-11361 ||}} --> to have the JIRAs in the markup for future reference.
• Can I use <!-- {{RNKI|NOID-1|8.5.100.10|}} --> to have the version, this issue was found in, for future reference.