Welcome to the Clarive Documentation¶
██████░██░ █████░ ██████░ ██░ ██░ ██░ ███████░ ██░░░░░░██░ ██░░░██░ ██░░░██░ ██░ ██░ ██░ ██░░░░░ ██░ ██░ ███████░ ███████░ ██░ ██░ ██░ █████░ ██░ ██░ ██░░░██░ ██░░░█░░ ██░ ██░ ██░ ██░░░░ ░██████░███████░██░ ██░ ██░ ██░ ██░ ████░ ███████░ ░░░░░░ ░░░░░░ ░░░ ░░░ ░░ ░░░ ░░ ░░░ ░░░░░░░ ®
This is the product documentation for Clarive release 7.18
Recent Additions and Changes¶
- kanban-backend (7 minutes ago)
- Topic Grid API (7 minutes ago)
- Topic (2 weeks ago)
- Git Commit Push Username (2 weeks ago)
- Trash (2 weeks ago)
admin-guide¶
Setup¶
- Quick Install Guide
- Architecture and Requirements
- MongoDB
- Nginx Configuration Guide
- Clarive Configuration File
- Install Directories
- Upgrading from previous versions
- Sessions and Cookies
- Environment Variables
- SAML2
Getting Started¶
- Login
- Deploying Topics
- Favorites
- Monitor
- Resource Grids
- Running Clarive in Docker
- Search Syntax
- Slack Notifications
- Topic Grid
- User Preferences
- Using Create Menu Button
- Using Kanban Boards in Clarive
Concepts¶
- API Key
- Config Table
- Dashboards
- Dispatcher
- Environment
- Job
- Job Rerun
- Kanban
- Lifecycle
- MID
- Operation
- Project
- REPL
- Resource
- Resource Graph
- Roles
- Rollback
- Root-Cause Analysis
- Rule
- Rule Profiling
- Rule Quality Analysis
- Rule Test Sets
- Scope
- Semaphores
- Stash
- Statuses and Transitions
- Timeline Graph
- Topic
- Variable
- Webservice
- Worker
- Workflow
- YAML
Implementation Guide¶
- Getting Started
- Environment Modeling
- Environment Loading and Discovery
- Deployment
- Manual Steps in Deployment
- Deployment Scaling
- Concurrent Deployment and Releases
- Rollback and Error Handling
- Releasing
- Calendaring - When can a Job run?
- Release Pipeline Automation
- Release Readiness Analytics
- Artifact Management
- Asset Tracking and Deployment Items
- Mobile App Delivery
- Multi-Platform Release and Deployment
- Using Clarive APIs
- Mainframe Delivery Automation
Administration¶
- API Keys
- LDAP Authentication
- Users
- Roles
- User Group
- What's New Modal
- Notifications
- Dispatcher
- Daemons
- Job Daemon Configuration
- Purge Daemon Configuration
- Scheduler
- Personal Access Tokens
- Topic Categories
- Labels
- Reports
- Trash
- Managing Status
- Rule Designer
- Rule Designer Shortcut Keys
- Asset Migration Script
- Monitoring Jobs
- Storage Providers
- System Statistics
- Worker
- Calendaring
- Semaphores
- Docker
- SSH Agent Configuration
- Artifact Repository Manager
- Artifact MIME types
- Git Commit Push Username
- Snapshots
- System Messages
Rules¶
- Rule Concepts
- Creating Rules
- Event Rules
- Pipeline Rules
- Webservice Rules
- Independent Rules
- Form Rules
- Workflow Rules
- Dashboard Rules
- Report Rules
- Blueprint Rules
- Rule Palette
- Writing Custom Authentication Rules
Rule Palette¶
Control¶
- APPLY NATURE
- APPLY PROJECT
- CALL rule
- CATCH statement
- CODE
- DELETE hashkey
- DELETE last trap action
- DO
- DO-WHILE condition
- ELSE
- ELSIF condition THEN
- EVAL
- EVAL JavaScript
- FAIL
- FOR eval
- FOR projects with changes DO
- FOREACH CI
- FOREACH file/item
- IF ANY bl THEN
- IF ANY nature THEN
- IF condition THEN
- IF EXISTS nature THEN
- IF last trap action THEN
- IF ROLLBACK
- IF var condition THEN
- IF var in LIST THEN
- IF var ne value THEN
- IF var THEN
- JOB STEP
- LOG Message
- MERGE value INTO stash
- PUSH VAR
- RETRY
- Server CODE
- SET EXPR
- SET VAR
- SET VAR to CI
- STASH LOCAL
- TRY statement
- WAIT for children
- WHILE condition
Job Services¶
- Change Topic Status
- Checkout a git revision
- Checkout Job Environment
- Checkout Job Environment (all repos)
- Checkout Job Items
- Create a new topic
- Delete Local Directory
- Delete Local File
- Eval Remote
- Fill job elements
- Footprint elements
- Git Timesync
- Init Job Home
- Invoke Resource methods
- Link a git revision to the changesets in title
- Link a git revision to the changesets in title
- Load files/items into stash
- Load Job Items into Stash
- Load Nature Items
- Pause a Job
- Rename Environment Items and Files
- Replace Strings
- Request Approval
- Retrieve a remote file
- Rollback All Transactions
- Run a Remote Script
- Run command or local script
- Ship File Remotely
- Sleep for a number of seconds
- Sync a Remote Directory
- Topic Delete
- Web Request
- Windows service
- Write local file
- Write remote file
- List Windows Services
Services¶
- Create a branch in a Git repository
- Create a tag in a Git repository
- Create CI
- Create Git revision job
- Create system tags
- Delete a reference in a Git repository
- Get Date
- Get topics that matches conditions
- Load Related Topic
- Load User
- Managing User Group Roles
- Managing User Roles
- Merge a branch in a Git repository
- Publish files to the artifacts repository
- Publish local file to log
- Rebase a branch in a Git repository
- Remove Attached Files
- Save my stats
- Send a notification
- Take System Snapshot
- Webservice Response
- Zip local path
- SLA Configuration
- Assign SLA configuration to topics
Dashlets¶
- Calendar
- Email messages
- HTML
- Infrastructure Pipeline
- Internet frame
- Job chart
- Job daily distribution
- Last jobs by app
- List environments
- List jobs
- List topics
- Project Pipeline
- Resource Graph
- Swarm
- Topic burndown
- Topic charts
- Topic gauge
- Topic roadmap
- Topics burndown NG
- Topics period burndown
- Topics timeline
Fieldlets¶
- Attach files
- Calculated numberfield
- Checkbox
- Combo
- Datefield
- Description
- Download all files
- Environment planner
- Environments combo
- Grid editor
- HTML Editor
- Include Into
- Milestones
- Moniker
- Number field
- Pagedown editor
- Pills
- Progress bar
- Project combo
- Release combo
- Resource combo
- Resource Grid
- Resource List
- Revision box
- Scheduler
- Separator
- Star Rate
- State
- Status changes
- Status chart pie
- Text field
- Time field
- Title
- Topic grid
- Topic selector
- User combo
Workflow¶
Rulebooks¶
- Introduction to Rulebooks
- Variables and Templating
- Stored Variables
- Rulebook Flow Control
- Defining Custom Ops
- Creating and Updating Topics
- Docker
- Running Shell Commands
- Shipping and retrieving files
- Context Data
- Writing Sane YAML
- Error Handling
- Pipeline Rules
- Event Rules
- Custom Form Fields
- Webhook Rules
- Writing import modules
- Writing import modules with Python
- Writing import modules with Ruby
- Writing import modules with NodeJS
- Publish files to artifacts
- The Rule Cookbook
- Rulebook API
How-to¶
- Config the job ID mask
- Configure the Pubsub Daemon
- Create a Job Slot
- Create a project template
- Create a report
- Custom Resources Grid
- Customize the User Interface
- Edit Calendar
- Publish a static report
- Run a root-cause analysis
- Use filters in fieldlets
Command-Line¶
- Clarive Commands Reference
- Common Command-Line Options
- Using the Command-line
- cla clax - ClaX Agent Utilities
- cla config - Configuration tool
- cla critic - Rule Quality Analysis
- cla db - Database utilities
- cla db-dump - Database backup utility
- cla disp - Dispatcher management
- cla disp-start - Start the Dispatcher server
- cla docs - Help and Documentation Generation
- cla help - Help on cla commands
- cla i18n - Runs translation generator
- cla info - Configuration information
- cla lic - License verification
- cla migra - Migrations
- cla nginx - Nginx server control
- cla passwd - Password encryption
- cla patch - Apply/Rollback patches
- cla plugin - plugin helper
- cla poll - Monitoring
- cla profile - Perfil Clarive
- cla prove - Run internal testing
- cla proxy - A proxy client
- cla ps - Process monitoring
- cla pubsub - Pubsub daemon management
- cla queue - Queue management tools
- cla repl - Command-line REPL
- cla rule - rulebook management
- cla start - Start all server processes
- cla stop - Stops all server processes
- cla trans - Conversion tool
- cla version - Clarive version check
- cla web - Web server management
- cla web-start - Start the web server
- cla ws - Invoke webservices
- cla keeper - Rule monitoring and management
Extending¶
- Introduction
- The Clarive JavaScript DSL
- Requiring modules
- REPL
- Variable Parsing
- Extending cla wth commands
- Extending the JS system with modules
- A JavaScript Primer
- Transpilers, Babel and TypeScript
- Topic Grid API
- Quick Guide from Perl to Javascript/ES6/Typescript
The JS API¶
- Cla.ui - Forms configuration
- cla/base64 - base64 encoder
- cla/ci - Resource Classes
- cla/config - Using configuration variables
- cla/db - MongoDB namespace
- cla/digest - String based encoder
- cla/fs - Local Filesystem Access
- cla/log - Logging Classes
- cla/lwp - LWP User Agent
- cla/path - Path manipulation
- cla/process - Process information
- cla/reg - Registry Manipulation
- cla/rule -Rule execution
- cla/sem - Semaphore control
- cla/t - Testing
- cla/util - General utilities namespace
- cla/web - Web tools
- cla/ws - Webservice namespace
- cla/xml - Local xml files management
- cla/zip - Local zip files management
- stash - Stash storage
Plugins¶
Add-ons¶
Release Notes¶
- 7.0
- 7.0.1
- 7.0.2
- 7.0.3
- 7.0.4
- 7.0.5
- 7.0.6
- 7.0.7
- 7.0.8
- 7.0.9
- 7.0.10
- 7.0.11
- 7.0.12
- 7.0.13
- 7.0.14
- 7.2.0
- 7.2.2
- 7.2.4
- 7.2.5
- 7.2.6
- 7.2.7
- 7.2.8
- 7.2.9
- 7.2.10
- 7.2.11
- 7.4.0
- 7.4.1
- 7.4.2
- 7.4.3
- 7.4.4
- 7.4.5
- 7.4.6
- 7.4.7
- 7.4.7.1
- 7.4.7.2
- 7.4.7.3
- 7.4.7.4
- 7.4.7.5
- 7.4.7.6
- 7.4.7.7
- 7.6
- 7.6.0.1
- 7.6.0.2
- 7.6.0.3
- 7.6.0.4
- 7.6.0.5
- 7.6.0.6
- 7.6.1
- 7.6.1.1
- 7.6.1.2
- 7.6.1.3
- 7.6.2
- 7.6.2.1
- 7.6.2.2
- 7.6.3
- 7.6.3.1
- 7.6.3.2
- 7.6.3.3
- 7.6.3.4
- 7.6.3.5
- 7.6.3.6
- 7.6.3.7
- 7.6.3.8
- 7.6.3.9
- 7.6.3.10
- 7.6.3.11
- 7.6.3.12
- 7.6.4
- 7.6.4.2
- 7.6.4.3
- 7.6.4.4
- 7.6.4.5
- 7.6.4.6
- 7.6.5
- 7.6.5.1
- 7.6.5.2
- 7.6.5.3
- 7.6.5.4
- 7.6.5.5
- 7.6.5.6
- 7.6.5.7
- 7.6.5.8
- 7.6.5.9
- 7.6.5.10
- 7.6.6
- 7.6.6.1
- 7.6.6.2
- 7.6.6.3
- 7.8
- 7.8.1
- 7.8.2
- 7.8.2.1
- 7.8.2.2
- 7.8.2.3
- 7.8.2.4
- 7.8.2.5
- 7.8.2.6
- 7.8.2.7
- 7.8.2.8
- 7.8.2.9
- 7.8.2.10
- 7.8.3
- 7.8.4
- 7.8.4.1
- 7.8.4.2
- 7.8.4.3
- 7.8.4.4
- 7.8.4.5
- 7.8.6
- 7.8.6.1
- 7.8.6.2
- 7.8.6.3
- 7.8.6.4
- 7.8.6.5
- 7.8.6.6
- 7.8.8.0
- 7.8.8.1
- 7.8.8.2
- 7.8.9
- 7.8.9.1
- 7.8.9.2
- 7.8.9.3
- 7.10
- 7.10.1
- 7.10.2
- 7.10.3
- 7.10.4
- 7.10.5
- 7.10.6
- 7.10.7
- 7.10.8
- 7.10.9
- 7.10.10
- 7.12.0
- 7.12.1
- 7.12.2
- 7.12.3
- 7.12.4
- 7.12.5
- 7.12.6
- 7.12.7
- 7.12.8
- 7.12.9
- 7.12.10
- 7.12.11
- 7.12.12
- 7.12.13
- 7.14
- 7.14.1
- 7.14.2
- 7.14.3
- 7.14.4
- 7.14.5
- 7.14.6
- 7.14.7
- 7.14.8
- 7.14.9
- 7.14.9.1
- 7.14.10
- 7.14.11
- 7.14.12
- 7.16
- 7.16.1
- 7.16.2
- 7.16.2.1
- 7.16.3
- 7.18