.. comment
	
	all inline tags to start with _gs_tlt_

.. _gs_tlt_top:

********************************************
Team Leader Tasks before getting started
********************************************


.. include:: /pages/common/pageunderconstruction.txt
	:start-line: 3

.. contents::
	:depth: 2
  
============
Introduction
============

This page describes tasks done by the Team Leader before STEP standards developers can start work.

-----------
Prerequists
-----------

This assumes that:

* STEPlib Git repository has already been forked and branched as described in |git teamleader| 
* STEPlib Git repository has already been cloned as described in |git developer|.
* The MagicDraw environment has been set up, see :ref:`gs_md_top`.

.. index:: Application Protocol; How to - Create new
.. index:: How to; Create new Application Protocol

.. _gs_tlt_newAP:

======================================
Create a new Application Protocol (AP)
======================================

This explains how to add a new Application Protocol [:term:`AP`] to STEPlib.

:numref:`fig_gs_tlt_steplibModelStructure` below shows the model structure of an AP. 

.. _fig_gs_tlt_steplibModelStructure:
.. figure:: /images/howto/gs_tlt_steplibModelStructure.png
	:scale: 100%

	STEPLIB Model Structure – Package diagram

.. index:: Video; How to create a new Application Protocol (AP) 
 
The following video shows the steps (1-7) in this task.

.. raw:: html

	<div><video width="854" height="478" controls src="../../../_static/videos/gs_tlt_newAP.mp4"></div>

	
The steps in the task are as follows:

#. Open the ApplicationProtocols project (see :ref:`gs_md_opensubmodel`)
#. M-R on the ApplicationProtocols in the tree and select **Create Element** and then select **model**

	.. figure:: /images/howto/gs_tlt_ap01.png
		:scale: 100%

		Create Element > Model

#. **Rename** the new model to the name of the new AP, e.g. AP243
#. **Add a comment** with the full name of the AP

	.. figure:: /images/howto/gs_tlt_ap02.png
		:scale: 100%

		Rename and add comment

#. Export the model to a separate project
	* Select **Project Usages > Export Package to New Project**
	* The project should already be selected in the "Export Package to New Project" dialog, so select **OK**
	* **Yes** to "Show Auxillary resources"
	* **Yes** to "Check Dependencies"
	* In the "Save Dialog" 
		* make a **new folder for the AP** in the Application_Protocols folder
		* make a **new dvlp folder** in the the new AP folder
		* the default file name should be the name of the AP
		* the file type should be **mdzip** (default)
		* **save**
	* In the "Use Path Variables" dialog, the STEPlib environment variable is selected (default). select *Use Selected*
	* On completion a new mdzip file is created in the dvlp folder, and the ApplicationProtocols mdzip has been updated.
	
	.. figure:: /images/howto/gs_tlt_apexport.png
		:scale: 100%

		Export the model
	
#. Open the new ApplicationProtocol project (see :ref:`gs_md_opensubmodel`)
#. Add the Core model (and/or other needed models) by setting to **Use Local Project**
	* Select File > Use Project > Use Local Project
	* Select **1. Select project** amd then **From predefined location**
	* Select the location or add a new location using the "..." button
	* select the mdzip from STEPlib/Core_model/dvlp/Core_model.mdzip
	* click **Next** (2. Specify usage options). 
		* **Accessibility** of **Read-only** should be used to prevent accidental editing
		* **Load Mode** default is **Always Load**, change to improve performance if needed
	* Finish
	
	.. figure:: /images/howto/gs_tlt_apuselocalproject.png
		:scale: 100%

		Export the model
#. Save all projects
#. Under the new Model (from step 2) create a new model called **ActivityModel**
#. Export to a separate project stored APxx/ActivityModel/dvlp/ and set to **Use Local Project**
#. Under the new Model (from step 2) create a new model called **ConceptualModel**
#. Export to a separate project stored APxx/ConceptualModel/dvlp/ and set to **Use Local Project**
#. Under the new Model (from step 2) create a new model called **DomainModel**
#. Export to a separate project stored APxx/DomainModel/dvlp/ and set to **Use Local Project**

On completion, the containment tree should be as shown in :numref:`fig_gs_tlt_apexportfinished` below:

.. _fig_gs_tlt_apexportfinished:
.. figure:: /images/howto/gs_tlt_apexportfinished.png
	:scale: 100%

	STEPLIB Model Structure – for AP

.. todo::
	naming convention for package/files/etc
	
	
.. index:: Core Model; How to - Create new CTC
.. index:: How to; Create new CTC
	
.. _gs_tlt_newCTC:

==========================================
Create a new CTC in the Core model
==========================================

Adding a new Core Technical Capability [:term:`CTC`] to the Core Model in STEPlib uses the same process as described in :ref:`gs_tlt_newAP` above.

.. figure:: /images/1theSteplibArtefacts/highLevelSteplib.png
	:scale: 100%
	
	High level STEPLIB structure


.. _gs_tlt_split:

==========================================
Modularization to enable multi-file models
==========================================

This is explained in :ref:`gs_tlt_newAP` (as steps 5-7) above.

.. index:: Video; How to import existing models into STEPlib

.. index:: Application Protocol; How to - Import Existing
.. index:: How to; Import existing Application Protocol

======================================
Importing existing models into STEPlib
======================================

This section shows how to import an existing self contained |MD| project into the Domain Model. 
Importing into other areas and from other formats uses the same process.

The steps in the task are as follows:

#. Open the project
#. select **File > Import** and choose the appropriate format (|MD| will match and consolidate where appropriate)
#. Tidy up, moving the imported content into the correct area of the STEPlib model
#. Save

.. raw:: html

	<div><video width="854" height="478" controls src="../../../_static/videos/gs_tlt_importFromOtherProject.mp4"></div>

.. index:: STEPlib; How to - Add Existing Profile
.. index:: How to; Add an existing profile

.. _gs_tlt_addprofile:

==========================
Adding an existing profile
==========================

The steps are:

#. File > Use Project > Use Local Project
#. Choose (default) Select project > From predefined location. Then select the existing path that starts with <STEPlib>, and select the file
#. Specify usage options (default) Read-only and Always load
#. The profile can then be seen in the containment tree.

.. figure:: /images/howto/gs_md_addprofile01.png
	:scale: 100%
	
	Steps to add an existing profile


	
.. _gs_tlt_permissions:

=======================
Managing permissions
=======================

.. todo::
	the rest of this section.
	
.. todo::
	the rest of this page.
	
	
.. sectionauthor:: |Judith Crockford|

.. include:: /keywords.rst