| Table of Contents |
|---|
Introduction
...
Intended Users
e.g. The cashiers of a company, the branch managers, or which departments etc
Features and Functions
Use Cases
e.g. for Doc Item Maintenance applet
you can use it to configure all your products / services, bundles etc for e-commerce, point of sales , goods received note etc..
you can also use the Doc Item Maintenance as the central product repository, for syncing to various other systems.
Add Ons
For example, if there’s basic, standard, professional , enterprise edition etc… providing a table to describe the differences.
Basic Setup/Settings
Step-By-Step Guide on Menus
...
| Info |
|---|
Highlight important information in a panel like this one. To do this, click on the + sign on top menu, select “Info Panel”. To edit this panel’s color or style, select one of the options in the menu below. |
Related Applets:
This applet depends on:
This applet is depended by:
Alternative / Similar Applets / Variants:
Related Articles
| Filter by label (Content by label) | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Style Guide
...
Headings
- Use Heading 2 for titles.
...
Table of Contents
- Use macro “Table of Contents” from the top menu.
...
Links
- Use link text. For example: EcomSync Applet instead of https://wavelet.atlassian.net/wiki/spaces/AKAUN/pages/2944958608/EcomSync+Applet
...
Labels
- Add labels to categorize Applets by Modules (example: module-sales), or industry (example: industry-logistic).
...
Images
- Save images in png format before attaching.
- Set image to align left (not centre).
...
Sentences
- Use short, clear, concise sentences.
- Use active voice.
Recommended : Send a query to the service. The server sends an acknowledgment.
Not recommended : The service is queried, and an acknowledgment is sent.
- Use standard English word order. Follow the subject + verb + object order.
- Break sentences into bullet points if possible. If steps/order are involved, use numbering.
- Be consistent. For example, if first letter in bullet points are capitalize, make sure they are standardized across all pages.
...
1.0 Introduction
...
Applet Store is the marketplace for the distribution of applets that are designed for use with the Akaun products. It allows the subscribers to the Akaun products to browse and install the applets. Some applets in the store are free of charge but some are charged for a required fee.
Steps: Accept Marketplace Terms of Use > Install Applets > Open Applet
Permission Settings of Applets: Create Permission Set > Create and Assign Role
Personalization of Applets: Personalization of Applet.
2.0 Entering the Applet Store
...
Figure 1. Akaun Platform - Applet Store Icon
2.1 Applet Store icon in the Akaun Platform
When users first register and log in to the website, they will be directed to a page as shown in the screenshot above. Before installing any applet in the Applet Store, there is only one icon in the platform, which is the Applet Store icon. Then, users can proceed by clicking on the Applet Store to start browsing their desired applets.
Additionally, in the Akaun Platform page, a Search bar feature is implemented to enable the users to filter and search the installed applets in the Akaun Platform page.
2.2 Terms of Use of the Applets in the Applet Store
...
Figure 2. Akaun Platform - Marketplace Terms of Use
After clicking on the Applet Store icon, a page will appear, listing the terms of use of the applets in the Applet Store. Some of the essential information that is shown in this page includes:
Types of applets
Details of placing order for applets
Correct use of marketplace applets
Data collection, Data usage, and Data sharing
Users’ responsibilities
Term and Termination
Important disclaimers and limitations of liability
Third-party applets and third-party use of the applets
Dispute Resolution; Governing Law
Users have to patiently peruse the terms of use of the applets in the Applet Store to understand the responsibilities of every party who accesses and uses the applets.
...
Figure 3. Akaun Platform - Accept or decline the terms and conditions.
At the end of the page, users have to tick the square box as shown above to indicate that they have read all the terms and conditions for using the marketplace applets. Then, the “Accept” button will turn blue and users can click on the “Accept” button to indicate that they agree to the terms of use of the marketplace applets. By doing that, users can successfully enter the Applet Store and start installing their desired applets.
3.0 Layout in Applet Store
3.1 Desktop Layout
...
Figure 1. Desktop Layout of Applet Store - Light Theme
3.2 Mobile Layout
Figure 2. Mobile Layout of Applet Store - Dark Theme
The theme of the Applet Store in the mobile layout is a dark theme by default.
4.0 Catalog
4.1 What is a catalog?
Generally, a catalog in the Applet Store is a collection of applets that are suited for use by a tenant. Every tenant in the Akaun Platform requires different applets for their own operations. Thus, every tenant in the Akaun Platform will be given access to his own unique catalog of applets which are designed for his own use.
Next, the Applet Store consists of both public and private catalogs. The details of these catalogs are described below.
4.2 Public Catalog
Public Catalog Page
When the users enter the Applet Store after accepting the terms of use of applets, they will be directed to the Public page that shows all the public catalogs with their associated applets. Public catalogs are catalogs that can be accessed by all parties. These catalogs store applets that are commonly used by all parties to perform their operations.
For instance, the screenshot above shows that the MLM Admin applet is an applet under the Public Catalog.
Figure 2. Applet Information
Additionally, every individual applet in the Applet Store has its own specific icon, name and average user ratings.
Next, every individual applet has its tenant code. For example, staging_tenant. The tenant code identifies the tenant to which the applet belongs. This is because some applets are required by many different tenants. For instance, the Cashbook Applet is needed by many tenants to manage their cash book and settlement methods. However, every tenant needs their version of the Cashbook Applet because they would like to store their private data in the applet. Thus, we have Cashbook Applets with different tenant codes in which each tenant code identifies a specific tenant user. Every tenant user can only access the applet which is associated with his tenant code.
Apart from that, every individual applet has its rank. The rank type includes OWNER, ADMIN and MEMBER. This is because users with different ranks have different roles in managing and using the applets. For instance, users with the ADMIN and OWNER rank have the read and write access in assigning permissions to other users in using an applet whereas the users with MEMBER rank can only have read access to the permissions in an applet.
4.3 Private Catalog
...
Private Catalog Page - Install All
Next, when users click on the “Private” tab, they will be directed to the page that shows all the private catalogs as shown in the screenshot above. Private Catalogs are catalogs that can only be accessed by users who are given specific permission by the admin.
The admin of the Platform Sysadmin Applet can use this applet to assign permission for users to access their catalog of applets in the Applet Store. As mentioned previously, different clients will gain access to their own catalogs in order to use the relevant applets to carry out their particular operations. Thus, the catalogs and applets shown in this page vary by users.
Apart from that, a search bar is implemented on every catalog page for users to filter and search their desired applets easily. Users can search for their desired applets by typing the name of the applets in the search bar. The search function will be executed automatically once the users start typing words on the bar.
Next, users can click on the “Install All” green button to install all the applets in the “Private” tab page at once. This can save their time from installing the applets individually.
4.4 My Applets
...
Next, when users click on the “My Applets” tab, they will be directed to a page that shows all the applets they have installed.
5.0 Installing Applets
5.1 Applet Installation Page
Applet Installation Page
When users click on an applet icon in the catalog page, users will be able to read the details of the applet as shown in the screenshot above. The basic information of the applet that are displayed in this page includes:
Name of the applet
Icon of the applet
Platform location where the applet is stored
Rank of the users in using the applet
Tenant Code of the applet
Compatibility of the applet to the users’ device
Average ratings of the appletIcon of the applet
Number of users who rate the applet
In order to install the particular applet, users can click on the green “Install” button in the applet page to perform the installation.
Figure 2. Applet Installation Page - Applet Descriptions
Apart from that, users can view the images and videos that illustrate the features and functionalities of the applet. They can also read the description of the applet from the applet page. By doing that, the users can understand the functions of the applet and the mechanism of using the applet.
Additionally, they are able to know the type of the applet and the ranking of the applet in the Applet Store. For instance, the Stock Transfer applet shown in the screenshot above is labeled as the Business type applet. It is also ranked as the second top grossing applet, meaning the second top applet that generates the highest profit among all the available applets.
Figure 3. Applet Installation Page - Ratings and Reviews
Moreover, users are able to see the rating and reviews of each applet in the installation page of the respective applet. Firstly, the platform will calculate and generate the average user ratings of the applet besides showing the statistics of rating in the form of a horizontal bar chart. It also shows the total number of users who have given the rating.
Next, users can also read the reviews of other users who comment on the applet. Additionally, users can also write their reviews under the reviews section and update their own reviews from time to time.
| Info |
|---|
The applet installation page is still under development. |
5.2 Open or Uninstall Applets
Figure 4. Applet Installation Page - Open or Uninstall the Applet
After that, users can open the applet by clicking on the green “Open” button.
On the other hand, users can choose to uninstall the applet by clicking on the “Uninstall” button in the applet page.
5.3 Access Installed Applets
Figure 5. My Applets Page - Installed Applets
As mentioned previously, users can check their installed applets in the “My Applets” page in the Applet Store as shown in the screenshot above. This helps users to find and manage their installed applets easily. Additionally, applets that are successfully installed by the users will show a small green tick label at the bottom right of its layout as shown in the screenshot above.
Figure 6. Akaun Platform - Installed Applets
Apart from that, users can directly access their installed applets when they log in to the http://akaun.com website as shown in the screenshot above. This helps the users to conveniently access their installed applets without entering the Applet Store.
6.0 Applet Permission Settings
Generally, all applets in the Applet Store share some common features. One of the essential features is the permission setting for an applet. This is because a client who uses the applets may want to set specific permissions to regulate the access control of his employees in using the applets.
Figure 1. Settings Tab
Firstly, users can navigate to the “Settings” tab which is located at the bottom left of every opened applet as shown in the screenshot above to configure their applet settings.
6.1 Permission Set
A permission template is a template that consists of one or multiple permission lines. Every permission line refers to a specific defined permission. For example, permission to create internal sales order invoices.
A permission set is a permission template in which the permission lines are configured to targets. The target can be a branch, company, or location, depending on the permission template. By doing that, the targets are permitted to perform certain operations.
Only users with the ADMIN or OWNER rank in the applet can have read and write access in assigning the permissions to the applet users. Users with MEMBER rank have only read access to the permissions settings in the applet.
Figure 2. Permission Set Page
6.1.1 Create Permission Set
...
Figure 3. Permission Set - Create a Permission Set
Users click on the “+” button to start creating the permission set. After clicking on the button, the Add Permission Set page will appear from the right. Users then fill in the information of the permission set. The information to be filled includes:
Perm Set Name*: The name of the permission set.
Perm Set Code*: The code of the permission set. The code value should be unique and is immutable once it is saved.
Perm Template*: The permission template. A permission template consists of many defined permission lines.
Perm Template*: The permission template. A permission template consists of many defined permission lines.
Status*: Users should select the status “ACTIVE” to use the permission set.
The * symbol indicates information that is compulsory to be filled.
Next, the users have to click on the “Configure Permission Targets” box in order to start linking the permission lines in the selected permission template to the available targets.
Figure 4. Permission Set - Configure Permission Set Lines
A permission template consists of many permission lines. Thus, in the Configure Permission Set Lines page, users can select the permission set lines and assign each of them to a target. The users can proceed by clicking on the permission set line record they want to configure.
Figure 5. Permission Set - Edit Permission Set Line
Then, users will be directed to the Edit Permission Set Line page as shown above.
Under this page, the Permission Code, Permission Targets and Default Target information of the selected permission line are already filled and cannot be modified. The value of the Default Target information varies between Company, Location and Branch, depending on the permission template that is selected.
Users can provide some description for the permission set line. Then, users have to click on the “Select Target” box in order to assign the permission set line to a target.
...
Figure 6. Permission Set - Add Target
Then, users are directed to the Add Target page. In this example, the default target is the company. Thus, the Add Target page shows the information of the available companies. The information includes the Company Code and Company Name. Users can tick only one of the available companies and click the “SAVE” button to link it to the permission set line.
...
Figure 7. Permission Set - Save Edited Permission Set Line
Then, the users will be directed back to the previous page, which is the Edit Permission Set Line page. The target is selected successfully. They can continue to click the “SAVE” button to save the changes.
...
Figure 8. Permission Set - Save the Configured Permission Set
Then, the users will be directed back to the previous page, which is the Configure Permission Set Lines page. Users can repeat the process for the other permission set lines to assign the target to the permission lines respectively.
When all the permissions targets are configured as desired, users can click on the “SAVE” button in the Add Permission Set page to save the changes.
...
Figure 9. Permission Set - Successfully Created
The permission set that is successfully created will appear in the Permission Set page as shown in the screenshot above.
| Info |
|---|
In order to assign the same permission set to multiple targets, the users have to create multiple permission sets. Every permissions set consists of the same permission lines but different naming. Then, users assign each permission set to the respective target. For example:
|
6.1.2 Edit and Delete Permission Set
If the users want to edit or delete a created permission set, users have to click on that permission set record in the Permission Set page. Then, the Edit Permission Set page will appear from the right as shown in the screenshot below, showing the details of the permission set.
...
Figure 10. Permission Set - Edit / Delete Permission Set
Edit the Permission Set:
The process flow of editing a permission set is similar to the process flow of creating the permission set. Users have to click the “SAVE” button in order to save the changes.
Delete the Permission Set:
Users click on the permission set row in the Permission Set page and then click on the “DELETE” button in the Edit Permission Set page to delete the permission set.
6.2 User Permission
...
Figure 11. User Permission Page
The User Permission page stores the information of the users who can access and use the particular applet. These information include the email address, mobile phone number and the rank of the user in using the applet.
Once the users have successfully installed an applet, their information will appear as a new record under the User Permission page of that applet.
6.3 Team Permission
Figure 12. Team Permission Page
The Team Permission page stores the information of the teams who can access and use the particular applet. This information includes the team name, team code and number of members in the team.
6.3.1 Read the Details of the Team
...
Figure 13. Team Permission - Edit Team (Details)
Users can read the details of the team by clicking on the row that represents the team in the Team Permission page. Then, the Edit Team page will appear from the right. Users can read the details of the team from the Edit Team page. However, users cannot edit the information of the team in this page.
6.3.2 Read the Members of the Team
Figure 14. Permission Set - Edit Team (Members)
Next, under the Members tab in the Edit Team page, users can see the information of the members that belong to the team. The information of the members include the email address, mobile phone number and the rank of the members in using the applet.
However, users cannot create new members or edit the information of current members for the team in this page.
6.3.3 Read and Edit the Role for the Team
Figure 15. Permission Set - Edit Team (Role)
Next, under the Role tab in the Edit Team page, users can see the roles that are assigned to the team. The information of the role includes role code, role name and number of permission sets that are assigned to the role.
Figure 16. Team Permission - Edit Role (For Team)
Users are allowed to edit some basic information of the role that is assigned to the team. Firstly, users click onto the role record that they want to edit under the Role tab in the Edit Team page. Then, the Edit Role page will appear from the right as shown in the screenshot above.
Users can edit the role of the team by changing the name and status of the role in the Edit Role page. Users cannot change the role code because the code value is fixed and immutable once it is set. Then, users have to click on the “SAVE” button to save the changes.
6.4 Role Permission
An organization consists of employees with different roles. For example, cashiers, managers, operators, officers and many others. Every role requires specific permissions in using an applet.
Under the Role Permission tab, the admin users can include multiple permissions to a role. Then, the users can assign the role to specific users or teams. By doing that, the admins do not have to manually assign permission to every individual.
Figure 17. Role Permission Page
6.4.1 Create a Role
Figure 18. Role Permission - Create a Role
Firstly, users can click on the “+” button to create a role. Then, the users must input the following information:
Name of the role.
Code of the role. The code of the role must be unique.
Status of the role. Users have to set the status to “ACTIVE” in order to use the role.
Lastly, the users have to click on the “SAVE” button to save the input information for the role. The role will then appear as a new record in the Role Permission tab.
6.4.2 Edit Role Permissions
Details Tab: Edit and Delete Role Information
...
Figure 19. Role Permission - Edit Role (Details)
In order to edit the details of the role that is created, users have to click on that particular role record that appears in the Role Permission page. Then, the Edit Role Permissions page will pop out from the right as shown in the screenshot above. The users can then edit the role information under the Details tab of the page. However, the users cannot edit the role code because the code information is fixed and immutable.
Figure 20. Role Permission - Delete Role (Details)
To delete a role, the users can click on the “DELETE” button under the Details tab to remove the row.
Add or Remove Role to User
21. Role Permission - Load Users
Firstly, users have to navigate to the User tab under the Edit Role Permissions page. Under the User tab, the users can see the list of users that are assigned with the selected role. In order to add new users to the role, users can click on the “+” button to load the list of available users and proceed to assign the users to the particular role.
If users want to remove the existing users from the role, users can tick on the existing users that they want to remove in the Edit Role Permissions page and click the “REMOVE” button to remove the ticked users from the role.
...
22. Role Permission - Add / Remove Users To Role
Then, they will be directed to the Add User page which shows the information of all the available users. They then tick on the users that they want to assign the role to in the Add User page. After selecting all the users, they can click on the “ADD” button to add the users to the particular role.
The users that are added successfully to the role will appear under the User Tab in the Edit Role Permissions page. If the admins want to remove the selected users from the role, they can tick on the users in the Edit Role Permissions page and click the “REMOVE” button to remove the ticked users from the role. Users can tick and remove only one user at a time.
Add or Remove Team to Role
...
23. Role Permission - Load Teams
Firstly, users have to navigate to the Team tab under the Edit Role Permissions page. Under the team tab, the users can see the list of teams that are assigned with the role. In order to add new teams to the role, users can click on the “+” button to load the list of available teams and proceed to assign the teams to the particular role.
If users want to remove the existing teams from the role, users can tick on the existing teams that they want to remove in the Edit Role Permissions page and click the “REMOVE” button to remove the ticked teams from the role. Users can tick and remove only one team at a time.
24. Role Permission - Add / Remove Teams To Role
After clicking on the “+” button, users can tick on the teams that they want to assign the role in the Add Team page. After selecting the teams, they can click on the “ADD” button to add the teams to the particular role.
The teams that are added successfully to the role will appear under the Team tab in the Edit Role Permissions page. If the admins want to remove the selected teams from the role, they can tick on the teams and click the “REMOVE” button to remove the ticked teams from the role.
Add or Remove Permission Set to Role
25. Role Permission - Load the Permission Sets
Most importantly, every role has its own list of permissions. In order to assign the permission set to the created Role, users have to navigate to the Permission Set tab under the Edit Role Permissions page.
Under the Permission Set tab, the users can see the list of permission sets that are assigned with the role. In order to add new permission sets to the role, users can click on the “+” button to load the list of available permission sets and proceed to assign them to the particular role.
If users want to remove the existing permission sets from the role, users can tick on the existing permission sets that they want to remove in the Edit Role Permissions page and click the “REMOVE” button to remove the ticked permission sets from the role. Users can tick and remove only one permission set at a time.
...
26. Role Permission - Add / Remove The Permission Sets To Role
Then, they can tick on the permission sets that they want to assign to the role in the Add Permission Set page. After selecting all the permission sets, they can click on the “ADD” button to add the permission sets to the particular role.
The permission sets that are successfully added to the role will appear under the Permission Set tab in the Edit Role Permissions page. If the admins want to remove the selected permission sets from the role, they can tick on the permission sets and click the “REMOVE” button to remove the ticked permission sets from the role.
7.0 Leaving the Applet Store
...
Figure 1. Leaving the Applet Store
Finally, users can leave the Applet Store by clicking on the “akaun” tab as indicated by the red square in the screenshot above. This feature performs a back function for users to leave the Applet Store from the Catalog page.