Skip to content

CBXP v0.0.4 Documentation Updates #40

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lcarcaramo merged 6 commits into from
Jun 11, 2026
Merged

CBXP v0.0.4 Documentation Updates #40

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
450a4e5
Start 0.0.4 doc updates
lcarcaramo May 22, 2026
ee96047
Cleanup documentation.
lcarcaramo Jun 9, 2026
2dab3d0
Cleanup doc
lcarcaramo Jun 10, 2026
5a1a8fb
Cleanup
lcarcaramo Jun 11, 2026
d177ed5
Cleanup
lcarcaramo Jun 11, 2026
466ec74
Cleanup
lcarcaramo Jun 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
92 changes: 48 additions & 44 deletions Gemfile.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,59 +1,59 @@
GEM
remote: https://rubygems.org/
specs:
activesupport (8.0.3)
activesupport (8.1.3)
base64
benchmark (>= 0.3)
bigdecimal
concurrent-ruby (~> 1.0, >= 1.3.1)
connection_pool (>= 2.2.5)
drb
i18n (>= 1.6, < 2)
json
logger (>= 1.4.2)
minitest (>= 5.1)
securerandom (>= 0.3)
tzinfo (~> 2.0, >= 2.0.5)
uri (>= 0.13.1)
addressable (2.8.7)
public_suffix (>= 2.0.2, < 7.0)
addressable (2.9.0)
public_suffix (>= 2.0.2, < 8.0)
base64 (0.3.0)
benchmark (0.4.1)
bigdecimal (3.2.3)
bigdecimal (4.1.2)
coffee-script (2.4.1)
coffee-script-source
execjs
coffee-script-source (1.12.2)
colorator (1.1.0)
commonmarker (0.23.12)
concurrent-ruby (1.3.5)
connection_pool (2.5.4)
concurrent-ruby (1.3.6)
connection_pool (3.0.2)
csv (3.3.5)
dnsruby (1.73.0)
dnsruby (1.73.1)
base64 (>= 0.2)
logger (~> 1.6)
simpleidn (~> 0.2.1)
drb (2.2.3)
em-websocket (0.5.3)
eventmachine (>= 0.12.9)
http_parser.rb (~> 0)
ethon (0.15.0)
ethon (0.18.0)
ffi (>= 1.15.0)
logger
eventmachine (1.2.7)
execjs (2.10.0)
faraday (2.14.0)
execjs (2.10.1)
faraday (2.14.2)
faraday-net_http (>= 2.0, < 3.5)
json
logger
faraday-net_http (3.4.1)
net-http (>= 0.5.0)
ffi (1.17.2-aarch64-linux-gnu)
ffi (1.17.2-aarch64-linux-musl)
ffi (1.17.2-arm-linux-gnu)
ffi (1.17.2-arm-linux-musl)
ffi (1.17.2-arm64-darwin)
ffi (1.17.2-x86_64-darwin)
ffi (1.17.2-x86_64-linux-gnu)
ffi (1.17.2-x86_64-linux-musl)
faraday-net_http (3.4.2)
net-http (~> 0.5)
ffi (1.17.4-aarch64-linux-gnu)
ffi (1.17.4-aarch64-linux-musl)
ffi (1.17.4-arm-linux-gnu)
ffi (1.17.4-arm-linux-musl)
ffi (1.17.4-arm64-darwin)
ffi (1.17.4-x86_64-darwin)
ffi (1.17.4-x86_64-linux-gnu)
ffi (1.17.4-x86_64-linux-musl)
forwardable-extended (2.6.0)
gemoji (4.1.0)
github-pages (232)
Expand Down Expand Up @@ -111,8 +111,8 @@ GEM
html-pipeline (2.14.3)
activesupport (>= 2)
nokogiri (>= 1.4)
http_parser.rb (0.8.0)
i18n (1.14.7)
http_parser.rb (0.8.1)
i18n (1.14.8)
concurrent-ruby (~> 1.0)
jekyll (3.10.0)
addressable (~> 2.4)
Expand Down Expand Up @@ -224,8 +224,8 @@ GEM
gemoji (>= 3, < 5)
html-pipeline (~> 2.2)
jekyll (>= 3.0, < 5.0)
json (2.15.0)
just-the-docs (0.10.1)
json (2.19.5)
just-the-docs (0.12.0)
jekyll (>= 3.8.5)
jekyll-include-cache
jekyll-seo-tag (>= 2.0)
Expand All @@ -235,7 +235,8 @@ GEM
kramdown-parser-gfm (1.1.0)
kramdown (~> 2.0)
liquid (4.0.4)
listen (3.9.0)
listen (3.10.0)
logger
rb-fsevent (~> 0.10, >= 0.10.3)
rb-inotify (~> 0.9, >= 0.9.10)
logger (1.7.0)
Expand All @@ -244,33 +245,36 @@ GEM
jekyll (>= 3.5, < 5.0)
jekyll-feed (~> 0.9)
jekyll-seo-tag (~> 2.1)
minitest (5.25.5)
net-http (0.6.0)
uri
nokogiri (1.18.10-aarch64-linux-gnu)
minitest (6.0.6)
drb (~> 2.0)
prism (~> 1.5)
net-http (0.9.1)
uri (>= 0.11.1)
nokogiri (1.19.3-aarch64-linux-gnu)
racc (~> 1.4)
nokogiri (1.18.10-aarch64-linux-musl)
nokogiri (1.19.3-aarch64-linux-musl)
racc (~> 1.4)
nokogiri (1.18.10-arm-linux-gnu)
nokogiri (1.19.3-arm-linux-gnu)
racc (~> 1.4)
nokogiri (1.18.10-arm-linux-musl)
nokogiri (1.19.3-arm-linux-musl)
racc (~> 1.4)
nokogiri (1.18.10-arm64-darwin)
nokogiri (1.19.3-arm64-darwin)
racc (~> 1.4)
nokogiri (1.18.10-x86_64-darwin)
nokogiri (1.19.3-x86_64-darwin)
racc (~> 1.4)
nokogiri (1.18.10-x86_64-linux-gnu)
nokogiri (1.19.3-x86_64-linux-gnu)
racc (~> 1.4)
nokogiri (1.18.10-x86_64-linux-musl)
nokogiri (1.19.3-x86_64-linux-musl)
racc (~> 1.4)
octokit (4.25.1)
faraday (>= 1, < 3)
sawyer (~> 0.9)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
prism (1.9.0)
public_suffix (5.1.1)
racc (1.8.1)
rake (13.3.0)
rake (13.4.2)
rb-fsevent (0.11.2)
rb-inotify (0.11.1)
ffi (~> 1.0)
Expand All @@ -283,20 +287,20 @@ GEM
sass-listen (4.0.0)
rb-fsevent (~> 0.9, >= 0.9.4)
rb-inotify (~> 0.9, >= 0.9.7)
sawyer (0.9.2)
sawyer (0.9.3)
addressable (>= 2.3.5)
faraday (>= 0.17.3, < 3)
securerandom (0.4.1)
simpleidn (0.2.3)
terminal-table (1.8.0)
unicode-display_width (~> 1.1, >= 1.1.1)
typhoeus (1.5.0)
ethon (>= 0.9.0, < 0.16.0)
typhoeus (1.6.0)
ethon (>= 0.18.0)
tzinfo (2.0.6)
concurrent-ruby (~> 1.0)
unicode-display_width (1.8.0)
uri (1.0.3)
webrick (1.9.1)
uri (1.1.1)
webrick (1.9.2)

PLATFORMS
aarch64-linux-gnu
Expand Down
6 changes: 3 additions & 3 deletions _config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@


title: CBXP
cbxp_version: 0.0.3
cbxp_version: 0.0.4
description: >- # this means to ignore newlines until "baseurl:"
A unified and standardized interface for extracting z/OS control block data.
A unified and standardized interface for extracting and formatting z/OS control block data.
permalink: /:title/
logo: "/assets/images/logo.svg"

Expand Down Expand Up @@ -72,7 +72,7 @@ callouts:
mermaid:
# Version of mermaid library
# Pick an available version from https://cdn.jsdelivr.net/npm/mermaid/
version: "11.13.0"
version: "11.15.0"

# Exclude from processing.
# The following items will not be processed, by default.
Expand Down
32 changes: 16 additions & 16 deletions filters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ How to use filters to filter repeated control block data.

&nbsp;

Some control blocks like the [ASCB](https://www.ibm.com/docs/en/zos/latest?topic=iar-ascb-information) are **Repeated**. When extracting these **Repeated** control blocks, you may want to only extract the entries that match one or more **Filters**. CBXP allows **Filters** to be provided when extracting **Repeated** control block data.
Some control blocks like the [ASCB](https://www.ibm.com/docs/en/zos/latest?topic=iar-ascb-information) are **Repeated**. When extracting these **Repeated** control blocks from **Live Memory**, you may want to only extract the entries that match one or more **Filters**. CBXP allows **Filters** to be provided when extracting **Repeated** control block data from **Live Memory**.

## Filter Basics

Expand All @@ -20,13 +20,13 @@ Some control blocks like the [ASCB](https://www.ibm.com/docs/en/zos/latest?topic

&nbsp;

The following example extracts all [ASSB](https://www.ibm.com/docs/en/zos/latest?topic=iar-assb-information) control blocks where the **Control Block Field** `ASSBJBNI` matches the **Filter Value** `IBMUSER`.
The following example extracts all [ASSB](https://www.ibm.com/docs/en/zos/latest?topic=iar-assb-information) control blocks from **Live Memory** where the **Control Block Field** `ASSBJBNI` matches the **Filter Value** `IBMUSER`.

###### Python Script
```python
from cbxp import CBXPFilter, CBXPFilterOperation, cbxp

cbdata = cbxp(
cbdata = cbxp.extract(
"assb",
filters=[
CBXPFilter(
Expand All @@ -40,7 +40,7 @@ cbdata = cbxp(

###### Shell Script
```shell
cbxp -f assbjbni=IBMUSER assb
cbxp extract -f assbjbni=IBMUSER assb
```

## Using Multiple Filters
Expand All @@ -51,13 +51,13 @@ Multiple **Filters** can be used.

&nbsp;

The following example extracts all [ASSB](https://www.ibm.com/docs/en/zos/latest?topic=iar-assb-information) control blocks where both the **Control Block Field** `ASSBJBNI` matches the **Filter Value** `IBMUSER` and the **Control Block Field** `ASSBJBNS` matches the **Filter Value** `BPXAS`.
The following example extracts all [ASSB](https://www.ibm.com/docs/en/zos/latest?topic=iar-assb-information) control blocks from **Live Memory** where both the **Control Block Field** `ASSBJBNI` matches the **Filter Value** `IBMUSER` and the **Control Block Field** `ASSBJBNS` matches the **Filter Value** `BPXAS`.

###### Python Script
```python
from cbxp import CBXPFilter, CBXPFilterOperation, cbxp

cbdata = cbxp(
cbdata = cbxp.extract(
"assb",
filters=[
CBXPFilter(
Expand All @@ -76,7 +76,7 @@ cbdata = cbxp(

###### Shell Script
```shell
cbxp -f assbjbni=IBMUSER -f assbjbns=BPXAS ascb
cbxp extract -f assbjbni=IBMUSER -f assbjbns=BPXAS ascb
```

## Using Filters With Include Patterns
Expand All @@ -87,13 +87,13 @@ cbxp -f assbjbni=IBMUSER -f assbjbns=BPXAS ascb

&nbsp;

The following example extracts all [ASCB](https://www.ibm.com/docs/en/zos/latest?topic=iar-ascb-information) and corresponding [ASSB](https://www.ibm.com/docs/en/zos/latest?topic=iar-assb-information) control blocks where the **Control Block Field** `ASSBJBNI` matches the **Filter Value** `IBMUSER`.
The following example extracts all [ASCB](https://www.ibm.com/docs/en/zos/latest?topic=iar-ascb-information) and corresponding [ASSB](https://www.ibm.com/docs/en/zos/latest?topic=iar-assb-information) control blocks from **Live Memory** where the **Control Block Field** `ASSBJBNI` matches the **Filter Value** `IBMUSER`.

###### Python Script
```python
from cbxp import CBXPFilter, CBXPFilterOperation, cbxp

cbdata = cbxp(
cbdata = cbxp.extract(
"ascb",
includes=["assb"],
filters=[
Expand All @@ -108,7 +108,7 @@ cbdata = cbxp(

###### Shell Script
```shell
cbxp -i assb -f assb.assbjbni=IBMUSER ascb
cbxp extract -i assb -f assb.assbjbni=IBMUSER ascb
```

## Using Filters With `fnmatch` Patterns
Expand All @@ -119,13 +119,13 @@ cbxp -i assb -f assb.assbjbni=IBMUSER ascb

&nbsp;

The following example extracts all [ASSB](https://www.ibm.com/docs/en/zos/latest?topic=iar-assb-information) control blocks where the **Control Block Field** `ASSBJBNI` matches the **Filter Value** `IBMUSER*`.
The following example extracts all [ASSB](https://www.ibm.com/docs/en/zos/latest?topic=iar-assb-information) control blocks from **Live Memory** where the **Control Block Field** `ASSBJBNI` matches the **Filter Value** `IBMUSER*`.

###### Python Script
```python
from cbxp import CBXPFilter, CBXPFilterOperation, cbxp

cbdata = cbxp(
cbdata = cbxp.extract(
"assb",
filters=[
CBXPFilter(
Expand All @@ -139,7 +139,7 @@ cbdata = cbxp(

###### Shell Script
```shell
cbxp -f 'assbjbni=IBMUSER*' assb
cbxp extract -f 'assbjbni=IBMUSER*' assb
```

## Filtering Numeric Data
Expand All @@ -150,13 +150,13 @@ cbxp -f 'assbjbni=IBMUSER*' assb

&nbsp;

The following example extracts all [ASSB](https://www.ibm.com/docs/en/zos/latest?topic=iar-assb-information) control blocks where the **Control Block Field** `ASSB_TIME_ON_CP` is **Less Than** `30000`.
The following example extracts all [ASSB](https://www.ibm.com/docs/en/zos/latest?topic=iar-assb-information) control blocks from **Live Memory** where the **Control Block Field** `ASSB_TIME_ON_CP` is **Less Than** `30000`.

###### Python Script
```python
from cbxp import CBXPFilter, CBXPFilterOperation, cbxp

cbdata = cbxp(
cbdata = cbxp.extract(
"assb",
filters=[
CBXPFilter(
Expand All @@ -169,5 +169,5 @@ cbdata = cbxp(

###### Shell Script
```shell
cbxp -f 'assb_time_on_cp<3000' assb
cbxp extract -f 'assb_time_on_cp<3000' assb
```
Loading