Articles in this section

Producing As-Built Identity Panel Documentation

Avatar
Bob Bradley (SIDM)
  • Created
  • Updated
Follow

For most Identity and Access Management (IAM) platforms, as-built documentation must be prepared manually. This is typically a tedious task often requiring weeks of pains-taking effort, and while often a mandatory project deliverable is rarely considered complete or provided on time.  This is often due to the level of custom coded and/or scripted components that comprise the overall solution, and the practical limitations of differentiating from design intent versus deployed functionality.  This inevitably leads to a significant level of ambiguity in the resultant documentation.

For MIM customers, this can be partially scripted (see below), but the output on its own is rarely considered complete, and as with the manually created artefact(s) is effectively out-of-date shortly after publication.

For SoftwareIDM Identity Panel customers, however, as-built documentation is fully generated automatically (in seconds), is always the current live configuration, and is always available online.  This is made possible by a unique solution architecture which encapsulates all functionality in a single, consistent, unambiguous and fully versioned configuration base.

For Identity Panel v6.3 onwards, as-built documentation is accessible inline under Settings History, including a table-of-contents (TOC).  For more details see Producing As-Built Identity Panel Documentation – SoftwareIDM.  For customers upgrading from earlier versions of Identity Panel will be able to access this immediately post upgrade.

Generated As-Built Documentation

New to Identity Panel with Release v6.3 is the auto-generation of As-built documentation via the Settings History menu.  For customers upgrading from earlier versions of Identity Panel will be able to access this immediately post upgrade.

This includes full HTML documentation output for each of

  • Identity Panel
  • Service Panel
  • Test Panel
  • HyperSync Panel

The HTML output can be copied directly from the browser into MS Word via the clipboard:

  • Start by selecting the text "As-Built" at the top.
  • Use the inner vertical scroll bar to then select the bottom of the document with your mouse while holding down the SHIFT key to select the HTML report area.
  • CTRL+C/V to copy/paste into a blank Word document.
  • For best results, a Table of Contents section should be added at the top of the document before saving.
  • Save to either docx or pdf format.

Additional sections will be made available in future releases, including Access Panel.

Usage Scenarios

This feature is designed to assist in the following scenarios:

  • satisfying Identity Panel (IdP) project delivery commitments.

  • complementing the MIM Documenter output for IdP + MIM deployments.

  • searching IdP for embedded configuration such as workflow and fixture settings.

  • learning and gaining understanding of both the IdP product and a deployed solution.

  • highlighting any unresolved references and configuration errors in your IdP config.

  • identifying missing or duplicated rules in IdP (e.g., candidates for custom functions).

  • tracking changes for IdP solution and product deployment (see also Getting and Saving Settings – SoftwareIDM).

  • designing knowledge transfer (KT) workshops for users of Identity Panel.

  • Identity Panel version upgrade impact assessment when cross-referencing software release notes.

  • MIM to HS conversion scoping and cross-referencing (using MIM Uplift in Identity Panel).

Table of contents

A typical TOC for an Identity Panel implementation incorporating HyperSync, Service Panel and Access Panel might look something like the following, which sets a benchmark for what should be expected from any IAM platform:

  • Panel Settings
    • Panel Dashboards
      • Admin
    • Email Settings
      • Azure App Details
    • Extensions
      • Unique Names
        • Accountname Unique Index
      • Health Checks
        • Panel Performance
        • Platform Health
      • Workflow
        • Schedule Interactive
        • Schedule Settings Changed
        • Provider Settings Changed
        • Health Check Failed
    • HyperSync Panel
      • Hyperverse Schemas
      • Scope Filters
      • Silo Filter Rules
      • Lookup Definitions
      • Silo Aliases and Priority
      • General Settings
      • Threshold Settings
        • Custom Threshold Configurations
      • Attribute Flow Rule Sets
        • Manage Account Dormancy - Set
          • AD to HV isDormant - Rule
          • HV to AD Disable Dormant - Rule
        • Default - Set
          • Temp Staff to Azure AD - Rule
          • ADLDS import to HV 1 - Rule
          • HR import to HV - Rule
          • HV export to AD - Rule
          • Unique flow - Rule
          • HV export to ADLDS - Rule
          • ADLDS import to HV 2 - Rule
          • AD Group import to HV - Rule
          • HV Group export to ADLDS - Rule
          • Clean Names - Rule
        • AADC Flow - Set
          • Azure Flow - Rule
      • Flow Rule Precedence Mappings
      • State Sync Rule Sets
        • Default - Set
          • Provision Azure AD from TempStaff - Rule
          • Provision AD from HV - Rule
          • Provision ADLDS from HV - Rule
          • Provision ADLDS with groups - Rule
          • Deprovision AD - Rule
          • Deprovision ADLDS - Rule
        • AADC Provision - Set
          • Provision - Rule
      • Event Trigger Rules
    • Join Rules
      • Rules
      • Resulting Value Samples
    • Providers
      • AD
      • Azure AD
      • Temp Staff
      • Sync Actions
        • Test Suites
          • Test Account Dormancy
          • Test Emergency Termination
          • Bulk Updates
        • Re-usable Fixtures
      • HR
      • ADLDS
    • Security Settings
      • Data Retention
      • Security Roles
        • Identity Panel Permission Settings
    • Environment
      • Scheduler
        • Panel Service Aliases
      • Environment Variables
        • Regular Variables
        • Encrypted Variables
        • Multi-line Variables
      • Custom Rule Functions
    •    Service Panel
      • Dashboard
      • Service Panel Silos
      • People Silo
        • Projected Attributes
        • Attribute Display Settings
      • Service Panel Forms
        • Temp Form
        • Enable Dormant Account Form
        • Emergency Termination Form
      • Shared Form Sections
    • Theme Settings
      • Logo and Header
      • General Theme Settings
      • Theme Colors
  • Schedule
    • Delta Sync
    • Full Scan
    • Full Sync
    • Maintenance Tasks
    • Regular Cycle
    • Testing Delay
  • Report
    • AD - Manager Account Expiration and Flags
    • AD - Password Last Set
    • AD - Proxy Address Collisions
    • AD - Unique Value Collisions
    • AD - UserAccountControl Flags
    • AD - Users With/Without Manager
    • Attribute Changes Report
    • Azure - All Users
    • Azure - Expired Active Users
    • Azure - Filter Users
    • HyperSync Actions
    • Identity Panel - Check-in Report
    • Identity Panel - Request Logs
    • Identity Panel - Service Form History
    • Identity Panel - Unique Index Values
    • Identity Panel - Workflow History
    • Join - Review Azure Candidates
    • Join - Review Join Data
    • Test Case Results
    • Z Data - Department Members
    • Z Data - Departments
    • Z Data - Locations
    • Z Data - Test Users
    • Z-System AD Users
    • Z-System Azure Users Base

Note

For FIM and MIM customers looking to implement Identity Panel, step #2 of the Transition from MIM to HyperSync in 4 steps – SoftwareIDM outlines the use of the Microsoft scripting tools to generate a subset of the above for MIM.  This is also a prerequisite for the Automated Conversion from MIM to HyperSync – SoftwareIDM, whereby the equivalent (baseline) HyperSync configuration for a MIM sync solution is available immediately post the scripted conversion process.

 

Related articles

Comments

0 comments

Please sign in to leave a comment.