Skip to content

Commit da81b67

Browse files
committed
refactor: getting started guides
1 parent 07fe29e commit da81b67

File tree

5 files changed

+88
-118
lines changed

5 files changed

+88
-118
lines changed

docs/getting-started/database/backup-restore.md

Lines changed: 17 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -5,42 +5,38 @@ slug: /getting-started/database/backup-restore
55
tags: ["SQL Account", "Getting Started", "Database"]
66
---
77

8-
98
SQL Account provides users with the option to backup their database into their local computer or a cloud drive storage. Users can perform backups as frequently as daily or weekly and have full ownership over their backups, allowing them to restore them at any time without additional charges.
109

1110
## Why must I backup my database?
1211

1312
In any situation, it is always useful to have a backup copy of your work. Regularly backing up your SQL Account data is beneficial for several reasons:
1413

1514
1. Faster data recovery in emergency situations
16-
1715
2. Ability to perform cross checking and comparisons with past data
18-
1916
3. Protection against ransomware attacks and cyber crimes
20-
2117
4. Easy and secure sharing of data within the company
2218

2319
## Local Backup
2420

2521
### Backup
2622

27-
1. Go to **File** > **Backup Database**
23+
1. Go to **File** > **Backup Database**.
2824

2925
![1](../../../static/img/getting-started/database/backup-restore/1.png)
3026

31-
2. Click on the "**+**" icon | select "**Add Local Storage**" (You may select multiple storage locations.)
27+
2. Click on the "**+**" icon, select "**Add Local Storage**" (You may select multiple storage locations).
3228

3329
![2](../../../static/img/getting-started/database/backup-restore/2.png)
3430

35-
3. Choose where you want to save your backup file
31+
3. Choose where you want to save your backup file.
3632

3733
![3](../../../static/img/getting-started/database/backup-restore/3.png)
3834

3935
4. Click **Backup**
4036

41-
**Compress Backup File** : This option will put the backup file into a ZIP file.
37+
**Compress Backup File**: This option will put the backup file into a ZIP file.
4238

43-
**Best Compression Mode** : Takes longer time than normal backup, but the file size will be smaller.
39+
**Best Compression Mode**: Takes longer time than normal backup, but the file size will be smaller.
4440

4541
![4](../../../static/img/getting-started/database/backup-restore/4.png)
4642

@@ -58,7 +54,7 @@ In any situation, it is always useful to have a backup copy of your work. Regula
5854

5955
![7](../../../static/img/getting-started/database/backup-restore/7.png)
6056

61-
2. Click **Restore…**
57+
2. Click **Restore…**.
6258

6359
![8](../../../static/img/getting-started/database/backup-restore/8.png)
6460

@@ -74,7 +70,7 @@ In any situation, it is always useful to have a backup copy of your work. Regula
7470

7571
![11](../../../static/img/getting-started/database/backup-restore/11.png)
7672

77-
6. Click **OK**
73+
6. Click **OK**.
7874

7975
![12](../../../static/img/getting-started/database/backup-restore/12.png)
8076

@@ -93,11 +89,8 @@ What is AI Cloud Backup? AI Cloud backup is one of SQL’s latest services that
9389
### Benefits
9490

9591
1. Secure and encrypted storage.
96-
9792
2. Regulated security practices with frequent ransomware screening and server health analysis.
98-
9993
3. Backup and restore anytime, anywhere.
100-
10194
4. Ai Smart Recycle feature – removes older daily backups to utilizes cloud storage space.
10295

10396
### Cloud Backup
@@ -106,27 +99,26 @@ What is AI Cloud Backup? AI Cloud backup is one of SQL’s latest services that
10699
Please contact your SQL Agent to register a SQL Drive account beforehand.
107100
:::
108101

109-
1. Go to **File** > **Backup Database**
102+
1. Go to **File** > **Backup Database**.
110103

111104
![15](../../../static/img/getting-started/database/backup-restore/1.png)
112105

113-
2. Click on "**+**" and **Add Cloud Storage**
106+
2. Click on "**+**" and **Add Cloud Storage**.
114107

115108
![16](../../../static/img/getting-started/database/backup-restore/15.png)
116109

117-
3. Click on **Login** > **Login with Google** > Type in your email address and password > **Grant access**
110+
3. Click on **Login** > **Login with Google** > Type in your email address and password > **Grant access**.
118111

119112
![17](../../../static/img/getting-started/database/backup-restore/16.png)
120113

121114
![18](../../../static/img/getting-started/database/backup-restore/17.png)
122115

123116
![19](../../../static/img/getting-started/database/backup-restore/18.png)
124117

125-
4. Click **Backup**
126-
127-
**Compress Backup File** : This option will put the backup file into a ZIP file.
118+
4. Click **Backup**.
128119

129-
**Best Compression Mode** : Takes longer time than normal backup, but the file size will be smaller.
120+
**Compress Backup File**: This option will put the backup file into a ZIP file.
121+
**Best Compression Mode**: Takes longer time than normal backup, but the file size will be smaller.
130122

131123
![20](../../../static/img/getting-started/database/backup-restore/19.png)
132124

@@ -136,19 +128,19 @@ Please contact your SQL Agent to register a SQL Drive account beforehand.
136128

137129
### Cloud Restore
138130

139-
1. Press the ⚙️ button at bottom right
131+
1. Press the ⚙️ button at bottom right.
140132

141133
![22](../../../static/img/getting-started/database/backup-restore/7.png)
142134

143-
2. Click **Restore…** (with Cloud icon)
135+
2. Click **Restore…** (with Cloud icon).
144136

145137
![23](../../../static/img/getting-started/database/backup-restore/21.png)
146138

147-
3. Select your Backup File and click **OK**
139+
3. Select your Backup File and click **OK**.
148140

149141
![24](../../../static/img/getting-started/database/backup-restore/22.png)
150142

151-
4. Click **OK**
143+
4. Click **OK**.
152144

153145
![25](../../../static/img/getting-started/database/backup-restore/23.png)
154146

docs/getting-started/database/clone.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -9,58 +9,58 @@ Database clone will copy all maintenance files, such as the chart of accounts, c
99

1010
## Instruction
1111

12-
1. Double click SQL Icon > Press ⚙️ Button
12+
1. Double click SQL Icon > Press ⚙️ Button
1313

14-
![1](../../../static/img/getting-started/database/clone-master/1.png)
14+
![1](../../../static/img/getting-started/database/clone-master/1.png)
1515

16-
2. Hover over the company name you wish to copy master data and **right click** on it
16+
2. Hover over the company name you wish to copy master data and **right click** on it
1717

18-
![2](../../../static/img/getting-started/database/clone-master/2.png)
18+
![2](../../../static/img/getting-started/database/clone-master/2.png)
1919

20-
3. Select **Clone Database**
20+
3. Select **Clone Database**
2121

22-
![3](../../../static/img/getting-started/database/clone-master/3.png)
22+
![3](../../../static/img/getting-started/database/clone-master/3.png)
2323

24-
4. Enter the ADMIN password > **OK**
24+
4. Enter the ADMIN password > **OK**
2525

26-
![4](../../../static/img/getting-started/database/clone-master/4.png)
26+
![4](../../../static/img/getting-started/database/clone-master/4.png)
2727

28-
5. Select **Clone Master Data only(Beta)**
28+
5. Select **Clone Master Data only(Beta)**
2929

30-
![5](../../../static/img/getting-started/database/clone-master/5.png)
30+
![5](../../../static/img/getting-started/database/clone-master/5.png)
3131

32-
6. Press **OK**
32+
6. Press **OK**
3333

34-
![6](../../../static/img/getting-started/database/clone-master/6.png)
34+
![6](../../../static/img/getting-started/database/clone-master/6.png)
3535

36-
7. After the clone is done, you will found message **Elapsed time : x.xxxx seconds** > **Close**
36+
7. After the clone is done, you will found message **Elapsed time : x.xxxx seconds** > **Close**
3737

38-
![7](../../../static/img/getting-started/database/clone-master/7.png)
38+
![7](../../../static/img/getting-started/database/clone-master/7.png)
3939

40-
8. Once cloning is completed, you will found 1 **new company** on **last icon** (with the same name as the company you selected to clone) > **Double Click It .**
40+
8. Once cloning is completed, you will found 1 **new company** on **last icon** (with the same name as the company you selected to clone) > **Double Click it.**
4141

42-
![8](../../../static/img/getting-started/database/clone-master/8.png)
42+
![8](../../../static/img/getting-started/database/clone-master/8.png)
4343

44-
9. Enter Password ( Follow your old Company password) > Click **Log on**
44+
9. Enter Password ( Follow your old Company password) > Click **Log on**
4545

46-
![9](../../../static/img/getting-started/database/clone-master/9.png)
46+
![9](../../../static/img/getting-started/database/clone-master/9.png)
4747

48-
10. After Log on > go **File** > **Company Profile** to rename Company name .
48+
10. After Log on > go to **File** > **Company Profile** to rename Company name.
4949

50-
![10](../../../static/img/getting-started/database/clone-master/10.png)
50+
![10](../../../static/img/getting-started/database/clone-master/10.png)
5151

52-
11. After renaming > press on **Save**
52+
11. After renaming > press on **Save**
5353

54-
![11](../../../static/img/getting-started/database/clone-master/11.png)
54+
![11](../../../static/img/getting-started/database/clone-master/11.png)
5555

56-
12. Go to **Tools** > **Analyse Data integrity**
56+
12. Go to **Tools** > **Analyse Data integrity**
5757

58-
![12](../../../static/img/getting-started/database/clone-master/12.png)
58+
![12](../../../static/img/getting-started/database/clone-master/12.png)
5959

60-
13. Press **Start Analyse**
60+
13. Press **Start Analyse**
6161

62-
![14](../../../static/img/getting-started/database/clone-master/14.png)
62+
![14](../../../static/img/getting-started/database/clone-master/14.png)
6363

64-
14. Press **OK**
64+
14. Press **OK**
6565

66-
![13](../../../static/img/getting-started/database/clone-master/13.png)
66+
![13](../../../static/img/getting-started/database/clone-master/13.png)

docs/getting-started/multi-user-setup.md

Lines changed: 35 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -14,90 +14,69 @@ For a multi-user scenario, a separated database server is recommended. It will s
1414

1515
### Firebird Installation
1616

17-
1. Visit [download page](http://www.sql.com.my/support/downloads) to download `Firebird`.
17+
1. Visit [download page](http://www.sql.com.my/support/downloads) to download `Firebird`.
1818

19-
2. If Window System Type is 64 Bits, please download `Firebird 3.0.x` **64 bit (x64)**
19+
2. If Window System Type is 64 Bits, please download `Firebird 3.0.x` **64 bit (x64)**
2020

21-
![1](../../static/img/getting-started/multiuser-setup/1.png)
21+
![1](../../static/img/getting-started/multiuser-setup/1.png)
2222

23-
3. Run Firebird setup | Press **Ok** | Select **I accept the agreement** | Click 5 times **Next** | Make sure it is "**Run Firebird in SuperServer Mode**"
23+
3. After downloading the Firebird executable, run it. Press **OK** to open the Terms and Conditions interface, check **I accept the agreement**, and click **Next**. Continue clicking **Next** until you reach the screen shown below. Ensure that the **Run Firebird in SuperServer Mode** option is selected, and that all other options are deselected.
2424

25-
![2](../../static/img/getting-started/multiuser-setup/2.png)
25+
![2](../../static/img/getting-started/multiuser-setup/2.png)
2626

27-
4. Leave it blank to use default password of master key.
27+
4. Leave it blank to use default password, and click **Next**.
2828

29-
![3](../../static/img/getting-started/multiuser-setup/3.png)
29+
![3](../../static/img/getting-started/multiuser-setup/3.png)
3030

31-
5. Click on **Next** | **Install** | **Next** | Click on **Finish** to complete
31+
5. Continue with the setup until you reach the screen with a button **Finish**. Click on the button to complete.
3232

3333
### Network Setup
3434

3535
1. Window Firewall
3636

37-
1. Control Panel | Window Firewall | Advanced Settings | Inbound Rules | New Rules
38-
39-
2. Select Port | Next | TCP | Specific Local Port = 3050 | Next | Next | Next
40-
41-
3. Name = Firebird | Finish
37+
1. In windows, search for **Control Panel**, open it. Next, navigate to **Window Firewall** > **Advanced Settings** > **Inbound Rules**, select **New Rules**.
38+
2. Among the options, select **Port**. Click _Next_.
39+
3. Select **TCP**, for the **Specific Local Port**, fill in **3050**. Click _Next_ continuosly until you reach the screen to give it a name.
40+
4. Name it **Firebird** and click _Finish_.
4241

4342
2. Network and Sharing Center
4443

45-
1. Control Panel | Network and Sharing Center | Change Advanced sharing Settings
46-
47-
2. Network Discovery
48-
49-
- Turn on Network Discovery
50-
51-
3. File and Printer Sharing
52-
53-
- Turn on sharing so anyone with network access can read and write files in the public folders
54-
55-
4. Public Folder Sharing
56-
57-
- Turn on Sharing so anyone with network access can read and write files in the Public folders
58-
59-
5. File Sharing Connection
44+
1. In windows, search for **Control Panel**, run it. Navigate to **Network and Sharing Center** > **Change Advanced Sharing Settings**.
45+
2. Configure each settings as follows:
6046

61-
- Use 128-bit encryption to help protect file sharing connections(recommended)
62-
63-
6. Password Protected Sharing
64-
65-
- Turn off password protected sharing
47+
| Settings | Action |
48+
| -------------------------- | ------------------------------------------------------------------------------------------- |
49+
| Network Discovery | Switch on |
50+
| File and Printer Sharing | Switch on to allow others on the network to access shared files and printers on this device |
51+
| Public Folder Sharing | Switch on to allow others on the network to read write files in Public folders |
52+
| File Sharing Connection | Use 128-bit encryption for devices that support it for enhanced security |
53+
| Password Protected Sharing | Switch off |
6654

6755
3. Share the SQL Account or Payroll Folder
6856

69-
1. My Computer | Go to C:\eStream\SQLAccounting\Share or Go to C:\eStream\SQL Payroll\Share | Right Click | Properties | Sharing Tab | Advanced Sharing | Tick Share this Folder | Click Permissions | Tick Full Control | Press OK until the end.
70-
71-
2. Click on **Security** Tab | Click **Advanced** | Click on **Change Permissions** | Click **Add** Button | At empty Box enter : Everyone | Press **OK** | Tick **Allow Full Control** | Press **OK** until the end.
57+
1. Search **explorer** in windows, run it. Go to your share folder (e.g. `C:\eStream\SQLAccounting\Share` or `C:\eStream\SQL Payroll\Share`), right click on it and select **Properties**. It has a few tabs, navigate to **Sharing** > **Advanced Sharing**. Tick **Share this Folder**, click on **Permissions** and select **Full Control**. Press **OK** to close the **Permission** dialog box.
58+
2. Next, navigate to the **Security** tab, click on **Advanced**. In the advanced window, click on **Change Permissions** follow by the **Add** Button. In the empty box enter, type **Everyone** and press **OK**. Besides, tick **Allow Full Control** and press **OK** to close the window.
7259

7360
4. Install SQL Account or Payroll
7461

75-
1. Run SQL Account or Payroll Setup | Click **Next** | Choose **I Select the Agreement** | Click **Next**
76-
77-
2. Amend to C:\eStream\SQLAccounting or C:\eStream\SQL Payroll | Click Next | 3 times | Install | Click Finish
78-
79-
3. Create Group | Click **DCF Group** | Click **Save** Button
80-
81-
4. Database Engine = Firebird Server | Click **Test Connection**, if the status shown in blue color, press **OK**
82-
83-
5. Double check your settings as below and click **OK**
84-
85-
:::info
86-
Default Database Username is **SYSDBA**, Database Password is **MASTERKEY**
87-
:::
62+
1. After downloading the executable, double click on it to run.
63+
2. Follow on the dialog, adjust according to your environment.
64+
3. After finish installed, open the application. Click on **Create Group** > **DCF Group**. Give it a name and save.
65+
4. Next, configure the **Database Engine** to be **Firebird Server** and click **Test Connection**, if you see a blue color message, it means the setup succeed.
66+
5. Scan through the rest of settings. After confirmed click **OK**.
8867

89-
![4](../../static/img/getting-started/multiuser-setup/4.png)
68+
![4](../../static/img/getting-started/multiuser-setup/4.png)
9069

9170
## Client PC Setup
9271

93-
1. Run SQL Account or Payroll Setup | Click **Next** | Choose **I Select the Agreement** | Click **Next** 4 times | **Install** | Click **Finish**
72+
1. In client pc, we will also need to install the application. Repeat the installation steps and execute it after installed.
9473

95-
2. **Add Group** | Click **DCF File**
74+
2. Click on **Add Group** > **DCF File**.
9675

97-
3. Select Share folder (At Step 4)| Select Default DCF
76+
3. Select the DCF file from the public share folder created in previous step.
9877

99-
![5](../../static/img/getting-started/multiuser-setup/5.png)
78+
![5](../../static/img/getting-started/multiuser-setup/5.png)
10079

101-
![6](../../static/img/getting-started/multiuser-setup/6.png)
80+
![6](../../static/img/getting-started/multiuser-setup/6.png)
10281

103-
4. Click on Firebird icon and Logon as usual.
82+
4. Click on firebird icon and login as usual.

docs/getting-started/setup.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -141,11 +141,11 @@ tags: ["SQL Account", "Getting Started", "Setup"]
141141

142142
## Create New Group
143143

144-
1. Click on "**Back to Database Group**"
144+
1. Click on "**Back to Database Group**".
145145

146146
![create-new-group-1](../../static/img/getting-started/setup/create-new-group-1.png)
147147

148-
2. Click **Create Group**
148+
2. Click **Create Group**.
149149

150150
![create-new-group-2](../../static/img/getting-started/setup/create-new-group-2.png)
151151

@@ -156,9 +156,8 @@ tags: ["SQL Account", "Getting Started", "Setup"]
156156
5. Select the **Database Folder** & click Ok.
157157

158158
:::info
159-
**Group**: Default location is at `C:\estream\SQLAccounting\Share`
160-
161-
**Database**: Default location is at `C:\estream\SQLAccounting\DB`
159+
**Group**: Default location is at `C:\estream\SQLAccounting\Share`
160+
**Database**: Default location is at `C:\estream\SQLAccounting\DB`
162161
:::
163162

164163
![create-new-group-3](../../static/img/getting-started/setup/create-new-group-3.png)

docs/getting-started/upgrade.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,9 @@ If your company has multiple users, upgrade the server first before upgrading in
4646

4747
1. **Download SQL Latest version and save it to desktop , double click the installer**
4848

49-
:::success[INFO]
50-
get the latest version installer from your service consultant
51-
:::
49+
:::success[INFO]
50+
get the latest version installer from your service consultant
51+
:::
5252

5353
![7](../../static/img/getting-started/upgrade-sql/7.png)
5454

@@ -86,4 +86,4 @@ If your company has multiple users, upgrade the server first before upgrading in
8686

8787
10. Click **Yes** to upgrade your database > Done
8888

89-
![15](../../static/img/getting-started/upgrade-sql/16.png)
89+
![15](../../static/img/getting-started/upgrade-sql/16.png)

0 commit comments

Comments
 (0)