Skip to content

Commit

Permalink
Edit ZE pages for new default sort order settings
Browse files Browse the repository at this point in the history
For this PR: zowe/zowe-explorer-vscode#3369

Signed-off-by: Buckminsterfullerene02 <[email protected]>
  • Loading branch information
Buckminsterfullerene02 committed Feb 7, 2025
1 parent 325e584 commit aab2864
Show file tree
Hide file tree
Showing 8 changed files with 73 additions and 0 deletions.
Binary file added docs/images/ze/ZE-default-ds-quick-pick.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/ze/ZE-default-ds-sort-setting.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/ze/ZE-default-job-quick-pick.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/ze/ZE-default-job-sort-setting.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
64 changes: 64 additions & 0 deletions docs/user-guide/ze-install-configuring-ze.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,3 +79,67 @@ To define the level of detail included in log files:
2. Select the **User** or **Workspace** tab, depending on the settings you want to update.
3. In the Settings navigation menu, open the **Extensions** menu and click **Zowe Explorer**.
4. In the **Logger** section, open the drop-down menu to select a different detail setting.

## Modifying the default sort order for data sets and jobs

To change the default sort order for data sets and jobs:

1. In Zowe Explorer settings, scroll to a data set or job setting type.
2. Click the setting's corresponding **Edit in settings.json** link.
3. This opens the `settings.json` file in an **Editor** tab.

![Default Data Set Sort Settings](../images//ze/ZE-default-ds-sort-setting.png)
![Default Job Sort Settings](../images//ze/ZE-default-job-sort-setting.png)

> [!TIP]
> Alternately, on the VS Code Command Palette (`Ctrl`/`Cmd` + `Shift` + `P`), enter **Preferences: Open User Settings (JSON)** to display the Settings editor.

The following allowed directions are available for sorting both data sets and jobs:

| Direction | Description |
| --- | --- |
| `Ascending` | Sorts in ascending order. |
| `Descending` | Sorts in descending order. |

The following allowed methods are available for sorting data sets:

| Method | Description |
| --- | --- |
| `Name` | Sorts by the name of the data set. |
| `DateCreated` | Sorts by the date the data set was created. |
| `LastModified` | Sorts by the date the data set was last modified. |
| `UserId` | Sorts by the user ID who last modified the data set. |

The following allowed methods are available for sorting jobs:

| Method | Description |
| --- | --- |
| `Id` | Sorts by the job ID. |
| `DateSubmitted` | Sorts by the date the job was submitted. |
| `DateCompleted` | Sorts by the date the job was completed. |
| `Job Name` | Sorts by the name of the job. |
| `ReturnCode` | Sorts by the return code of the job. |

### Examples

For changing the default sort order for datasets to be sorted by `LastModified` in descending order, modify the following setting to the `settings.json` file:

```json
"zowe.ds.default.sort": {
"method": "LastModified",
"direction": "Descending"
},
```

![Example Default Data Set Quick Pick](../images/ze/ZE-default-ds-quick-pick.png)

For changing the default sort order for jobs to be sorted by `DateCompleted` in ascending order, modify the following setting to the `settings.json` file:

```json
"zowe.jobs.default.sort": {
"method": "DateCompleted",
"direction": "Ascending"
},
```

![Example Default Job Quick Pick](../images/ze/ZE-default-job-quick-pick.png)
3 changes: 3 additions & 0 deletions docs/user-guide/ze-use-cases.md
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,9 @@ Filter partitioned data set members in the **DATA SETS** tree view by **Date Mod

Sort partitioned data set members in the **DATA SETS** tree view by member **Name**, **Date Modified**, or **User ID**.

> [!TIP]
> To change the default sort order for data sets, see [Modifying the default sort order for data sets and jobs](ze-install-configuring-ze.md#modifying-the-default-sort-order-for-data-sets-and-jobs).
#### Sorting all data set members under a specific profile

1. In the **DATA SETS** tree, click on the **Sort** icon to the right of a profile, or right-click on a profile and select the **Sort PDS members…** option.
Expand Down
3 changes: 3 additions & 0 deletions docs/user-guide/ze-working-with-data-sets.md
Original file line number Diff line number Diff line change
Expand Up @@ -259,6 +259,9 @@ Filter partitioned data set members in the **DATA SETS** tree view by **Date Mod

Sort partitioned data set members in the **DATA SETS** tree view by member **Name**, **Date Modified**, or **User ID**.

> [!TIP]
> To change the default sort order for data sets, see [Modifying the default sort order for data sets and jobs](ze-install-configuring-ze.md#modifying-the-default-sort-order-for-data-sets-and-jobs).
### Sorting all partitioned data set members under a specific profile

1. Expand the **DATA SETS** tree in the **Side Bar**.
Expand Down
3 changes: 3 additions & 0 deletions docs/user-guide/ze-working-with-jobs.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,9 @@
- **Job Name**
- **Return Code**

> [!TIP]
> To change the default sort order for jobs, see [Modifying the default sort order for data sets and jobs](ze-install-configuring-ze.md#modifying-the-default-sort-order-for-data-sets-and-jobs).
![Sorting jobs by date completed](../images/ze/ZE-sorting-jobs-by-date-completed.gif)

## Polling a spool file
Expand Down

0 comments on commit aab2864

Please sign in to comment.