You are here

Documentation

LEXS 5.0

  • Building Structured Payloads Guide for LEXS 5.0 (PDF - 627 KB) - Information on LEXS Structured Payloads beyond what is available in the LEXS 5.0 Specification Guide (included as part of the LEXS distribution zip file), and is intended for the user who needs to build a LEXS 5.0 Structured Payload.
  • LEXS 5.0 PD Reference Service Specification Package (SSP) - A LEXS 5.0 PD Reference SSP that can be used as a starting point for development of an SSP for a LEXS PD service.  This reference/template SSP is provided as a convenience for developers in order to provide a starting point for LEXS Web Service implementations. LEXS recommends, but does not mandate, the use of this SSP, since some implementations may not use web services at all or may be required to adhere to other standards or configurations. One SSP places all LEXS metadata in the SOAP body LEXS 5.0 PD SSP (10 MB), while the second splits LEXS metadata between the SOAP header and body of the message LEXS 5.0 PD SSP - Split Metadata (10 MB).
  • A LEXS 5.0 SR Reference Service Specification Package (SSP) - A LEXS 5.0 SR Reference SSP that can be used as a starting point for development of an SSP for a LEXS SR service. This reference/template SSP is provided as a convenience for developers in order to provide a starting point for LEXS Web Service implementations. LEXS recommends, but does not mandate, the use of this SSP, since some implementations may not use web services at all or may be required to adhere to other standards or configurations. The first SSP places all LEXS metadata in the SOAP body LEXS 5.0 SR SSP (10.5 MB), while the second splits LEXS metadata between the SOAP header and body of the message LEXS 5.0 SR SSP - Split Metadata (10.5 MB).
  • LEXS 5.0 SN Reference Service Specification Package (SSP) - A LEXS 5.0 SN Reference SSP that can be used as a starting point for development of an SSP for a LEXS SN service.  This reference/template SSP is provided as a convenience for developers in order to provide a starting point for LEXS Web Service implementations. LEXS recommends, but does not mandate, the use of this SSP, since some implementations may not use web services at all or may be required to adhere to other standards or configurations. The first SSP places all LEXS metadata in the SOAP body LEXS 5.0 SN SSP (10 MB), while the second splits LEXS metadata between the SOAP header and body of the message LEXS 5.0 SN SSP - Split Metadata (10 MB).
  • LEXS 5.0 DE Reference Service Specification Package (SSP) - A LEXS 5.0 DE Reference SSP that can be used as a starting point for development of an SSP for a LEXS DE service.  This reference/template SSP is provided as a convenience for developers in order to provide a starting point for LEXS Web Service implementations. LEXS recommends, but does not mandate, the use of this SSP, since some implementations may not use web services at all or may be required to adhere to other standards or configurations. The first SSP places all LEXS metadata in the SOAP body LEXS 5.0 DE SSP (10 MB), while the second splits LEXS metadata between the SOAP header and body of the message LEXS 5.0 DE SSP - Split Metadata (10 MB).
  • NIEF Profile for LEXS 5.0 (XLSX - 24KB) - Provides mapping information between the National Identity Exchange Federation (NIEF) user and entity attributes, which are based on the Global Federated Identity and Privilege Management (GFIPM) standard, and LEXS user and entity attributes. Note that LEXS 5.0 includes SAML user and entity assertions in addition to the LEXS user and entity assertions.

LEXS 4.0

  • LEXS 4.0 Structured Payloads Guide (PDF - 278KB) - Information on LEXS Structured Payloads beyond what is available in the User Guide, and is intended for the user who needs to build a LEXS 4.0 Structured Payload schema or needs to leverage an existing information exchange utilizing LEXS constructs.
  • LEXS 4.0 WSDL Templates (3.7 MB) - A LEXS 4.0 distribution that includes WSDL templates. These template WSDL files are provided as a convenience for developers in order to provide a starting point for LEXS WS implementations. LEXS does not mandate the use of these files, since some implementations may not use web services at all or may not use web services based on WS-* standards. The LEXS WS WSDL templates use an XML document-based information exchange, leaving the back-end implementation up to the developer.
  • LEXS NIEM Component Mapping Workbook (XLS - 742KB) - The Component Mapping Workbook (CMW) is the LEXS 4.0 data model represented as a spreadsheet. This multi-page spreadsheet documents all data elements and associations that are part of the information exchange, as well as Publish/Discover metadata elements, and their locations in schema. The CMW also documents the cardinality of all data elements and attributes.
  • LEXS NIEM Code Tables (XLS - 2.1MB) - The Code Tables spreadsheet contains all code lists used in the LEXS schemas, regardless of whether they are from NIEM or are specific to LEXS.

LEXS 3.1

  • LEXS 3.1 in 10 Minutes (PDF) - A quick overview of LEXS 3.1, designed to help you understand what LEXS is, how it integrates with NIEM, and provide the basis for understanding. If you don't know LEXS, Start Here!
  • LEXS 3.1 User Guide - The reference manual for LEXS 3.1. Available in the following formats: HTML and Adobe PDF

  • LEXS NIEM Component Mapping Workbook (XLS - 523KB) - A Component Mapping Workbook (CMW) that documents the contents of the LEXS 3.1.4 schemas in Microsoft Excel spreadsheet form. This can also be used as the starting point for creation of a CMW for a specific IEPD.

LEXS Interoperability Profiles

If you have created a LEXS based exchange or if you wish to participate in a LEXS based exchange, then you need an interoperability profile. This page allows you to download existing profiles and provides a template for creating your own.

Tutorials

  • Creating a NIEM IEPD (HTML) - This tutorial shows you how to build a NIEM IEPD from your initial domain model. It is a useful tutorial if you are planning on building a NIEM-based structured payload schema for LEXS, as it gives a good overview on how to search the NIEM model, and how to properly map your data.