CLS User Guide - DoD Procurement Toolbox€¦ · Web viewAnd all remaining clauses outside this universe of commercial clauses are available for manual selection ... to create an

Defense Procurement Acquisition Policy (DPAP)

Clause Logic Services(CLS)

User Guidev3.0

Table of Contents

1. Introduction...................................................................................................................... 41.1. What is CLS............................................................................................................................... 41.2. System Overview....................................................................................................................41.3. Log In.......................................................................................................................................... 51.4. Register..................................................................................................................................... 71.5. Browser Compatibility.........................................................................................................8

2. Solicitation......................................................................................................................... 92.1. Introduction............................................................................................................................ 92.1.1. Acquisition Profile Page User Interface Overview.................................................92.1.2. Clause Worksheet - User Interface Overview........................................................102.1.3. Transcript User Interface Overview.........................................................................132.1.4. Navigating Questions Group Tab...............................................................................142.1.5. Run Rules........................................................................................................................... 152.1.6. Fill-ins and Editable Clauses overview....................................................................152.1.7. How-To Instructions: Solicitation Documents......................................................16

2.1.7.1. Create a Solicitation...........................................................................................................172.1.7.2. Edit an Existing Solicitation............................................................................................182.1.7.3. Update Fill-ins and Editables..........................................................................................182.1.7.4. Adding and Removing Clauses from the worksheet..............................................20

2.1.8. Award.................................................................................................................................. 222.1.8.1. Create a New Award...........................................................................................................22

3. Commercial Procedures............................................................................................. 233.1. Introduction.......................................................................................................................... 233.2. Selecting Commercial procedures (FAR part 12).....................................................23

4. Linked Award................................................................................................................. 254.1. Introduction.......................................................................................................................... 254.2. Overview................................................................................................................................ 254.3. Finalized Solicitation......................................................................................................... 254.4. Creating a Linked Award..................................................................................................264.5. How-To: Create a Linked Award Document...............................................................264.5.1. Finalized tab..................................................................................................................... 264.5.2. Versioning for Linked Award document.................................................................274.5.3. Acquisition Profile page................................................................................................274.6. Viewing a Linked Award document..............................................................................28

5. Orders Under an Existing Agreement....................................................................305.1. Introduction.......................................................................................................................... 305.2. Overview................................................................................................................................ 305.3. How-To Instructions: Adding Clauses in an Order..................................................305.3.1. Creating an Order........................................................................................................... 30

6. API Users.......................................................................................................................... 326.1. Introduction.......................................................................................................................... 326.2. Documents in CLS................................................................................................................326.2.1. Creating a New Document............................................................................................32

6.2.1.1. GET Oauth..............................................................................................................................326.2.1.2. POST Document...................................................................................................................336.2.1.3. POST Interview....................................................................................................................34

2

6.2.1.4. GET Launch URL..................................................................................................................356.2.1.5. GET Document.....................................................................................................................366.2.1.6. GET Document/ ?request_format=text.......................................................................376.2.1.7. GET Document/ ?request_format=xml.......................................................................386.2.1.8. Editing Documents.............................................................................................................386.2.1.9. PUT Document.....................................................................................................................386.2.1.10. DELETE Document...........................................................................................................40

6.3. Versioning............................................................................................................................. 406.3.1. GET /clsVerison...............................................................................................................406.3.2. GET /clsVersion/:id........................................................................................................416.4. Linked Awards..................................................................................................................... 42

7. Appendix.......................................................................................................................... 487.1. Acronyms............................................................................................................................... 48

3

1. Introduction

1.1. What is CLSThe Clause Logic Service (CLS) is a web service designed to aid in the procurement process within the Department of Defense and other federal agencies. The primary function of this service is to allow for consistent and accurate inclusion of regulatory provisions and clauses into procurement documents. The goal of CLS is to improve the integrity of contracts developed by providing a centralized, web based, intelligent business logic clause-generating service for Defense Contract Writing Systems (CWS).

Please note that hereinafter, (1) whenever the term “clause” is used it shall be deemed to mean “provision/clause” and (2) whenever the term “document” is used it shall be deemed to mean the CLS list of recommended clauses, rather than a complete solicitation document or a complete award document”.

1.2. System Overview

The CLS is a web service designed to aid in the procurement process within the Department of Defense and other federal agencies. Other Federal Agencies will be added in a subsequent phase of this program. The system will be designed to work in tandem with the users Contract Writing System (CWS) but is a totally separate software system separated by a User Interface. The system will not create the solicitation or award document themselves – only recommended clauses selected in accordance with regulatory and statutory prescriptive requirements. This system provides an aid to the contracting officer who is ultimately responsible for the inclusion of the final clauses. The goal of CLS is to improve the accuracy and consistency of contract clauses within the department by providing a centralized, web based, intelligent clause logic service for use by individual component CWS. The system shall be accessible to the user via an interface included with each components CWS, or a stand-alone web based system for those users with an incomplete interface or CWS.

The general approach is use of Boolean logic rules tied to the written FAR/DFARS/AGENCY COMPONENTS prescriptions. One rule will be written for each clause and provided by the Government. In order to apply this logic to a specific clause rule, a series of question and possible multiple-choice answers has been developed by the Government to identify the individual procurement environment at hand. Once in production, a Government Systems Administrator shall have the ability to input changes, addition and deletions to the clause rules and Questions/Answers to account for changes in regulations as they are implemented. The Government shall have the ability to self-maintain the system when changes in the regulations are issued.

4

Once each question has been answered, the system generates a complete set of recommended clauses from the rules is presented to the user. At this point, the user can then “work” on these clauses in a separate tab to provide fill-in information, edit if authorized, add clauses required by the user and delete those “optional” clauses, if not required. Once work on the clauses is complete, the user can then re-generate the clauses and view, print or send the list back to the CWS via XML to attach to their CWS document.

The use of CLS logic is to be designed only to support the recommendation of a set of clauses for a new solicitation and/or a new award. For orders placed under existing award documents containing a previously agreed to set of clauses, the system will not require the user to navigate through the series of questions. In these cases, the user will be allowed to manually select individual clauses over and above the clauses already in the document, if necessary. The same would apply to solicitation amendments and contract modifications.

1.3. Log InTo access CLS, direct your browser to https://clauselogic.altess.army.mil. Your browser will be re-directed and the following screen will appear.

Figure 1 – DoD Consent Banner

5

When the user clicks the “I Agree” button, the sign-on screen is presented.

Figure 2 – Login Screen

The user must provide an Email Address and Password, and then click the “Login” button. After the provided Email Address and Password are validated, the initial CLS screen is presented to the user.

For CAC users, insert your CAC card into the DoD provided hardware, and click the “Login with CAC Card” button.

New users must select the “Register” link first to assign have a password and email address

6

1.4. Register On the login screen, click the “Register” button. The user will be presented with fields to complete registration.

Figure 3 – Register an Account

All fields must be completed in order to register for a CLS account. Once completed, click the “Register” button.

Once successfully registered, the user will be directed to the CLS Dashboard page as a Standard User (Can only create and review own documents).

After the user has registered and is able to login to CLS, he or she will be directed to the CLS dashboard and a “Login successful” message will appear.

7

Figure 4 – CLS Dashboard

1.5. Browser Compatibility

Table 1 – Compatible Browsers

Browser VersionChrome 40 - 46

Internet Explorer

9, 10, 11

Mozilla Firefox

35 - 42

CLS will work in any of the browsers listed above. In general, it is best practice to use the most recent version of these browsers, as they are the most stable and secure.

There are some functional differences, which improve the user experience. For example, you are able to download and open documents in HTML on both IE9 and IE11; however, you are only able to open the document directly from the download bar in IE11. IE9 requires the user to go into the browser settings. Each browser allows the user the ability to zoom in and zoom out to increase or decrease their font size. To do this, hold the Ctrl key and press the + button to zoom in and – button to zoom out. Press 0 to return to default view.

1.5.1.

8

2. Solicitation

2.1. IntroductionThis section provides an overview of creating a list of recommended clauses for a new solicitation or a new award document. When the user chooses to create a new solicitation, they will go through a series of questions in which the system will evaluate their answers and provide a set of clauses based on the regulatory prescriptions.

2.1.1. Acquisition Profile Page User Interface OverviewTo access the main interview page from the dashboard you must enter a new solicitation. See section 2.1.6.1 for step-by-step directions.

Figure 5 – Acquisition Profile Page

Table 2 - Acquisition Profile User Interface Attributes

Item Name Notes

1 Previous Takes the user to back to the preceding question to change answer choices

2 Next Takes the user to the follow-up question

3 Save Saves the interview session; screen does not change

9

4 Save and Exit Saves the interview and takes the user back to the dashboard page

5 Finalize and Exit Can only be clicked when the user finishes answering all their questions

6 TranscriptShows all the questions and follow-up questions that have been answered, user can click on blue hyperlink to change answer from that question. (See figure 9)

7 eCFR view Shows the clause text as prescribed on the eCFR site

8 Run RulesReevaluates the previous answer choices selected and either add or delete clauses based on the prescriptive language (see figure 10)

9 Clause Worksheet Takes the user to the clause work page (see figure 11)

10 Information Icon Next to Answers

The user can click on the information icon which links them to the prescription associated with that specific answer choice. It provides both additional information regarding the answer and explains why the question is being asked.

2.1.2. Clause Worksheet - User Interface OverviewThis page is organized in three specific tabs: Clauses, Add, Required.In the Clause Worksheet, the user can manually search and add clauses, remove optional clauses, edit clause text, and complete/update fill-ins. The clauses will be organized in sections A-M in ascending order.

Under the Add tab (figure 11), the user can enter in a clause number in the search bar at the top or scroll through the list add clauses. When the user sees a specific clause they would like to be manually added to their cart, they can click on the blank check box . The clause will now appear in both the main Clause Worksheet page and in the Clause Cart. The clause will be marked with the following note: “Manually Added by the User”. When a clause has been added to the cart, the user will see a check in the box .

10

Figure 6 – Clause Worksheet on Clauses Tab

Table 3 - Clause Worksheet User Interface Attributes

Item Name Notes1 Section Uniform Contract format section of clauses –listed in

ascending order (A-M)

2 Clause # Lists the number of the clause

3 Prescription Provides detailed information for the answer choice and clause evaluation

4 Regulation FAR (Federal Acquisition Regulation) or DFAR (Defense Federal Acquisition Regulation)

5 Date Clause effective date6 Type Describes how the clause will be shown in the final

document: By Reference or By Full Text7 Required? YES – clause cannot be removed from the worksheet

NO – clause can be removed by clicking on the ‘X’ in the far right corner

8 Editable? YES – user will be able to edit all or portions of the clause text by clicking on Yes,NO – clause is not editable

9 Notes eCFR View – depicts the clause text as shown on eCFR siteUpdate Fill-ins – will provide textboxes for user to fill-in text for certain portions of the clause

11

Figure 7 – Clause Worksheet on Add Tab

The user can also view the clause text under this tab. The portions of the text that will offer fill-ins are denoted with (____). The user can only update these portions under the clauses tab

Figure 8 – Clause Worksheet on Removed Tab

12

When the user unchecks a box in the added tab or clicks on ‘X’, this tab will list clauses that were removed.

2.1.3. Transcript User Interface OverviewThe transcript allows the user to see all the follow-up questions and answer choices they’ve selected. If you wish to change your answer for any questions previously answered, you can click on the blue hyperlink on the transcript pop-up to navigate back to that question.

Figure 9 – Transcript

The transcript is organized into thirteen sections; the follow-up questions or answer choices will be highlighted in blue to allow the user to change their answers to questions they’ve already answered.

13

2.1.4. Navigating Questions Group TabWhen all the follow-up questions within a tab are answered the user will see a check mark next to the tab name. The user can navigate to the following tab or any other tab without a check mark to answer questions.

Figure 10 – Question Groups Tab

14

2.1.5. Run RulesThis is designed to reevaluate crossover clauses during an interview. If any clauses are added or removed based on an answer choice, the user can click on run rules to see the details and changes to their clause cart. Note that the final and accurate clause list will be publish when the user completes and/or finalizes their

Figure 11 – Run Rules Pop-up Screen

2.1.6. Fill-ins and Editable Clauses overviewClauses with fill-ins are provided for contracting officers. The user can update these clauses by clicking on the update fill-ins button in the clause worksheet. The fill-ins are available within a textbox, table, and checkboxes.Editable clauses are indicated with a yes under the ‘Editable?’ column in the clause worksheet. The user can edit portions or the entire clause when the user clicks on the Yes. However, the user cannot delete portions of the text indicated as {System Field}, this is a fill-in functionality and deleting it will void the clause.

Table 4 – Fill-ins and Editable Buttons

Buttons NotesClick on this button under the Editable? Column in order to edit clause text

Allows the user to view where fill-ins will be available by

replacing fill in portions with

15

Under the worksheet clauses tab, the user can click on this to fill-in where textbox input boxes are available

Completed fill-in The Update fill-in button will turn green when the

user finishes filling in their data and clicks complete

Figure 12 – Fill-in Clause Text Pop-up

2.1.7. How-To Instructions: Solicitation DocumentsThe Standard user is a role in CLS that is authorized to only create and review their own documents. This section provides specific step-by-step instructions for performing tasks within CLS. Below are the scenarios presented for solicitations.

How-to Instructions: Create a Solicitation Create a new Solicitation

Edit an existing Solicitation

Add fill-ins and editables

Edit fill-ins and editables

Add clauses to clause cart

Remove optional clauses

16

View in-progress solicitation (includes PDF, Word, etc.)

View transcript

Modify answers

Finalize a solicitation

View finalized solicitation (includes PDF, Word, etc.)

2.1.7.1. Create a SolicitationTo create a new Solicitation, complete the following steps:

1. Log into Clause Logic Services.2. On the homepage, above the dashboard, click the New Solicitation.3. An empty New Solicitation page appears. Enter text for the

Acquisition Title field and Solicitation Document Number field and click the Create New Solicitation button.

Figure 13 – Assign Acquisition Title and Number

4. The Acquisition Profile page appears. The application will default to the first tab under Question Groups. Under the middle tab titled Basic Questions, select an answer(s) and click the Next button.

17


5. The user will be moved the next applicable question. Note that when the section of answers is completed, a transcript page will appear with all answered questions. By clicking the Next button, the user will be taken to the next question group’s set of questions.

6. After answering the first tab of questions, click the Clause Worksheet button.

2.1.7.2. Edit an Existing SolicitationTo create edit a new Solicitation, complete the following steps:

1. Log into Clause Logic Services. 2. Once the dashboard has loaded, in the search bar the user will be able

to search for the title or number. The user can also look for their document manually.

3. Once the user has found the desired document to edit, click on the ‘Resume’ button under the Options column.

4. When the document opens, make edits to the document.

2.1.7.3. Update Fill-ins and EditablesTo add fill-ins and editables, complete the following steps:

1. Log into Clause Logic Services.2. Create a new solicitation or resume an existing document. When the

interview screen has loaded click on the clause worksheet button located in the clause cart header.

18

Figure 15 – Clause Cart Header

3. When the clause worksheet has loaded, the user will be able to sort under the Editable? Column or filter Update Fill-in clauses under the filter column

Figure 16 – Clause Worksheet

4. In order for the user to edit a clause he or she must click on ‘Yes’ highlighted in blue under the ‘Editable?’ column. A pop-up screen with the clause text will indicate what portions are editable. The user may edit portions or the entire text with the exception of the [System Field]. Click the save button to save the edited text or the cancel button to return to the clause worksheet.

19

Figure 17 – Editable Clause Text

5. In order for the user to edit a fill-in they must click on any red update

fill-ins button . The user may update any portions with a textbox, table, or checkbox. When the user is finished editing the fill-

in data they may click on the button at which time the Update fill-ins button will turn green, and if they would like to save

the data and return back to the clause click on the button. This will keep the update fill-in button red so the user knows to go back to add additional text.

2.1.7.4. Adding and Removing Clauses from the worksheet

1. Log into Clause Logic Services.2. Resume a document3. Click on the clause worksheet. Under the add tab, search for the

desired clause by entering the first few numbers of that clause and clicking enter. Add the clause by clicking on the blank check box located to the left of the clause #.

20

Figure 18 – Add Tab

4. Go to the Clauses worksheet in order to make edits and update fill-ins if the manually added clause contains them

5. The user can delete a clause by clicking on the ‘X’ located on the far right.

Figure 19 – Clause Worksheet

6. When the user clicks on the X to delete a clause it will appear in the Removed tab

Figure 20 – Removed Tab

21

2.1.8. Award This section will provide a brief overview of how to create a contract. If the user chooses to create a new award from the dashboard, they will go through a series questions in which the system will evaluate their answers and provide a set of clauses. The only differences between creating a solicitation and award are the number of questions asked and the removal of sections K, L, and M from the clause cart.

2.1.8.1. Create a New AwardTo create a new Award, complete the following steps:

1. Log into Clause Logic2. On the homepage, above the dashboard, click the New Award.3. An empty New Award page appears. Enter text for the Acquisition

Title field and Award Document Number field and click the Create New Award button.


5. The user will be moved the next applicable question. Note that when the section of answers is completed, a transcript page will appear with all answered questions. By clicking the Next button, the user will be taken to the next question group’s set of questions.

6. After answering the first tab of questions, click the Clause Worksheet button.


22

3. Commercial Procedures

3.1. Introduction

Government agencies will research the commercial items necessary to meet its needs and requirements. Per FAR – Part 12 Acquisition of Commercial Items subpart 12.1, the agencies require prime contractors and subcontractors at all tiers to incorporate, to the maximum extent practicable, commercial items or non-developmental items as components of items supplied to the agency.

CLS has incorporated the selection of FAR provisions/clauses based on a limited universe of “commercial” provisions/clauses as stated in FAR 12.301 and 52.212-5. There are approximately 75 applicable provisions/clauses including alternates. When CLS selects FAR clauses, only the rules for the following (75 plus) provisions/clauses will be available for auto-selection. And all remaining clauses outside this universe of commercial clauses are available for manual selection by the user.

3.2. Selecting Commercial procedures (FAR part 12)

1. Log into Clause Logic 2. On the homepage, above the dashboard, create a new solicitation or Award.3. Enter the title and number of your document and continue4. Upon entering the acquisition profile page the user will immediately be

asked which of the following contracting procedures will be followed.5. Upon selection of Commercial procedures the user will notice a

notification statement as follows: ONLY SELECT IF ALL OF THE LINE ITEMS ARE “COMMERCIAL” ITEMS USING COMMERCIAL PROCEDURES PER FAR PART 12 in the header, there will also be an immediate population of clauses in the clause cart.

Figure 21 – Commercial Items Notification

23

Table 5 – Fill-ins and Editable Buttons

Section I Section K

FAR 52.209-10 FAR 52.212-1

FAR 52.233-3 FAR 52.213-3

FAR 52.233-3 Alternate I FAR 52.212-3 Alternate I

FAR 52.233-4

FAR 52.212-4

FAR 52.212-4 Alternate I

6. The user may continue the interview in the Basic questions tab. Thereafter, the user will only be asked a number of questions necessary for commercial procedures.

24

4. Linked Award

4.1. IntroductionCLS provides functionality for a user to create an award document that inherits the data of his solicitation. The goal of this functionality is to streamline the award process once the contractor has been selected.

4.2. Overview After creating a finalized solicitation the user can create a linked award document from the CLS dashboard. The user can set the version of the linked award document to match the version of the finalized solicitation or use the newest version of CLS questions and clause data to create the new award.The system will then direct the user to the Acquisition Profile page with the Q&A session for the linked award. The interview will contain prefilled answers from the answers in the solicitation document, applicable clauses from the solicitation document, fill in data the user completed in the solicitation and new questions related to the award document.

4.3. Finalized SolicitationIn order to create a linked award the user must first finalize his solicitation document by clicking the “Finalize and Exit” in the Acquisition Profile page. He may then create a linked award from the “Finalized” tab on the Dashboard.

After the user has created a linked award document, he will not be able to re-open and update the finalized solicitation. The new award document will contain pre-filled answers from the solicitation document as well as fill in data.


25

The user may finalize their solicitation by clicking “Finalize and Exit” in the Acquisition Profile page once they have answered all interview questions, completed necessary fill in information and made any change in the “Clause Worksheet” screen.

4.4. Creating a Linked AwardA user can create a linked award document by locating his finalized solicitation in the “Finalized” tab of the CLS dashboard. Next, he will be asked to enter information about the document—number, title, and version. Then he will be taken to a new Acquisition Profile page.

4.5. How-To: Create a Linked Award Document

To create a linked award document follow the steps below, more detail is provided in the following sections:

Step 1 Finalize a solicitation document (4.2)Step 2 Select “Create Linked Award” from the finalized tab of the CLS

dashboard (4.3)Step 3 Enter new document information for the new linked award and

specify which CLS version will be used to create it (4.4)Step 4 Edit answers and fill in data in the Acquisition Profile page for the

new linked award document. The document can be saved and accessed from the “In Progress” tab of the CLS dashboard.

4.5.1. Finalized tab

Figure 23 – Finalized Tab

The user can find his solicitation document in the “Finalized Tab” of the Dashboard (1), and click “Create Linked Award” button at the end of the row

26

(2).

4.5.2. Versioning for Linked Award documentWhen the user enters information about their document CLS will present an option to select the version of CLS data to be used to create the new award document. Users may select the version to match the solicitation document’s version or use the newest version of CLS data; the new version will include updates to the question set, clause rules and clause data.

Figure 24 – New Document Information Screen

The user will be asked to enter a unique name (1) and number (2) for the linked award document. He can also specify which version of CLS will be used by selecting the radio button options for “Clause Version” (3). The “Show Changes” button (4) will present a pop-up that lists system-wide changes to CLS between the version of the solicitation (if it is a previous version) and the latest version of CLS that can be used to create a linked award.

4.5.3. Acquisition Profile page When the new linked award is created the user is taken to a new interview in the Acquisition profile page. The relevant data from the solicitation document: answers, clauses and fill-ins will be pre-filled in the interview but the user will be able to edit any imported data and complete the remaining questions and fill-ins. The user’s clauses will change from the solicitation document based on CLS evaluation rules. Like a regular solicitation or award, the user will have also have access to the Clause Worksheet page.

27

Figure 25 – Acquisition Profile Page for Linked Award

The Acquisition Profile page resembles the Acquisition Profile page for a new award document with slight differences: (1) the document type field indicates it is a linked award document, (2) users answers are pre-filled from the solicitation and (3) completed fill-ins will appear highlighted in green.

4.6. Viewing a Linked Award documentLinked Awards will be displayed on the CLS dashboard as new documents under the “In Progress” tab and nested under the finalized source solicitation in the “Finalized” tab.

Figure 26 – In Progress Tab

The linked award document will appear as a new award document in the In Progress tab.

28

Figure 27 – Finalized Tab

The linked award document will also appear nested under the finalized source solicitation in the Finalized tab. A user can view all linked awards created from one solicitation by selecting the down arrow icon located next to the Create Linked Award button.

29

5. Orders Under an Existing Agreement

5.1. IntroductionCLS provides functionality for a user to create an order under an existing agreement. The purpose of this functionality is to offer the ability to manually add clauses to their document.

5.2. OverviewWhen creating an order, the user will be bypassing the interview process altogether. This Page will look similar to the Clause worksheet page, consisting of Clauses, Add, and Deleted tabs). In order to add a clause manually from the clause

5.3. How-To Instructions: Adding Clauses in an OrderThe Clauses listed in the Add tab are organized in ascending order within Sections A-M. Under each section the FAR clauses are listed first then the DFAR clauses

5.3.1. Creating an Order

1. Log into Clause Logic.2. Click on the button “Orders Under an Existing Agreement” in the

dashboard.3. Enter the Acquisition Title and Order document number and click on

create new order.4. User will be taken directly to a blank Clauses tab; in order to add a clause,

click on the Add tab.5. Clauses are ordered in sections, user will be able to scroll to the specific

clause or enter the clause number in the search bar.

Figure 28 – Orders under an Existing Agreement

30

6. When the user sees a specific clause they would like to be manually added to their cart, they can click on the blank check box . When a clause has been added to the cart, the user will see a check in the box .

7. The clauses with a checked box will appear under the Clauses tab, if these

clauses have fill-ins to update they will appear as: and if clauses added are editable the user will see under the Editable? column.

8. Once the user has finished updating their fillins and editing their clauses, they may click on the finalize and exit button

9. Click OK to confirm you’d like to complete the document

31

6. API Users

6.1. IntroductionCLS provides clause data to integrating Contract Writing Systems through RESTful APIs, using a OAUTH 2.0 2-legged client credentials authentication mechanism. This authentication mechanism enables a single-sign on for the user through the CWS and obfuscates the integration and authentication between the CWS and CLS from the end-user. The goal of these APIs is to provide clause data that can be imported directly into an end-user’s procurement instrument.

6.2. Documents in CLSUser can create solicitations, awards, orders and linked awards through POST requests to the CLS server. The different document type is specified by the “document_type” attribute in the POST request; users can supply the values A, S, or O. The system provides clause data in document outputs in JSON and XML formats accessible via a GET request.

6.2.1. Creating a New Document

6.2.1.1. GET Oauth In order to access CLS resources the client application must be registered with DPAP and will then be issued credentials, an application_id and client_secret, to create an Oauth token using a GET call. The Oauth authentication supports a single-sign-on (SSO) for the end-user since this authentication process occurs between the client and server. The token expires after 7200 seconds.A sample request with the application_id and client_secret in the body and sample response is included below:

Sample Endpoint:https:// dev.clause-logic.com/cls/api/oauth2/token

Sample Headers:Accept application/json

Content-Type application/json

Sample Request Body:{ "access_token": "3963306236313165393164383436303062303531666531336233636635353231",

"token_type": "bearer",

32

"expires_in": 7200

}

Sample Response Body:{ "access_token": "3963306236313165393164383436303062303531666531336233636635353231",

"token_type": "bearer",

"expires_in": 7200

}

6.2.1.2. POST DocumentThe next step is to create a document using the Oauth token. Users can enter their document type (S for solicitation, A for Award, and O for Order) in the request body along with their document title and number.

Sample Endpoint:https:// dev.clause-logic.com/cls/api/v1/documents

Sample Headers:Authorization bearer {{access_token}}


Sample Request Body:{ "document_type": "A",

"acquisition_title": "test-document 892”

"document_number": "892”

}

Sample Response Body:{

"document": {

"id": 2312,

"url": "/cls/api/v1/documents/2312",

"document_type": "A",

"acquisition_title": "test-document 892",

"document_number": "892",

"interview_complete": false,

"doc_status_cd": "I",

33

"order_number": null,

"contract_number": null,

"created_at": "2015-10-19T02:30:07Z",

"updated_at": "2015-10-19T02:30:07Z",

"user": null,

"clause_version_id": 8,

"solicitation_id": null,

"linked_award_document_id": [],

"clauses": [],

"document_answers": [],

"document_fill_ins": {

"document_id": 2312

},

"application": {

"created_at": "2015-07-16T20:57:23Z",

"id": 4,

"name": "steve_api_test",

"org_id": 27,

"redirect_uri": null,

"secret": "3232653831356530633966353461353061666162376138373464396662626131",

"uid": "3937396432396561623963303436646561346531663432376231643530343437",

"updated_at": "2015-07-16T20:57:23Z"

}

}

}

6.2.1.3. POST InterviewNext the user will generate an “interview_id” associated with the newly created document. The document and interview ids have a 1-1 relationship and an interview_id is needed to access the user’s document. This interview_id expires after 7200 seconds in order to keep a user’s interview secure. The system is designed to keep documents private between users, unless the user has access to the document’s interview id to generate a Launch URL.The POST call we return a “launch_token” unique to the “interview_id” and used to generate a Launch URL that will take the user to his interview in CLS.

34

Sample Endpoint:https:// dev.clause-logic.com/cls/api/v1/interviews



Sample Request Body:{ "document_id":2312 }

Sample Response Body:{"interview_launcher": {

"id": 282,

"launch_token": "3863663937386363616666633435333339623135333836643364333437626261",

"document_id": 2312,

"launch_at": null}

}

6.2.1.4. GET Launch URLTo access the interview in CLS, the user must make a GET request to generate a launch URL. The interview_id is submitted as a parameter in the request. Since the interview_id expires after 7200 seconds, the launch token and launch URL also expire after 7200 seconds to keep the user’s interview secure. A new URL containing the new launch_token is generated after that time interval.

Sample Endpoint:https:// dev.clause-logic.com/cls/api/v1/ interviews/{{interview_id}}/launch_url




"launch_url": "https://dev.clause-logic.com/cls/account/interview.jsp?token=3863663937386363616666633435333339623135333836643364333437626261"

}

35

6.2.1.5. GET DocumentThe system provides the document data in the response body of the GET Document request. The default response is returned in a .json format with sections for document information, clauses returned and the user’s answers. For incomplete documents the “clauses” section may appear blank until the user Saves their document in the CLS GUI.

Sample Endpoint:https:// dev.clause-logic.com/cls/api/v1/documents/:id




"document": {

"id": 2312,









"created_at": "2015-10-19T02:30:07Z",

"updated_at": "2015-10-19T02:30:07Z",

"user": null,




"clauses": [],



"document_id": 2312

},

"application": {

"created_at": "2015-07-16T20:57:23Z",

36

"id": 4,


"org_id": 27,


"secret": "3232653831356530633966353461353061666162376138373464396662626131",

"uid": "3937396432396561623963303436646561346531663432376231643530343437",

"updated_at": "2015-07-16T20:57:23Z"

}

}

}

6.2.1.6. GET Document/ ?request_format=textThe system provides the document data in PDS format when the user specifies document format as a request parameter. CLS provides two versions of an XML response in PDS format: with clause text appearing without formatting, in plain text (request_format=text) or with clause text including standardized html tags for basic formatting (request_format=xml). The text format below is intended for submission to a system which validates html tags and may require escape characters.

Sample Endpoint:https:// dev.clause-logic.com/api/v1/documents/{{document_id}}?request_format=text



Sample Response Body:<?xml version="1.0" encoding="UTF-8"?>

<ProcurementDocument>

<AwardInstrument>

<ProcurementInstrumentHeader>

<ClauseInformation>

<RegulationUrl>http://www.ecfr.gov/</RegulationUrl>

<RegulationUrl>http://www.acq.osd.mil/</RegulationUrl>

</ClauseInformation>

</ProcurementInstrumentHeader>

</AwardInstrument>

37

</ProcurementDocument>

6.2.1.7. GET Document/ ?request_format=xmlThe second XML format includes basic html formatting in the <ClauseFullText> field enclosed by a CDATA section. This is intended to allow the integrating CWS to provide its users with clause text in a more easily readable format. The system consumes the clause text from the eCFR website then sanitizes the data to provide a more predictable set of html tags.

Sample Endpoint:https:// dev.clause-logic.com/api/v1/documents/{{document_id}}?request_format=xml



Sample Response Body:<?xml version="1.0" encoding="UTF-8"?>

<ProcurementDocument>

<AwardInstrument>

<ProcurementInstrumentHeader>

<ClauseInformation>

<RegulationUrl>http://www.ecfr.gov/</RegulationUrl>

<RegulationUrl>http://www.acq.osd.mil/</RegulationUrl>

</ClauseInformation>

</ProcurementInstrumentHeader>

</AwardInstrument>

</ProcurementDocument>

6.2.1.8. Editing DocumentsAny edits made through the GUI will be reflected in the API response when a new CALL is sent.

6.2.1.9. PUT DocumentIn order to change an interview from Finalized to In Progress, CLS supports a PUT call to change the document’s status.

Sample Endpoint:https:// dev.clause-logic.com/cls/api/v1/documents/:id

38



Sample Request Body:{ "doc_status_cd”: I }

Sample Response Body: {

"document": {

"id": 2312,









"created_at": "2015-10-19T02:30:07Z",

"updated_at": "2015-10-19T02:30:07Z",

"user": null,




"clauses": [],



"document_id": 2312

},

"application": {

"created_at": "2015-07-16T20:57:23Z",

"id": 4,


"org_id": 27,


39

"secret": "3232653831356530633966353461353061666162376138373464396662626131",

"uid": "3937396432396561623963303436646561346531663432376231643530343437",

"updated_at": "2015-07-16T20:57:23Z"

}

}

}

6.2.1.10. DELETE DocumentA user can make a request to DELTE a document or interview in CLS.

6.3. VersioningCLS provides two API calls with version history information: GET /clsVersion provides a lisitng of the past and current versions on CLS data, GET /clsVersion/:id provides the details of the questions, answers and clause data contained in the specified version.

6.3.1. GET /clsVerisonSample Endpoint:https:// dev.clause-logic.com/cls/api/v1/clsVersion




"cls_versions": [

{

"id": 8,

"clause_version_name": "3.9",

"is_active": true,

"clause_version_date": "2015-10-14T21:14:04Z",

"created_at": "2015-10-14T21:14:04Z",

"updated_at": "2015-10-14T21:16:52Z"

},

{

"id": 7,


"is_active": false,

40


"created_at": "2015-09-19T18:01:32Z",

"updated_at": "2015-10-14T21:16:52Z"

},

{

"id": 6,


"is_active": false,


"created_at": "2015-09-04T14:18:51Z",

"updated_at": "2015-09-19T18:04:35Z"

},

…..

6.3.2. GET /clsVersion/:id

Sample Endpoint:https:// dev.clause-logic.com/cls/api/v1/clsVersion




"id": 8,


"is_active": true,


"created_at": "2015-10-14T21:14:04Z",

"updated_at": "2015-10-14T21:16:52Z",

"question_change_count": 0,

"question_changes": [],

"clause_change_count": 34,

"clause_changes": [

{

"id": 8893,

41

"clause_section_code": "I",

"clause_section_header": "Contract Clauses",

"clause_name": "252.203-7004",

"clause_title": "Display of Hotline Posters.",

"Change_Code": "Changed",

"Change_Brief": "Context"

},…

6.4. Linked AwardsCLS provides the functionality to create an award document that inherits applicable data: answers and clauses, from an existing solicitation document. Users can create a linked award by providing the solicitation’s document_id and clause_verison number in the POST request for an award document.

To create a linked award via the POST request:

7. The solicitation document must be finalized (“doc_status_cd”: F) and 8. The clause_version_id must either be the same as the finalized

solicitation or use the latest version of CLS.

The successful POST response will contain the applicable clauses, answers, fill in and editable data from the solicitation document. The GET request for the source solicitation will contain the document ids of the associated linked awards in the “linked_award_document_id” attribute; the GET response for the linked award document will contain the document id for the source solicitation in the “solicitation_id” attribute.

Versioning and Linked AwardsIn order to create a linked award using the most recent version of CLS the user must specify the “clause_verison_id” in the POST request; otherwise the system will default to create a linked award that is the same version as the solicitation. The version of the linked award document is protected in CLS, so if the user re-opens the Launch URL after a new version is released, the document will not be updated.

Sample Endpoint:https:// dev.clause-logic.com/cls/api/v1/documents

42



Sample Request Body:{ "document_type": "A",

"acquisition_title": "test-document 894”

"document_number": 894

"solicitation_id": 2311

"clause_version_id": 8

}


"document": {

"id": 2313,









"created_at": "2015-10-19T02:30:07Z",

"updated_at": "2015-10-19T02:30:07Z",

"user": null,


"solicitation_id": 2311,


"clauses": [

{

"id": 158782,

"clause_name": "52.202-1",

"effective_date": "2013-11-01",

"inclusion": "R",

43

"active": true,

"start_date": null,

"end_date": null,

"prescription_text": null,

"clause_text": null,

"url": "http://www.ecfr.gov/cgi-bin/text-idx?mc=true&node=se48.2.52_1202_61&rgn=div8",

"commercial_status": "M"

},

{

"id": 158785,

"clause_name": "52.203-12",


"inclusion": "R",

"active": true,

"start_date": null,

"end_date": null,





},

{

"id": 158788,

"clause_name": "52.203-15",


"inclusion": "R",

"active": true,

"start_date": null,

"end_date": null,




"commercial_status": "R (RULE APPLIES)"

},

44

{

"id": 158789,

"clause_name": "52.203-16",


"inclusion": "F",

"active": true,

"start_date": null,

"end_date": null,





},

{

"id": 158790,

"clause_name": "52.203-17",


"inclusion": "R",

"active": true,

"start_date": null,

"end_date": null,





},….

],

"document_answers": [

{

"id": 52237,

"answer": "COMPETITION\tSIMPLIFIED ACQUISITION PROCEDURES (FAR PART 13)",

"question": {

"id": 37790,

"question_name": "[PROCEDURES]",

45

"question_type": "M",

"question_text": "WHICH OF THE FOLLOWING CONTRACTING PROCEDURES WILL BE FOLLOWED?"

},

{

"id": 52238,

"answer": "AWARD",

"question": {

"id": 37791,

"question_name": "[DOCUMENT TYPE]",

"question_type": "1",

"question_text": "IS THIS A SOLICITATION OR AWARD?"

}, …

],


],


"document_id": 2313,

"memobox_52.203-16[0]": "EDITABLE TEST",

"postcontract_days_52.207-3": "90",

"term_placeholder_52.232-22[0]": "TASK ORDER",


"term_placeholder_52.232-22[2]": "Schedule",











"textbox_52.246-20[0]": "20 DAYS",

"paragraph_a_text_52.211-12": "9000",

"paragraph_a_memo_52.211-12": "(a) If the Contractor fails to complete the work within the time specified in the contract, the Contractor shall pay liquidated damages to the Government in

46

the amount of {{paragraph_a_text_52.211-12}} [<i>Contracting Officer insert amount</i>] for each business day"

},

"application": {

"created_at": "2015-07-18T10:55:23Z",

"id": 4,


"org_id": 27,


"secret": "3232653831356530633966353461353061666162376138373464396662626131",

"uid": "3937396432396561623963303436646561346531663432376231643530343437",

"updated_at": "2015-07-18T10:55:23Z"

}

}

}

47

9. Appendix

9.1. Acronyms

Table 6 – Common AcronymsAcronym NameACRNs Accounting Classification Reference Number

API Application Program Interface

CLS Clause Logic Services

CWS Contract Writing System

DFARS Defense Federal Acquisition Regulation Supplement

DoD Department of Defense

DPAP Defense Procurement Acquisition Policy

FAR Federal Acquisition Regulation

IDEAS Integrated Defense Enterprise Acquisition System

PDS Pluggable Data Sources

RESTFUL API Representational State Transfer Application Program Interface

SAT Simplified Acquisition Threshold

48