diff --git a/docs/administration/fabric-studio/database-management.md b/docs/administration/fabric-studio/database-management.md new file mode 100644 index 00000000..efadb940 --- /dev/null +++ b/docs/administration/fabric-studio/database-management.md @@ -0,0 +1,58 @@ +--- +title: Database Management +--- + +# Database Management + +## Import CSV Data +1. Navigate to the "Database" tab in the sub-menu +2. Select the desired database and table. If no tables exist, create a new table first. +3. Click the "Import CSV" button located above the table view. +4. Select/Drag-and-drop the CSV file from your local machine. +5. Click the "Upload CSV" button to import the data into the selected table. +6. The data will be uploaded and displayed in the table view. This may take a few moments depending on the size of the file. +7. Refresh the table view by clicking the "Refresh" button if necessary. + +## Add a New Record +1. Navigate to the "Database" tab in the sub-menu +2. Select the desired database and table. +3. Click the "Add New Record" button located above the table view. +4. Fill in the necessary fields in the form that appears.(These fields will correspond to the columns/schema in the selected table.) +5. Click the "Save" button to add the new record to the table. + +## Create a New Table +1. Navigate to the "Database" tab in the sub-menu +2. Select the desired database. +3. Click the "Create a Table" button located to the left of the table view. +4. Fill in the: + - Table Name: The name of the new table. + - Primary Key: The primary key field for the table. + - Database Name: The database where the table will be created.(Will automatically fill based upon the selected database where the table is being created.) +5. Click the "Create New Table" button to create the new table. +6. The new table will appear in the table list on the left side of the screen. + +## Delete a Table +1. Navigate to the "Database" tab in the sub-menu +2. Select the desired database and table. +3. Click the three dots button located above the table view on the top right. +4. Select "Drop Table" from the dropdown menu. +5. Confirm the deletion by clicking the "Drop" button in the confirmation dialog. +6. The table will be deleted from the database. + +## Delete a Record +1. Navigate to the "Database" tab in the sub-menu +2. Select the desired database and table. +3. Locate the record you want to delete in the table view. +4. Click the record and a modal will appear. +5. Click the "Delete Row" button in the modal to confirm the deletion. +6. The record will be deleted from the table. + + +## Edit a Record +1. Navigate to the "Database" tab in the sub-menu +2. Select the desired database and table. +3. Locate the record you want to edit in the table view. +4. Click the record and a modal will appear. +5. Edit the fields as necessary in the modal. +6. Click the "Save Changes" button to save the changes to the record. +7. The updated record will be displayed in the table view. diff --git a/docs/administration/fabric-studio/logging.md b/docs/administration/fabric-studio/logging.md new file mode 100644 index 00000000..ead748c8 --- /dev/null +++ b/docs/administration/fabric-studio/logging.md @@ -0,0 +1,31 @@ +--- +title: Logging +--- + +# Logging + +## Log Filtering +Log filtering allows users to customize the log output based on specific criteria. This can help in isolating relevant information and reducing noise in the logs list. +To filter logs: +1. Navigate to the "Logs" section in Fabric Studio. +2. Use the filter options available at the left side menu logs list to specify criteria such as: + - Log Limit: The maximum number of log entries to display(e.g. 10, 100, 250, 500, 1000) (default is 100) + - Log Level (e.g., Error, Warn, Info, Debug, Trace, Notify, All) (default is All) + - Start Date: The beginning date and time for the log entries to display + - End Date: The ending date and time for the log entries to display + +3. Click the "Apply Filters" button to update the log list based on the selected criteria. +4. The log list will refresh to show only the entries that match the specified filters. + + +## Log Details +To view detailed information about a specific log entry: +1. Navigate to the "Logs" section in Fabric Studio. +2. Click on a log entry in the logs list to open the log details modal. +3. The log details modal will display comprehensive information about the selected log entry, including: + - Timestamp: The date and time when the log entry was created + - Level: The severity level of the log entry (e.g., Error, Warn) + - Thread: The thread identifier where the log entry originated + - Tags: Any associated tags for categorizing the log entry + - Message: The main content of the log entry +4. Review the information in the modal to gain insights into the specific event or issue recorded in the log entry. diff --git a/docs/administration/fabric-studio/managing-applications.md b/docs/administration/fabric-studio/managing-applications.md index 979247da..02202225 100644 --- a/docs/administration/fabric-studio/managing-applications.md +++ b/docs/administration/fabric-studio/managing-applications.md @@ -27,8 +27,8 @@ To import an existing application: ## Updating an application To update an existing application: 1. Select "Applications" from the menu if not already there -2. Click the three dots to the right of the application you wish to update -3. Select "Update Application" from the dropdown menu -4. Enter the "Package Reference URL" (must be a valid URL) -5. Click "Update"( **Note**: this will prompt the cluster to restart) -6. Your application will be updated +2. Click the top level name of the application in the applications list +3. Select "Redeploy Application" +4. Enter the new "Package Reference URL" (must be a valid URL) +5. Click "Redeploy"( **Note**: this will prompt the cluster to restart) +6. Your application will be updated and redeployed. diff --git a/docs/administration/fabric-studio/organization-management.md b/docs/administration/fabric-studio/organization-management.md new file mode 100644 index 00000000..772da59c --- /dev/null +++ b/docs/administration/fabric-studio/organization-management.md @@ -0,0 +1,36 @@ +--- +title: Organization Management +--- + +# Organization Management +Organizations can be managed in a variety of ways, including: roles and user permissions, adding/removing users, creating new environments (clusters) and updating billing information. + +## Role Management +Organizations can be made up of many users, each with different roles and permissions. Roles and permissions can be created and managed by the organization admin. + +### Creating a new role +1. Navigate to the organization page +2. Click "Roles" in the menu on top of screen +3. User will be navigated to role table +4. Note: “admin” will appear in role table as default role, with 1 user (creator) assigned. Admins can update and delete organizations +5. Click on “+ Add” button in top right corner and a modal will appear +6. Enter role information: + - Role Name: name of the new role + - Can update organization: toggle on/off + - Can delete organization: toggle on/off + - JSON Permissions: enter custom JSON permissions +7. Click "Save Changes" button to create new role +Create and customize as many roles as appropriate for organization + +### User management + +1. Select “Users” from menu on top of screen +2. List of all active users from organization will appear +3. Note: organization creator will default as active admin, with a precreated user ID +4. To add new users, click “+ Add” icon in top right corner +5. Enter new user’s email +6. Select desired role from drop down. (**Note**: roles and associated permissions can be created and managed by organization admins) +7. Click "Add User" button to finalize adding new user +**Note**: If person does not yet have a Harper Fabric account, you will be prompted to invite them +User will be sent verification email, with instructions on how to activate their account +