Commit debbcf5c authored by Johannes Grohmann's avatar Johannes Grohmann
Browse files

added quick start guide

parent 448a52e2
<?xml version="1.0" encoding="UTF-8"?>
<projectDescription>
<name>tools.descartes.dml.quickstart</name>
<comment></comment>
<projects>
</projects>
<buildSpec>
</buildSpec>
<natures>
</natures>
</projectDescription>
\documentclass[11pt,a4paper,pdftex]{article}
\usepackage[utf8]{inputenc}
\usepackage{amsmath}
\usepackage{amsfonts}
\usepackage{amssymb}
\usepackage{graphicx}
\usepackage{url}
\usepackage{hyperref}
\usepackage{graphicx}
\graphicspath{{figs/}}
\usepackage{longtable}
\newcommand{\HRule}{\rule{\linewidth}{0.5mm}}
% TODOs
\usepackage[colorinlistoftodos, textwidth=2.0cm]{todonotes}
\newcommand{\todoall}[1]{\todo[inline, color=orange!40]{OPEN: #1}}
\newcommand{\todojg}[1]{\todo[inline, color=blue!40]{JG: #1}}
\newcommand\jg[1]{\textcolor{blue}{#1}}
\begin{document}
\input{DML_UserGuide_Title.tex}
\tableofcontents
\newpage
\input{introduction}
\input{usage}
%\input{approaches}
%\input{parameters}
%\input{extensions}
%\bibliography{bib}
%\bibliographystyle{plain}
\end{document}
\ No newline at end of file
\begin{titlepage}
\begin{center}
% Oberer Teil der Titelseite:
\title{First Steps with DML}
\date{{\large \today}
}
\author{Johannes Grohmann, Simon Eismann, Jürgen Walter}
%\includegraphics[width=0.85\textwidth]{../Icon/LibRedeLogo-high.png}\\[1cm]
\HRule \\[0.4cm]
{ \huge \bfseries User Guide}\\[0.4cm]
\HRule \\[1.5cm]
\vfill
\centering{\url{http://descartes.tools/dml}}
\newline
\newline
{\large \today}
\end{center}
\end{titlepage}
\ No newline at end of file
\section{Introduction}
What is DML?
\todoall{copy from user guide?}
\ No newline at end of file
\section{Installation}
The following steps guide you through the installation of the DML Bench.
\subsection{System Requirements}
In order to install DML, your system needs to meet the following prerequisites:
\todoall{is that correct?}
\begin{itemize}
\item \textbf{Operation System:} Windows 7/8/10, MacOS X or Linux, all 32-bit or 64-bit
\item \textbf{Java Runtime Environment:} at least 1.6
\item \textbf{Eclipse:} Eclipse Standard 4.4 or higher\footnote{Download from \url{http://www.eclipse.org/downloads/}}, with the Eclipse Modeling Tools\footnote{Download from \url{https://eclipse.org/downloads/packages/eclipse-modeling-tools/lunasr1}} installed.
\end{itemize}
\subsection{New Installation}
You can install the DML bench as an Eclipse plugin from the update site\footnote{\url{https://se4.informatik.uni-wuerzburg.de/dml/downloads/snapshot/}}. Follow these steps:
\begin{enumerate}
\item In Eclipse go to \emph{Help} $\rightarrow$ \emph{Install new Software} \\
\includegraphics[width=0.9\textwidth]{Screenshot(2).png}
\item Add a new repository with \url{https://se4.informatik.uni-wuerzburg.de/dml/downloads/snapshot/} as location. \\
\includegraphics[width=0.9\textwidth]{Screenshot(4).png}
\item Select all desired plug-ins from the DML Bench (usually all) for installation and click next.\\
\includegraphics[width=0.9\textwidth]{Screenshot(6).png}
\item Accept the license agreements.
\item Confirm the security warning. \\
\includegraphics[width=0.6\textwidth]{Screenshot(7).png}
\item After completion, restart Eclipse. \\
\item Done. You should now be able to use DML with your Eclipse installation.
\end{enumerate}
\subsection{Update Existing Installation}
To update an existing installation of any DML plugin follow these steps:
\begin{enumerate}
\item In Eclipse go to \emph{Help} $\rightarrow$ \emph{Check for Updates}
\item Wait for the Eclipse operations to complete.
\item If a DML update is available, select the plug-ins you want to update (usually all) and follow the next steps to install it. Otherwise, your installation is up-to-date.
\item Accept the license agreements.
\item Confirm the security warning. \\
\includegraphics[width=0.6\textwidth]{Screenshot(7).png}
\item After completion, restart Eclipse. \\
\item Done. Your DML bench should now be up-to-date.
\end{enumerate}
\section{Getting started}
This section explains the first steps with a simple example.
\subsection{Importing a simple example model}
A set of example models can be found and downloaded at \url{https://se3.informatik.uni-wuerzburg.de/descartes/dml-examples}.
The easiest way to try one is described in the following:
\begin{enumerate}
\item Download the zip archive containing the examples at \url{https://se3.informatik.uni-wuerzburg.de/descartes/dml-examples/repository/archive.zip?ref=master}.
\item Unpack the zip archive into a folder of your choosing, e.g. your workspace.
\item You can now either import all projects as an existing eclipse projects or just import a simple example. The following steps assume you want to import the ``Hello World'' model.
\item Right-click on the \emph{Project explorer}.
\item Click on \emph{New} $\rightarrow$ \emph{Project...}.
\item From \emph{General}, select \emph{Project} and confirm by clicking on \emph{Next}.\\
\includegraphics[width=0.6\textwidth]{Screenshot(10).png}
\item Enter ``Hello World Example'' or any other name you like as project name and confirm by clicking on \emph{Finish}.\\
\includegraphics[width=0.6\textwidth]{Screenshot(11).png}
\item Now, right-click on the new project in the \emph{Project explorer} and select \emph{Import...}.\\
\includegraphics[width=0.6\textwidth]{Screenshot(12).png}
\item From \emph{General}, select \emph{File System}.
\item After clicking on \emph{Next}, select \emph{Browse} in the following window.
\item Then browse to the location containing the unpacked DML examples and select the folder \emph{HelloWorldExample}.
\item Select all items and then click on \emph{Finish} to import the files into your existing project.\\
\includegraphics[width=0.6\textwidth]{Screenshot(13).png}
\item Your project should now look like this:\\
\includegraphics[width=0.6\textwidth]{Screenshot(15).png}
\end{enumerate}
\subsection{Execute a simple query}
The projects usually contain multiple folders. The folder \emph{DML-Model} contains all DML model files required to specify the system.
For modeling the application architecture, there are a repository model and a system model. To model the resource landscape, there are resource landscape, container repository, and resource type model. Furthermore, there are deployment models connecting application architecture and resource landscape, as well as usage profile models.
\todoall{which cite/link to DQL?}
In order to solve the DML models, Descartes Query Language (DQL) queries are formulated. A set of example queries is contained in the folder \emph{DQL-Queries}.
Using the DQL launcher as shown in the figure below, DQL queries can be issued.\\
\includegraphics[width=0.6\textwidth]{Screenshot(17).png}
\todoall{fails upon execution for me}
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment