Body
This knowledge article guides TeamDynamix (TDX) Agents with the Knowledge Candidate role on how to create, update, renew, address feedback, and monitor their articles in the Knowledge Base.
Before You Begin
If you would like to create and edit articles in TDX Knowledge, you will need to complete the following:
If you have not completed the above mandatory training yet, or would like the TDX Admins team to create and update your articles, please submit a ticket.
In This Article:
Creating New Articles
- Search TDX Knowledge to avoid creating duplicate articles.
- Create a curated article for content that exists outside of TDX, following the External Content Guidelines.
- Log in to the Client Portal and navigate to Knowledge Base.
- Click +New Article button. The new article form appears.
- Search and select a Category for the article.
- Skip the Order field, leave 1.0 in it.
- Skip the Pin Article field, leave it unchecked.
- Enter the article Subject (title) in accordance with the Article Title Guidelines.
- In the Body text box, enter the article's scope statement in accordance with the Article Scope Statement Guidelines.
Later steps explain how to add the remaining body content. For now, simply proceed to the next step.
- In the Article Summary text box, copy the scope statement from the article's Body text box.
- Enter the Tags in accordance with the Article Keywords or Tags Guidelines.
- Check Notify Owner on Feedback if you would like to receive feedback notifications.
TDX Knowledge notifications go to the article's owning group. Each notification has a unique keyword at the bottom, which can be used to create Outlook rules to manage them..
- Select the primary contact person for the article for Article Agent from the drop-down.
- Click Save.
- To add the rest of the article body content or to configure additional settings, follow the instructions in the Updating Existing Article section.
Updating Existing Articles
Access the Article
- Ensure you are logged to the Client Portal then navigate to the Knowledge Base.
- Click My Articles and Search for the article of interest.
- Select the article title to view it, then click the Edit Article button.
Modify Body Content
Important: Do not copy paste.
- When pasting content from external sources other than Word, use Paste as Plain Text
feature, or confirm that irrelevant HTML tags are not carried over.
- When pasting from Word, always use Paste from Word feature.
- Always Insert Images to prevent the image from disappearing.
- Images must have alternative text for accessibility compliance.
You can start with one of the pre-built templates that provide a basic structure for your article, which you can modify as needed.
- Modify the content in the article's Body in accordance with with the Article Writing Guidelines.
- Ensure that elements such as the table of contents (TOC), headings, links, lists, and images adhere to the Article Formatting and Organizing Guidelines.
Modify Additional Options
When making changes in one tab, be sure to save your changes before switching to a different tab.
- Navigate to the Settings tab to modify the article's category, title, summary, tags, or ownership.
- Navigate to the Permissions tab to change the article's visibility.
By default, all articles in the main categories are public (accessible to anyone worldwide). Articles in the Departmental category are internal (accessible only to signed-in users). If you want an article to inherit the default visibility from its category, you do not need to adjust its visibility settings.
- To set internal visibility:
- Uncheck both the Inherit Permissions and Public checkboxes.
- Select the Allow all individuals to view this article EXCEPT the associated groups below radio button and leave the Add Group textbox empty.
- To set restricted visibility:
- Uncheck both the Inherit Permissions and Public checkboxes.
- Choose the appropriate radio button under Article Permissions to either allow or restrict visibility for specific PG-departs-xxx groups.
- Navigate to the appropriate tab (Related Articles, Related Services, or Files) to add or remove related resources from your article.
Submit Article Updates
- Submit your updates for review and publish
- Existing Articles. For articles already submitted for approval or published:
- Click Save as Draft.
- Your article will remain live but will not show the recent content changes immediately.
- You recent update will be saved as a new revision and will go live after it is reviewed.
- New Articles. For articles being submitted for approval for the first time:
- Click Update Article.
- Navigate to Knowledge Base > My Articles.
- Search for the article then click the article title.
- Click Submit Article.
What's next:
- When you submit a new article or modify an existing one, the article or changes will not go live immediately.
- A designated member of the TeamDynamix Admin Team will review the article to ensure all new or modified content complies with the Style Guidelines.
- If any changes or corrections are required, you will be notified.
- If no action is needed, the new article will be published, or the modified content will go live.
- The time it takes to review the article depends on, the length of the content, the complexity of the content, and the quality of the submitted draft.
Submitting Article Renewals
All articles must be reviewed for currency and accuracy. The default frequency for periodic article review is every six months from the article’s creation or last review date. The Article’s Next Review Date signifies the duration for which the articles will remain published (live).
Articles that are not reviewed by the due date are archived, making them invisible and unsearchable on the Client Portal for customers.
You will receive an "Article Review Due" email notification 30 days before the article's next review date. You can submit article reviews at any time before they are due to reset the review date for another period.
Instructions
When renewing an article, ensure feedback is addressed, comments are reviewed, content and screenshots are updated, and the article stays relevant to the customer’s needs.
- Sign In to the Client Portal.
- Click My Articles Renewal Due in 30 Days or Groups' Articles Renewal Due in 30 Days to open the report page.
- When the report page opens in a new tab, click the Run Report button.
If you see a blank page with (0) results after you click Run Report, it means currently you don't have any articles needing renewal.
- Click the Title (in Subject column) to open the article.
- Scroll to the bottom of the article.
- Click Yes button of the Was This Helpful.
- In the Comments box, enter “Article reviewed, extend next review date” of something along the lines that indicates you still would like to keep this article in the Knowledge Base.
- Click Submit (Once only.)
Clicking the 'Submit' button sometimes does not close the textbox. This is a known issue. Your message is still recorded.
- Click the browser's refresh button to reload the page to see the article review feedback has been recorded.
What's next:
- After you submit an article renewal, the article will still appear in the "Article Renewal Due" report because the renewal process is not instantaneous.
- A designated member of the TeamDynamix Admin Team will review the article to ensure all new or modified content complies with the Style Guidelines.
- If any changes or corrections are required, you will be notified.
- If no action is needed, the article’s next review date will be automatically reset for another six-month period.
You already receive one "Article Review Due" email notification 30 days before the article's next review date. If you wish to set up a second article review reminder, refer to the
Setup Additional Article Renewal Reminder section under
Managing Article Notifications.
Addressing Article Feedback
Authenticated users can provide feedback on any articles they have access to. Article owners are primarily responsible for addressing the submitted feedback in a timely manner.
You can view feedback for your articles directly in the Client Portal. Additionally, by selecting the 'Notify owner on feedback' option in the article form, you can receive email notifications whenever someone submits feedback on your articles.
Address Feedback via Reports
You can run the pre-built reports to see the submitted feedback.
- Ensure you are signed in to the Client Portal
- Click My Articles - Unaddressed Feedback or Groups' Articles - Unaddressed Feedback.
- When the report page opens in a new tab, click the Run Report button.
If you see a blank page with (0) results after you click Run Report, it means currently you don't have any articles needing renewal.
- Click the article title.
- Scroll to the bottom of the article and click the Feedback link.
- Review the submitted feedback.
Some feedback entries may be irrelevant to the article content. Unfortunately, this cannot be fully controlled. In such cases, simply mark the feedback as addressed.
- Update the article ticket if necessary
- Go back to the feedback and click Mark Addressed.
- Consider sending a thank-you message to those who provided feedback, appreciating their help in improving your article.
Address Feedback via Client Portal
You can address the submitted feedback directly in the Client Portal.
- Login to the Client Portal.
- Navigate to Knowledge Base and select the Feedback tab.
You can customize your feedback search by using the radio buttons in the search form.
- Click the article title.
- Scroll to the bottom of the article and click the Feedback link.
- Review the submitted feedback.
Some feedback entries may be irrelevant to the article content. Unfortunately, this cannot be fully controlled. In such cases, simply mark the feedback as addressed.
- Update the article ticket if necessary
- Go back to the feedback and click Mark Addressed.
- Consider sending a thank-you message to those who provided feedback, appreciating their help in improving your article.
Address Feedback as Tickets
You may convert submitted article feedback into a ticket so that you can work on it later, track the time spent addressing feedback, and use it for other reporting purposes.
When you convert feedback into a ticket, it is automatically marked as addressed.
- Ensure you are signed in to the Client Portal
- Navigate to Knowledge Base and select the Feedback tab.
- Click the article title in the Article column.
- Scroll to the bottom of the article and click the Feedback link.
- Click Create Ticket to convert feedback into a ticket. A new window will open with the option to select the application or form.
- Click Incident Form. The form will auto-populate the submitter's information as the Requestor and their feedback as the Description.
- Fill in the ticket form:
- Title: Enter an appropriate ticket title.
- Service: Search and select General Request.
- Source: Choose Article Feedback.
- Responsible: Enter your or your group's name.
- Click Save.
- Update the article as necessary.
- Consider sending a thank-you message to those who provided feedback, appreciating their help in improving your article.
- Resolve the ticket according to your team’s standard process.
Preventing Unaddressed Feedback Accumulation
The Knowledge Base (KB) Admin will convert any feedback that remains unaddressed by article agents for more than 15 days into tickets. These tickets will then be assigned to the respective article-owning groups.
Monitoring Articles
You can monitor your articles by running the pre-built Knowledge Reference Reports. These reports provide information on article usage, visibility, next renewal date, category, and ownership.
There are two types of Knowledge Reference Reports:
- The My ... reports are useful for article agents to see the articles where they are the primary contact person.
- The Group ... reports are useful to see the articles owned by a group.
Knowledge Reference Reports
To run any of the My Articles ... reports:
- Ensure you are signed in to the Client Portal
- Click on the desired report's link
- When the report page opens in a new tab, click the Run Report button.
You can sort these reports by any column for better analysis.
To run any of the Groups' Articles ... reports:
- Ensure you are signed in to the Client Portal
- Click on the desired report's link
- When the report page opens in a new tab, click the Run Report button.
- Search and select your group for the Owning group is one of prompt.
- Click the Run Report button.
You can sort these reports by any column for better analysis.
These reports are located in the Knowledge Reference Reports report folder in TDNext (i.e. TDNext > Tickets > Reports).
Managing Article Notifications
Control Article Notifications
The article owner group members receive the following pre-configured email notifications. Group members who are not responsible for article management tasks can create email rules in Outlook to filter out these notifications. Similarly, article agents can also configure email rules in Outlook to organize these notifications.
The keyword kb-notifications- can be used to process all TDX Knowledge notifications.
Use the respective specific keywords to filter individual notifications through Outlook rules.
Notification |
Trigger |
Specific Word in the Body |
Feedback |
A user submits feedback on an article. |
kb-notifications-feedback |
Review Due |
An article requires a periodic six-month review. |
kb-notifications-review-due |
Status Change |
An article's lifecycle status is changed. |
kb-notifications-status-change |
Draft Rejected |
A Knowledge Admin rejects an article. |
kb-notifications-draft-rejected |
Setup Additional Article Renewal Reminders
Article owner groups receive a pre-configured email notification titled 'Article Renewal Due in 30 Days.' You can follow the steps below to configure the 'Article Renewal Due in 15 Days' report as an additional reminder.
- Go to TDNext > Tickets > Reports.
- Search and click on My Articles Due in 15 Days report.
- Select Actions > Copy.
- Name the new report in the New Name box and click Save.
- In the displayed prompted, click View the New Report.
- Scroll to the Choose a report folder section and select your report folder.
- Scroll to the Email Delivery section and click Add.
- Fill in the Add Delivery Schedule form:
- Interval: Daily
- Time: Your preferred time
- Format: PDF
- Recipients: Search and add users (you can add multiple).
- Uncheck If the report has no results, send it anyway.
- Check Active to enable scheduling.
- Click Save to complete.
Use the Was this helpful? option to report broken links, typos, missing or incorrect information, or outdated images.