Skip to content

Commit 3f8594e

Browse files
committed
Updated entity history document according to recent changes
1 parent ab76087 commit 3f8594e

7 files changed

Lines changed: 14 additions & 6 deletions

docs/en/Features-Angular-Entity-History.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,14 @@ In change logs under audit logs menu, we can see all change logs (entity history
44

55
<img src="images/change-logs-core.png" alt="Change Logs" class="img-thumbnail" />
66

7-
When we click the magnifier icon, we can see all the details about a change log:
7+
When we click on the **View Change** field in the Actions button, we can see all the details of a change log:
88

99
<img src="images/entity-history-log-detail.png" alt="Change Log Detail" class="img-thumbnail" />
1010

11+
When we click on the **All Changes** button in the Actions section, we can see all the details of the changes made to the entity in a timeline.
12+
13+
<img src="images/entity-history-timeline-detail.png" alt="Entity History Timeline Detail" class="img-thumbnail" />
14+
1115
You should add entity type that you want to track to ***.Core\EntityHistory\EntityHistoryHelper.TrackedTypes**. Make sure you uncomment following lines in ***.EntityFrameworkCore\EntityFrameworkCore\{YourProjectName}EntityFrameworkCoreModule.cs** and set **Configuration.EntityHistory.IsEnabled** to **true**.
1216

1317
```csharp

docs/en/Features-Mvc-Core-Entity-History.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,14 @@ In change logs under audit logs menu, we can see all change logs (entity history
44

55
<img src="images/change-logs-core.png" alt="Change Logs" class="img-thumbnail" />
66

7-
When we click the magnifier icon, we can see all the details about a change log:
7+
When we click on the **View Change** field in the Actions button, we can see all the details of a change log:
88

99
<img src="images/entity-history-log-detail.png" alt="Change Log Detail" class="img-thumbnail" />
1010

11+
When we click on the **All Changes** button in the Actions section, we can see all the details of the changes made to the entity in a timeline.
12+
13+
<img src="images/entity-history-timeline-detail.png" alt="Entity History Timeline Detail" class="img-thumbnail" />
14+
1115
You should add entity type that you want to track to ***.Core\EntityHistory\EntityHistoryHelper.TrackedTypes**. Make sure you uncomment following lines in ***.EntityFrameworkCore\EntityFrameworkCore\{YourProjectName}EntityFrameworkCoreModule.cs** and set **Configuration.EntityHistory.IsEnabled** to **true**.
1216

1317
```csharp
@@ -19,17 +23,17 @@ Configuration.EntityHistory.IsEnabled = false;
1923
// Configuration.CustomConfigProviders.Add(new EntityHistoryConfigProvider(Configuration));
2024
```
2125

22-
The first commented line here adds entity types defined in `EntityHistoryHelper.TrackedTypes` to entity history config, so changes on those entities will be recorded. The second commented line adds a custom config provider to `CustomConfigProviders` list. ASP.NET Zero executes `GetConfig` method of each `CustomConfigProvider` and returns the result of `GetConfig` to Angular client app.
26+
The first commented line here adds entity types defined in `EntityHistoryHelper.TrackedTypes` to entity history config, so changes on those entities will be recorded. The second commented line adds a custom config provider to `CustomConfigProviders` list. ASP.NET Zero executes `GetConfig` method of each `CustomConfigProvider` and returns the result of `GetConfig` to MVC client app.
2327

24-
So, in this particular case, `EntityHistoryConfigProvider` returns if entity history feature is enabled or not and if enabled, it returns list of entities enabled for entity history. Angular client app uses those information to show entity history related buttons on each entity page.
28+
So, in this particular case, `EntityHistoryConfigProvider` returns if entity history feature is enabled or not and if enabled, it returns list of entities enabled for entity history. MVC client app uses those information to show entity history related buttons on each entity page.
2529

26-
For example, when entity history is enabled for an Entity, Angular client shows history dropdown menu item for each entity record on the related page. Here is a sample screenshot for role list:
30+
For example, when entity history is enabled for an Entity, MVC client shows history dropdown menu item for each entity record on the related page. Here is a sample screenshot for role list:
2731

2832
<img src="images/change-logs-history-action-item.png" alt="Entity History Action" class="img-thumbnail" />
2933

3034
In this way, history of an entity can be retrieved both on change logs tab in audit logs page or on the list page of the entity itself.
3135

32-
The entity history config can be accessed on the Angular app like below:
36+
The entity history config can be accessed on the MVC app like below:
3337

3438
```javascript
3539
abp.custom.EntityHistory
110 KB
Loading
11.4 KB
Loading
109 KB
Loading
100 KB
Loading
143 KB
Loading

0 commit comments

Comments
 (0)