SAMi - Smart API Marketplace Documentation

Community Pages

The Community pages serve as a collaborative initiative helping the Subscribers community to share knowledge base articles that aids them in developing the apps. The Community pages comprise of Knowledge Base articles, Message Boards, FAQs and Featured stories.

Explore Knowledge Base

The knowledge base feature helps the subscribers to view, share, like and dislike the knowledge sharing articles under the community pages.

Scenario 1: Explore Knowledge Base from Home Page

The Knowledge Base feature allows the developers to view the Knowledge-based articles and submit comments, likes and dislikes, and shares.

  1. To navigate to the Knowledge Base page from Home page, scroll down the home page to view the Knowledge Base section.

The Knowledge Base page appears.

2. When you navigate to the Knowledge Base section, click on View All link.

The most recent Knowledge Base article is displayed. Here, you will be able to choose the Knowledge base from the available dropdown list options. Since, at present there is only Help Knowledge base available to display.

The other features available in Knowledge Base page includes.

  • Search Articles

  • Provide Suggestion

  • Like

  • Dislike

  • Share

  • RSS Feed

  • View History

  • Print

Search Articles:

  1. To search an article on Knowledge Base page, enter the Keywords/name of the article in the Search field and click on Search button.

The Knowledge Base article is displayed for you to open and view.

2. Click to open the New Knowledge Base Article.
The searched Article is displayed.

In the Knowledge Base Article, as a developer you can do the following:

Share Articles

Share – Click on Share icon to share the article over the social media platform like, twitter, Facebook, or LinkedIn.

Like Articles

Like – Click on Like Icon to like the article based on the information provided in the article.

Dislike Articles

Dislike – Click on Dislike icon to dislike the article based on the information provided in the article.

View History

History – View the revision history of the article by clicking on the History link, and also compare two versions of the same article.

Compare Versions - When you click on History link, the Knowledge Article Compare page appears.

Select both the article versions by selecting the checkboxes. And, then clicking on Compare Versions button.

Print – Click on Print link to send the article to the printer for printing.

Submit Suggestions

If the Developer has any suggestions, will be able to submit the suggestion in the “Do you have any suggestions?” text area provided and click on Submit button.

A success message appears, and the suggestion message is submitted to the article.

Scenario 2: Explore Knowledge Base from Main Menu (Community)

The Knowledge Base feature allows the developer to view the Knowledge based articles and give comments, like and dislikes and share.

  1. To navigate to Knowledge Base page from Home page, click on Community menu and then Knowledge Base option.

The Knowledge Base page appears.

The most recent Knowledge Base article is displayed. Here, you will be able to choose the Knowledge base Home page or Help from the available dropdown list options.

By default, the Knowledge Base Home page is displayed.

When you choose Help, the Help option, the Help topics appear on the left corner of the page.

The Help Topics appear.

The other features available in Knowledge Base page includes.

  • Search Articles

  • Provide Suggestion

  • Like

  • Dislike

  • Share

  • View History

  • Print

Search Articles

To search an article on Knowledge Base page do the following:

  1. Enter the Keywords/name of the article in the Search field and click on Search button.

The Knowledge Base article is displayed for you to open and view.

2. Click to open the New Knowledge Base Article.

The searched Article is displayed.

In the Knowledge Base Article, as a developer you can do the following:

Share – Click on Share icon to share the article over the social media platform like, twitter, Facebook or LinkedIn.

Like – Click on Like Icon to like the article based on the information provided in the article.

Dislike – Click on Dislike icon to dislike the article based on the information provided in the article.

History – View the revision history of the article by clicking on the History link, and also compare two versions of the same article.

Compare Versions - When you click on History link, the Knowledge Article Compare page appears.

Select both the article versions by selecting the checkboxes. And, then clicking on Compare Versions button.

Print – Click on Print link to send the article to the printer for printing.

Submit Suggestions

If the Developer has any suggestions, will be able to submit the suggestion in the “Do you have any suggestions?” text area provided and click on Submit button.

A success message appears, and the suggestion message is submitted to the article.

Explore Message Boards

Scenario 1: Explore Message Boards from Home Page

The Message Board feature helps a developer to visit the Message Board that is relevant to developer community and perform certain operations with:

  • Categories

  • Recent Posts

  • My Posts

  • My Subscription

  • Statistics

Categories

In the Categories, you will find a list of messages received from the community members.

To go to Categories, do the following:

  1. Scroll down the Home page and then click on View All in the Community Topics.

The Message Boards appear.

Create a Message Post

To create a message post, the subscriber will be able to create a post and publish it on the Message Boards.

  1. To create a message post on Message Boards, the subscriber clicks on the New Thread button.

The New Thread form appears.

2. Fill in the details to the post in the Subject, Body fields and click on each section below to expand and provide:

  • Attachments

  • Categorization

  • Related Assets

  • More Settings

3. Click on the Publish button.

A success message appears. And an email is sent to the subscriber to access the posts. The post is created and published successfully.

The message post is displayed in the Threads.

Search a Message Post

To search a message post, the subscriber can provide the keywords/post name in the Search field and clicks on Search icon.

The searched results of relevant message posts appear.

Categories – Threads

In the Categories, the developer will be able to view all the messages in threads. It shows the latest message on top of the list.

The Message Boards allows you to go to different threads, each post when posted by any member subsequently the developer is allowed to click and view those message posts, as shown below.

The Thread will provide all information on its publication like the date of post, join date, also the developer feels the message content to be inappropriate, can report it with the portal admin by clicking on Report button.

Recent Posts

To view the recent posts by Developer (Subscriber), do the following:

  1. In Home Page, scroll down and navigate to Community Topics and then click View All link.
    The Message Boards page appears.

  2. In Message Board, click Recent Post in left navigation pane.
    The Recent Posts page appears.

  3. Click on any of the message posts to open and view it.

The message is opened.

In the Message, by clicking on the 3 dots menu option, you can perform the following operations:

  • Edit

  • Unsubscribe

  • Permissions

  • Move to Recycle Bin 

Edit Posts

  1. To edit an existing post, you need to navigate to Recent Posts click on 3 dots menu option of a post and then click on Edit option.

The post is open for you to edit.

2. Make necessary changes to the post in the Subject, Body fields and click on each section below to expand and provide:

  • Attachments

  • Categorization

  • Related Assets

  • More Settings

3. Click on the Publish button.

A success message appears. The post is updated successfully.

Unsubscribe & Subscribe

The subscriber can unsubscribe and subscribe to a message post by clicking on the 3 dots menu option.

  1. Click on Unsubscribe.

A success message appears. The message post is unsubscribed.

Similarly, if a post is unsubscribed earlier can be subscribed again by the Subscriber.

The subscriber can subscribe to a message post by clicking on the 3 dots menu option.

  1. Click on Subscribe.

A success message appears. The message post is subscribed.

Permissions (This feature is not working)

The subscriber can grant permissions to recent posts by clicking on the 3 dots menu option.

Move to Recycle Bin

The subscriber can delete a message post and move it to recycle bin clicking on the 3 dots menu option.

A delete success message appears. And the selected message posts moved to recycle bin.

My Posts

To view the My Posts the subscriber will be able to view all his/her created posts. To view my posts, the subscriber clicks on the My Posts tab on the left navigation pane.

All the My Posts, the logged in subscriber’s posts are displayed on the Message boards.

In My Posts, selecting a post and then by clicking on the 3 dots menu option, you can perform the following operations:

  • Edit

  • Unsubscribe

  • Permissions

  • Move to Recycle Bin

In My Posts, the subscriber can perform all the functions as it is performed in the Recent Posts. For more info, please refer to Recent Posts.

My Subscriptions

In My Subscriptions, you can view all the post subscriptions done by the subscriber.

To navigate to the Subscribers page, click on the Subscribers tab on the left navigation pane.

The Subscribers page appears.

Statistics

The statistics page will allow the subscriber to view the trends and stats in the form of numbers related to message posts by various subscribers.

  1. To navigate to Statistics page, in Message Boards, click on Statistics tab on the left navigation pane.

  2. Statistics is a view-only dashboard that showcases the number of categories, posts and participants published currently.

  3. Top Posters are listed with the latest message post on the top.

Scenario 2: To Explore Message Boards from Main Menu (Community)

The Message Board feature helps a developer to visit the Message Board that is relevant to developer community and perform certain operations with:

  • Categories

  • Recent Posts

  • My Posts

  • My Subscription

  • Statistics

Categories

In the Categories, you will find a list of messages received from the community members.

To go to Categories, do the following:

  1. Click Community and then Message Boards in the main menu.

The Message Boards page appears.

Create a Message Post

To create a message post, the subscriber will be able to create a post and publish it on the Message Boards.

  1. To create a message post on Message Boards, the subscriber clicks on the New Thread button.

The New Thread form appears.

2. Fill in the details to the post in the Subject, Body fields and click on each section below to expand and provide:

  • Attachments

  • Categorization

  • Related Assets

  • More Settings

3. Click on the Publish button.

A success message appears. The post is created and published successfully.

The message post is displayed in the Threads.

Search a Message Post

To search a message post, the subscriber can provide the keywords/post name in the Search field and clicks on Search icon.

The searched results of relevant message posts appear.

Categories – Threads

In the Categories, the developer will be able to view all the messages in threads. It shows the latest message on top of the list.

The Message Boards allows you to go to different threads, each post when posted by any member subsequently the developer is allowed to click and view those message posts, as shown below.

The Thread will provide all information on its publication like the date of post, join date, also the developer feels the message content to be inappropriate, report it with the portal admin by clicking on Report button.

The report dialog box appears.

The report dialog box allows you to report inappropriate content by selecting the reason for reporting and clicking on Report button.

Recent Posts

To view the recent posts by Developer (Subscriber), do the following:

  1. In Home Page, scroll down and navigate to Community Topics and then click View All link.


    The Message Boards page appears.

  2. In Message Board, click Recent Post in left navigation pane.
    The Recent Posts page appears.

  3. Click on any of the message posts to open and view it.

The message is opened.

  1. In the Message, by clicking on the 3 dots menu option of a PO posted message post, you can perform the following operations:

  • Reply

  • Reply with Quote

Reply to a Post

To reply to an existing post, click on the 3 dots menu option of the selected message and then click Reply.

The Reply text editor appears for you to add the message to reply.

  1. Add the reply content to the Body text area and click on the Subscribe Me checkbox, if you wish to subscribe to the message.

  2. Click on the Publish button.
    A success message appears. The post is updated successfully.

  3. Click Cancel to abort replying to the message post.
    The subscriber will be able to perform the following operations on his/her posts:

  • Edit

  • Unsubscribe

  • Permissions

  • Move to Recycle Bin

Edit Post

The subscriber will be able to edit an existing post by clicking on the 3 dots menu option and then clicking on Edit.

The Edit posts page appears.

Make necessary changes to the post and click on Publish button.

A confirmation message appears. The message is successfully updated.

Unsubscribe & Subscribe

The subscriber can unsubscribe and subscribe to a message post by clicking on the 3 dots menu option.

  1. Click on Unsubscribe.

A success message appears. The message post is unsubscribed.

Similarly, if a post is unsubscribed earlier can be subscribed again by the Subscriber.

  1. The subscriber can subscribe to a message post by clicking on the 3 dots menu option.

  2. Click on Subscribe.

A success message appears. The message post is subscribed.

Permissions (This feature is not working)

The subscriber can grant permissions to recent posts by clicking on the 3 dots menu option.

Move to Recycle Bin

The subscriber can delete a message post and move it to recycle bin clicking on the 3 dots menu option.

A delete success message appears. And the selected message posts moved to recycle bin.

My Posts

To view the My Posts the subscriber will be able to view all his/her created posts. To view my posts, the subscriber clicks on the My Posts tab on the left navigation pane.

All the My Posts, the logged in subscriber’s posts are displayed on the Message boards.

In My Posts, selecting a post and then by clicking on the 3 dots menu option, you can perform the following operations:

  • Edit

  • Unsubscribe

  • Permissions

  • Move to Recycle Bin

In My Posts, the subscriber can perform all the functions as it is performed in the Recent Posts. For more info, please refer to Recent Posts.

My Subscriptions

In My Subscriptions, you can view all the post subscriptions done by the subscriber.

  1. To navigate to the Subscribers page, click on the Subscribers tab on the left navigation pane.
    The Subscribers page appears.

The My Subscriptions page appears.

In Subscribers page, the subscriber can perform all the functions as it is performed in the Recent Posts. For more info, please refer to Recent Posts.

Statistics

The statistics page will allow the subscriber to view the trends and stats in the form of numbers related to message posts by various subscribers.

  1. To navigate to Statistics page, in Message Boards, click on Statistics tab on the left navigation pane.

  2. Statistics is a view-only dashboard that showcases the number of categories, posts and participants published currently.

  3. Top Posters are listed with the latest message post on the top.

Scenario 3: Explore Feature Stories from Main Menu (Community)

The subscriber can navigate to Featured Stories option by going to Community main menu.

The Feature Stories page will enable the subscriber to view all the featured stories published by the subscribers till date.

  1. In Featured Stories, the subscriber can click and comment, like, dislike featured stories.

  2.  Share the Featured Stories on social media platforms for instance, twitter, Facebook, and LinkedIn.

© 2024 SID Global Solutions | https://www.mysami.io | https://www.sidgs.com | +1 484-218-0021