May 2017 Newsletter

May Already

Since our last newsletter: We sincerely hope that those of you who celebrate Easter had a nice break and are not too full of Easter Eggs!   We’ve also had an Activity Diagram to celebrate St. George’s day and tried to conquer the Universe on Star Wars Day with some Functional Modelling. That aside development continues on Cradle 7.3.

New Voices

We’ve expanded the writing team to include authors from elsewhere in the 3SL team. Because this is a blog, there is more emphasis on people’s personal insights into the Cradle product. This should make the style and tone more varied and hopefully more interesting to read.

As you may have already seen the 3SL-Blog is groaning full of new articles. These are mainly “Hints and Tips” and longer RM/SE articles. Increasingly we’ve found that some of the support questions that arrive here in 3SL towers are very similar. To that end we’re publishing them under the FAQ section.

If you have a burning question and would like to see an article covering a particular topic, drop us a line at social-customer@threesl.com and we’ll see what we can do. On the other hand, if you have a novel use of Cradle that you’re happy to share with us, drop us a line with the article, screen shots and accreditation details and we may feature it.

Non Graphic Interfaces

There is widespread understanding of the WorkBench and even Web Access interaction with Cradle. It is, after all the main way we interact with the data. However, there are many occasions when we want some of the data from Cradle but don’t want to or can’t use a screen to interact. This month we’re highlighting c_table.

c_table

This command line utility can be used to produce Reports, Matrices, Metrics, Graphs or Queries in a tabular form. This can be an HTML, RTF, CSV or SVG output. If every morning you need to go into a meeting, or stand at your ‘toolbox talk’ with a printed report detailing the number of ‘Issues’ with a category of ‘Raised’ you can do this by running one command. Creating a desktop short cut to run the command / batch file you need not start WorkBench just to run the query and publish the result. Even more cunningly a script could be triggered at 8:00am every morning to create the document for you.  Our blog article “Batch File Reporting in Cradle” adds more detail.

CompeteFor

If you are working or bidding on large infrastructure projects,  Cradle is now available through the CompeteFor procurement portal. Whatever the size of your Requirements Management or Systems Engineering task, Cradle is there from Concept to Creation.

Social Media

Twitter

May Day 2017 Madness Giveaway. Thanks to all those who re-Tweeted and followed @threesl, during our Twitter #FreebieFriday giveaway and congratulations to @baguettio, who won a copy of Cradle RM Desktop. It was really great to see re-Tweets from around the globe.

Hints of the Month

Here are some links to helpful topics since our last newsletter, they should improve your Cradle experience:

When working in large teams or over a long period an item’s edit history is very useful. See the LinkedIn discussion Who Changed That? When? Why?

When you have many items to submit all in one go, selecting them on the screen and submitting them is not practical. This article Configuration Management – Submit by Query discusses the alternative.

You can read Hints & Tips in the 3SL Blog.

Single Diagram Consistency Check

Want to run a Consistency Check on just a single diagram?

Consistency Check from the Project Sidebar

If the user doesn’t wish to open the diagram, to run a consistency check. They can just right-click on a diagram in the Project sidebar tree and select ‘More –> Consistency Check’ from the context menu.

Consistency Checking a diagram from Project Tree
Using the Consistency Checker for a single diagram

This will bring up a report on the errors and warnings within the diagram; it will not open the diagram:

Physical Architecture Diagram Consistency Check Report
PAD Consistency Check Report

Check Diagram within a Form

If the user is happy to open the diagram in a form, they can right-click on the diagram and select ‘More –> Consistency Check’ from the context menu. They can also select the Diagram tab and click on the Consistency button.

How to Consistency Checker a single diagram in a form
Single Diagram Consistency Checking from a diagram form

Once the check is done the diagram will show you with the colours red (item has an error) and green (item is fine) in the diagram. A report with the errors within the diagram will now open as well.

Physical Architecture diagram showing the errors in red
Physical Architecture diagram showing the errors

Once you have checked and corrected the errors found, you can then recheck the diagram if you so wish.

Complete Consistency Check of a single diagram in a form
Complete Consistency Check of a single diagram in a form

Once the diagram is error free, it will show all symbols as green and the report will not show any errors.

Click for more information on the Consistency Checker

Having Trouble Preparing Your Documents for Capture?

Preparing Documents

Here are some small hints and tips for formatting/preparing your documents correctly, which will save you time and energy otherwise expended on laborious cut and paste exercises.

Microsoft® Word Formatting

In order to parse documents, Document Loader uses  the hierarchical Word document structure. That is, it will assume that a Heading 1 is of higher importance than a Heading 2. It is important to remember that the document structure is more complex than just making a title by ‘increasing the font size’. Switching views to ‘Outline’ can help you understand how Word see the document. This will assist in preparing your documents for Document Loader to parse.

  • Document Loader expects each requirement to be in a single paragraph and formatted with an appropriate heading style to indicate its level in the hierarchy.

    Screenshot showing different heading styles in document indicating different levels in the hierarchy
    Document heading styles to indicate level in hierarchy
  • Requirement text, figures and other information should be positioned directly beneath the heading and formatted using paragraph style Normal or other body text-level style.
  • Use separate paragraphs for distinct pieces of information, e.g. Assumption text and Requirement text.
  • Always use paragraph styles rather than text formatting to change the appearance of a paragraph.
  • Heading styles apply an outline level to your paragraphs, which tell Document Loader about the level of each requirement in the hierarchy
  • Document Loader prefers pictures and OLE objects to be inserted in line with text. This means the picture is positioned in the text layer of the document, rather than floating on top of the text. In line pictures produce a better document structure.
  • If you use captions to describe the pictures in your document, make sure that the caption is positioned immediately before or immediately after the picture, and formatted with Word’s caption style.
  • If your document contains diagrams built with Word’s drawing objects, then you must ensure that all shapes in the diagram are grouped, otherwise Document Loader will parse each shape as a separate image.
  • If you plan to capture a table with a requirement in each row, then your table must be uniform, that is, no merged cells and have the same number of columns in each row.
  • As with pictures, if you use captions to describe the tables in your document, make sure that the caption is positioned immediately before or immediately after the table, and formatted with Word’s caption style.

    Screenshot showing captions directly before a table you want to capture
    Caption directly above table

For more information on formatting your documents correctly please refer to our online help.

How do I fix CDS connection errors?

Diagnosing CDS connection Errors

If you receive a CDS connection error when starting a Cradle tool, the following steps will help you diagnose the most common CDS connection errors and show you how to resolve them. These errors are highlighting a communication problem between the client tool (e.g. WorkBench, Document Loader or Document Publisher) and the Cradle Database Server (CDS). There are four main possible causes ;

Error message saying Could not connect to CDS
Can not connect to CDS error dialog

1 – The CDS is not running.

  1. The CDS is on the same machine as the client, (e.g. Single user products or Cytrix installations) . Run Project Manager to see if the CDS is running or look in the process list (Task Manager on Windows, or ps Process List on Linux)  for  crsvr.exe.
  2. The CDS is running on another machine
    1. In the same TCP/IP subnet (e.g. usual client/server Enterprise installation) . Start Project Manager and look for the CDS.
    2. Another subnet. Login to that machine and look for it in the process list or contact the administrator of that other machine.

Solution – Start the CDS on the machine where it is to run,  by starting Project Manager and starting the CDS. Or at a Linux command prompt

c_start start

If the CDS will not start and is not returning any messages then open a command prompt and perform the following dependant on platform

Windows

Type the following in a command prompt

cd %CRADLEHOME%\bin\exe\windows
crsvr.exe

Linux

Type the following in a command prompt on Linux 32 bit;

cd $CRADLEHOME/bin/exe/linux-ia32/
./crsvr

Type the following in a command prompt on Linux 64 bit;

cd $CRADLEHOME/bin/exe/linux-x86_64/
./crsvr

2 – CDS is running but the Cradle tool is not communicating with it.

Check the CDS is running on a different PC but your Cradle system is set to standalone.

Look for an environment variable called CRADLE_STANDALONE and if it exists either delete it or set its value to false.

Then look in the startup file for the variable STANDALONE and ensure that it is set to false.

3 – The Cradle tool is trying to communicate with the CDS, but its communications do not reach the CDS.

Check that there is evidence that the Cradle tool’s messages are reaching the CDS. To do this, look at the file cds_access.log on the machine running the CDS. There is one multi-line entry in this file for every connection attempt that the CDS receives. If the Cradle tool’s attempt to connect to the CDS reaches the CDS, it will be in this file. Make a note of the last entry in the file, then close it and attempt  to start the Cradle tool. Look at the cds_access.log file again and see if a new entry has appeared at the bottom of it. If not, then the Cradle client’s attempts to connect to the CDS are not being received by the CDS.

If the CDS runs on a machine in another TCP/IP subnet to the PC where the tool is being run, define an environment variable called CRADLE_CDS_HOST whose value is the TCP/IP address or hostname of the machine running the CDS. Run the tool again and look for an entry appearing at the bottom of the cds_access.log file. If the CDS runs on a machine in the same TCP/IP subnet to the PC where the tool is being run, look for the CRADLE_CDS_HOST environment variable and check that its contents are correct. You can delete the variable if this CDS is the only CDS running in the subnet.

Ensure the correct ports are opened on your firewall, the specific ports can be edited from the ports file.

4 – The Cradle tool can communicate with the CDS, but the CDS is ignoring it.

On the machine running the CDS check the cds_hosts file. This file has to either be empty ( all clients are allowed to be connected to the CDS) or it contains a list of IP address / machine names allowed/disallowed to connect to the CDS.

Configuration Management in Web Access

Performing CM Tasks in Web Access

Most Configuration Management tasks are achieved using WorkBench but Configuration Management in Web Access is also available. For instance you can submit and review information in Web Access as well as unsubmitting items. These CM tasks are available in the Web AccessConfiguration Management” sidebar:

CM Sidebar in Web Access
Configuration Management in Web Access

You can submit items by query or you can submit them individually. Providing there are reviewers for the information, any user can submit information for approval.

Items can also be unsubmitted which cancels their review. This does depend on:

  • The ownership of the items
  • The current user’s privileges
  • The status of the item in the database
  • Whether any reviewers have started to review the item

Once items have been submitted for review, they can also be reviewed in Web Access.

If you have the TEAM_APPROVE privilege you can review information on behalf of a team member, therefore preventing reviews being held up due to team absences,

Configuration Management in Web Access
Review Dialog

In conclusion, if you are remotely working, with access to Cradle only via a browser,  it is possible to review and approve or reject items. This can have great benefits to time-scales, it alleviates waiting for reviews to complete and negates having to manage an email ping-pong.

A Reviewer Specific UI in Web Access

Continue reading “Configuration Management in Web Access”

How do I save my progress in Document Loader?

Saving progress in Document Loader

If you are working on a large document and need to save  your current position, for example if you need to shut-down your PC for any reason. You can save progress in Document Loader by using a session to save a snapshot. You can then return to the same point at a later time and date. You can then continue to finish your capture or just do a little more and re-save the session to continue again later.

A session stores information about the state of Document Loader at a given point, such as:

  • A copy of the current document
  • A copy of the current capture setup definition
  • Which parts of the document have already been captured
  • The state of the Document Explorer tree nodes
  • Any mappings, e.g. table mappings
  • Any changes made in the Options dialog
screenshot showing load session retains previous progress
Load Session in Document Loader

For further information on how to save progress in Document Loader and Save/Load and Delete sessions in Document Loader please read this post.

Article Updated –  28/01/2019 Increased image size

Using Parametric Queries

Parametric Queries in WorkBench and Web Access

Parametric queries prompt you at runtime for values for certain parameters prior to the query being run. They are supported for Identity, Name, Key, Level and free-format categories (including picklists).

You are prompted for values when the query is run from the following places:

  • Query Details dialog
  • Definitions sidebar
  • Phase tree
  • As part of a report
  • When performing an export by query
  • A start page

From the Query dialog press the arrow button next to the field you want to set the prompt for and select “Choose at Runtime“. This produces the “Runtime Parameter Definition” dialog where you can setup the parametric query prompt:

Screenshot to show prompt when running parametric queries
Prompt shown when running parametric queries

You can also specify more than one parametric in the query dialog. This can prove very useful in simplifying the interaction in not having to use the full query details window.

When you run a parametric query the prompt will be shown. An example is shown below:

Prompt shown when running a parametric query
Parametric Query Prompt

Parametric queries are supported in both WorkBench and Web Access.

For further information please see the Cradle online help.

Article Updated 04/02/2019 –  Added further details

Copying Text from Multiple Data Cells

What are Multiple Data Cells?

Multiple data cells are a useful way to combine a number of attributes in a single view cell. However, unlike other cells,  the contents of Multiple Data cells can’t be copied in the same way. However, copying text from Multiple Data cells is still possible.

Scrrenshot of the View details dialog and Multiple Data Cell Setup
Multiple Data Cell Setup

Read information on creating Multiple Data Cells   in the online help.

Copying Text from Multiple Data Cells

Usually, when in the Table or Document view styles, to copy the text contained in a cell you can simply click the cell to make it editable, select the text and use a keyboard shortcut (<ctrl> + C) to copy.

A Multiple Data Cell can use data from different sources. This means all cells of this type are uneditable from within a View. For this reason the method used to copy the contents of the cell is different from a standard Text Frame or Category, for example.

To copy the text contained within a multiple data cell, select the item which has the text you wish to copy and right-click to open the context menu. Once the context menu is open, select More -> Copy Item Text -> Multiple. The contents of the multiple data cell for the selected item will now be in your copy/paste buffer.

How to copy text from a multiple data cell in Cradle
Copying text from a multiple data cell in WorkBench
Article Updated 04/02/2019 – Added an image showing the setup of a multiple data cell

Using Sessions in Document Loader

Sick of having to start from scratch when working with large documents in Document Loader? Want to save your current progress and return at a later date?

You can use a session to save a snapshot of Document Loader, so you can return to the same point at a later time. Sessions are useful when working with large documents or if you need to shutdown your PC for any reason.

What is a Session?

Sessions store information about the state of Document Loader at a given point, such as:

  • A copy of the current document
  • A copy of the current capture setup definition
  • Which parts of the document have already been captured
  • The state of the Document Explorer tree nodes
  • Any mappings, e.g. table mappings
  • Any changes made in the Options dialog

How can I save a Session?

You can only save a session when working with a new document; not a new version of a document. You can save a session at any time, so long as you have a document open.

To save a session you can either:

  • Press the Save Session button button from the Toolbar
  • Select Save Session from the File pulldown menu
  • Press Ctrl + S
    (
    The Status Bar shows the progress of the Save operation)

How can I load/restore a Session?

  • To load a saved session you can either:
  • Select Load Session from the File pulldown menu
  • Press Ctrl + L
    If you attempt to load a session with a document open you will be prompted to close the current document. The Load Session dialog will be displayed as shown below:
screenshot showing the load sessions dialog
Load Session Dialog

Simply identify the session you wish to load and select it in the list. You can sort on any column by clicking on its column heading; click once for ascending order and again for descending order.
Click the OK button to load the selected session.

How can I delete a Session?

To delete a session you need to open the Load Session dialog by either:

  • Selecting Load Session from the File pulldown menu
  • Pressing Ctrl+L
    Select the appropriate session and press the Delete button. Select Yes to confirm the deletion and Cancel to remove the Load Session dialog.

Star Wars Day 2017

Set the Context for Universal Domination in a DFD

Happy Star Wars day 2017

Whatever your Systems Engineering tasks you can use diagrams to illustrate the various components. In classic functional modelling the Essential domain shows the operational, theoretical, side of the design, and the Implementation domain models the actual real world components.

Data Flow Diagram DFD showing Cradle Globes as Death Star
Death Star DFD

The Context Diagram shows the entire system or subsystem as one process with the exchanges of information between it and its environment.  In today’s example, this is the ‘Death Star‘ , the external environment being the universe!

From the context diagram a set of hierarchical Data Flow Diagrams (DFDs) give a view of units of functionality and the exchanges of data between these units. So we would expect DFDs covering the Emperor’s Tower, Surface City, Superlaser Focus Lens and so on. So May the Fourth Be With you, and all your modelling.