Skip to content

Commit 4912fba

Browse files
authored
Merge branch 'next' into QT-232
2 parents 8a71d5f + 6f4f35b commit 4912fba

File tree

3 files changed

+122
-1
lines changed

3 files changed

+122
-1
lines changed

plugins/hooks/README.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Countly Hooks Plugin
2+
3+
The Hooks plugin provides powerful automation for integrating Countly data with external systems. This plugin can trigger external HTTP endpoints based on internal events and incoming data, and send automated email notifications for events like user profile updates or users entering a cohort. Hooks offers a new way to feed external systems with Countly data, enabling real-time interactions and automating workflows.
4+
5+
## File Structure
6+
7+
```javascript
8+
hooks/ # Main hooks plugin directory
9+
├── api/ # Backend API logic
10+
│ ├── jobs/ # Job scheduling logic
11+
│ │ └── schedule.js # Handles scheduling tasks
12+
│ └── parts/ # Logic for effects and triggers
13+
│ ├── effects/ # Different types of effects used in hooks
14+
│ │ ├── custom_code.js # Handles custom code execution
15+
│ │ ├── email.js # Manages email-related hooks
16+
│ │ ├── http.js # HTTP requests for hooks
17+
│ │ └── index.js # Effect index for organization
18+
│ └── triggers/ # Triggers for executing hooks
19+
│ ├── api_endpoint.js # API endpoint trigger
20+
│ ├── incoming_data.js # Triggers for incoming data
21+
│ ├── internal_event.js # Internal event trigger
22+
│ ├── scheduled.js # Trigger for scheduled tasks
23+
│ └── index.js # Trigger index file
24+
├── api.js # Main API logic for backend requests
25+
├── testData.js # Sample test data for hooks
26+
├── utils.js # Utility functions for hooks
27+
├── frontend/ # Frontend resources
28+
│ ├── public/ # Publicly accessible files
29+
│ │ ├── javascripts/ # JavaScript for frontend logic
30+
│ │ │ ├── countly.hooks.effects.js # Effect logic for frontend hooks
31+
│ │ │ ├── countly.models.js # Model definitions for hooks
32+
│ │ │ └── countly.views.js # View logic for rendering hooks
33+
│ │ ├── localization/ # Localization files for translations
34+
│ │ ├── stylesheets/ # CSS and SCSS for styling hooks UI
35+
│ │ │ ├── vue-main.css # Compiled CSS for UI
36+
│ │ │ └── vue-main.scss # Source SCSS file for styling
37+
│ │ └── templates/ # HTML templates for UI components
38+
│ │ ├── vue-drawer.html # Drawer UI for hooks
39+
│ │ ├── vue-effects.html # Effects UI template
40+
│ │ ├── vue-hooks-detail-error-table.html # Template for error table
41+
│ │ ├── vue-hooks-detail.html # Detail view of individual hooks
42+
│ │ ├── vue-main.html # Main template for hooks
43+
│ │ └── vue-table.html # Table template for hooks display
44+
│ └── app.js # Main frontend application logic
45+
├── install.js # Installation script for the plugin
46+
├── package-lock.json # Lock file for Node.js dependencies
47+
├── package.json # Package configuration for Node.js
48+
├── tests.js # Test scripts for validating hooks functionality
49+
└── uninstall.js # Uninstallation script for removing the plugin
50+
```
51+
52+
## Installation
53+
54+
1. Navigate to the directory where the Hooks plugin is located. This could be a relative or absolute path depending on your environment setup:
55+
56+
```bash
57+
cd /path/to/your/project/hooks
58+
```
59+
60+
2. Install dependencies:
61+
62+
```bash
63+
npm install
64+
```

plugins/systemlogs/frontend/public/localization/systemlogs.properties

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,4 +76,5 @@ systemlogs.action.cb-content_asset-uploaded = Content Builder Asset Uploaded
7676
systemlogs.action.cb-content_asset-deleted = Content Builder Asset Deleted
7777
systemlogs.action.cb-content_block-edit = Content Builder Block Edited
7878
systemlogs.action.cb-content_block-create = Content Builder Block Created
79-
systemlogs.action.cb-content_block-delete = Content Builder Block Deleted
79+
systemlogs.action.cb-content_block-delete = Content Builder Block Deleted
80+
systemlogs.action.journey-engine-event-created = Journey Engine Event Created

plugins/times-of-day/README.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Countly times-of-day plugin
2+
3+
The Times of Day plugin provides a visual representation of user activity based on local time, offering a scatter plot chart that shows when sessions and events occur across different days of the week.
4+
5+
## File Structure
6+
7+
```javascript
8+
times-of-day/
9+
├── api/ # Backend API logic
10+
│ └── api.js # Main API file handling backend requests and responses
11+
├── frontend/ # Frontend resources
12+
│ ├── public/ # Publicly accessible resources
13+
│ │ ├── images/ # Images used in the plugin
14+
│ │ │ └── times-of-day/ # Folder for times-of-day related images
15+
│ │ │ └── times-of-day.svg # SVG image for times-of-day widget
16+
│ │ ├── javascripts/ # JavaScript files for frontend logic
17+
│ │ │ ├── countly.models.js # Model definitions for data handling
18+
│ │ │ ├── countly.views.component.common.js # Common view component logic
19+
│ │ │ └── countly.views.js # View definitions for rendering
20+
│ ├── localization/ # Localization files for multi-language support
21+
│ ├── stylesheets/ # Stylesheets for styling the plugin
22+
│ │ ├── main.css # Compiled CSS for styling
23+
│ │ ├── main.css.map # Source map for the CSS file
24+
│ │ └── main.scss # Main SCSS stylesheet
25+
│ ├── templates/ # HTML templates for UI components
26+
│ │ ├── times-of-day-widget-drawer.html # Drawer template for the times-of-day widget
27+
│ │ ├── times-of-day-widget.html # Main template for the times-of-day widget
28+
│ │ └── times-of-day.html # Template for times-of-day display
29+
├── app.js # Main application logic for the frontend
30+
├── install.js # Installation script for the plugin
31+
├── package-lock.json # Lock file for Node.js dependencies
32+
├── package.json # Package configuration file for Node.js
33+
├── tests.js # Test scripts for validating functionality
34+
└── uninstall.js # Uninstallation script for removing the plugin
35+
```
36+
37+
## Key Features
38+
39+
- **Visual User Activity Mapping**: TDisplays a scatter plot chart showing when user sessions and events occur throughout the day, providing a clear visual representation of user activity patterns.
40+
- **Data Type Filters**: Allows filtering the data by Sessions, Events, Consent, and Push Actioned, giving flexibility in analyzing different types of user interactions
41+
- **Custom Time Ranges**: Enables selection of different time periods (e.g., All Time, Last 30 Days) to adjust the data view to fit your specific analysis needs.
42+
- **Localized Time Representation**: Displays user activity based on their local time zone, making it easier to track engagement across different regions
43+
44+
## Installation
45+
46+
1. Navigate to the directory where the times-of-day plugin is located. This could be a relative or absolute path depending on your environment setup:
47+
48+
```bash
49+
cd /path/to/your/project/times-of-day
50+
```
51+
52+
2. Install dependencies:
53+
54+
```bash
55+
npm install
56+
```

0 commit comments

Comments
 (0)