Using the Workspace Wizard
A key feature of NetLinx Studio is the Workspace Wizard. The Workspace Wizard quickly steps you through the process of creating a new Workspace, with a Project and a System.
- To start the Workspace Wizard, select File > New.
- In the New dialog, select Workspace Wizard and click OK (FIG. 17).
FIG. 17 New dialog - Workspace Wizard selected
- In the Workspace Wizard dialog (FIG. 18), enter a name (up to 128 characters) for the new Workspace file in the text box (required).
FIG. 18 Workspace Wizard dialog
To enter an optional text description (2000 characters max) for the new Workspace, click Workspace File Description, and enter the description in the Workspace File Description dialog (FIG. 19). Click OK to return to the Workspace Wizard.
FIG. 19 Workspace File Description dialog
- Click Next to proceed to the Workspace File Location dialog (FIG. 20).
FIG. 20 Workspace File Location dialog
- Specify the target location for the Workspace file in the text box, or click the Browse (...) button (to the right of the text box) to locate and select a target directory via the Browse For Folder dialog. Click Next to proceed to the Project Identifier dialog (FIG. 21).
FIG. 21 Project Identifier dialog
- Enter an identifier (name) for the new Project in the text box. To enter additional information for the new Project, click Project Information and fill in the Project Information (up to 128 characters) and Description (up to 2,000 characters) text fields in the Project Information dialog (FIG. 22). All fields in this dialog are optional).
FIG. 22 Project Information dialog
Click OK to return to the Project Identifier dialog.
- Click Next to proceed to the System Type dialog (FIG. 23).
FIG. 23 System Type dialog
- Use the option buttons to select which type of System to add to the Project (NetLinx is the only option). This dialog also includes the option to add the System later, in which case the Workspace Wizard is complete. Select either NetLinx or Add System Later, and click Next to proceed to the System Information dialog (FIG. 24).
FIG. 24 System Information dialog
- Enter a name for the new System in the text box. To enter an optional text description (2,000 characters max) for the new System, click Workspace File Description and enter the description in the System Description dialog (FIG. 25). Click OK to return to the System Information dialog.
FIG. 25 System Description dialog
- Click Next to proceed to the Assign System ID dialog (FIG. 26).
FIG. 26 Assign System ID dialog
- To associate a System ID to the new System, enter the System ID in the text box. By default the ID is set to zero (0 = this System).
- Click Next to proceed to the System Communications dialog (FIG. 27). This dialog displays the current Master Communication Settings (read-only).
FIG. 27 System Communications dialog
- Click Communication Settings to proceed to the Communication Settings dialog (FIG. 28).
FIG. 28 Communication Settings dialog
NOTE: These settings become the default communication settings for all new Workspace f iles until they are manually changed.
Select or configure the communications settings to use with this system (see the
Communication Settings section on
page 118
for details), then click OK to save changes, close the Communications Settings dialog and return to the System Communications dialog.
- Click Next in the System Communications dialog to proceed to the Master Source Code File Selection dialog (FIG. 29).
FIG. 29 Master Source Code File Selection dialog
Use the option buttons to select the type of Master Source Code file to create for this System:
Create an empty AXS File: This option generates an AXS file that is totally empty (no templates used). See
Creating an
Empty AXS File on page 27
for details.
Add an existing AXS File to the System: This option adds an existing AXS file to the System as the Master Source Code File. See
Adding an Existing AXS File to the System on page 28
for details.
Create an AXS File Using Templates: This option generates an AXS file using the NetLinx template, depending on the System type specified in Step 7. This option results in a Source Code file that is formatted with header/footer information and all of the main sections of a typical Source Code File of the selected type. See
Creating an AXS File Using Templates on
page 29
for details.
- Add the Master Source Code File later: This option allows you to exit the Workspace Wizard at this point, and manually specify the System's Master Source Code File later.
- In the Wizard Completed dialog, click Finish to exit the Wizard.
The new Workspace (with your new Project containing the new System) is represented in the Workspace tab of the Workspace Bar.
Creating an Empty AXS File
This option generates an AXS file that is completely empty (no templates used).
- In the Master Source Code File Selection dialog, select Add an Existing AXS File to the System (FIG. 30):
FIG. 30 Master Source Code File Name dialog - Create an empty AXS file option selected
- Click Next to proceed to the Master Source Code File Name dialog (FIG. 31).
FIG. 31 Master Source Code File Name dialog
- Enter a name (up to 128 characters) for the new (empty) Master Source Code File.
- Click Source Code File Description to enter a description (up to 2,000 characters) in the Source Code File Description dialog (FIG. 32):
FIG. 32 Master Source Code File Description dialog
- Click OK to return to the Master Source Code File Name dialog.
- Click Next to proceed to the New File Location dialog (FIG. 33).
FIG. 33 New File Location dialog
- Specify the target location for the new file in the text box (click the Browse (...) button to locate and select a target directory via the Browse For Folder dialog).
- Click Next to complete the Wizard (FIG. 34):
FIG. 34 Wizard Complete dialog
Adding an Existing AXS File to the System
This option adds an existing AXS file to the System as the Master Source Code File:
- In the Master Source Code File Selection dialog, select Add an Existing AXS File to the System (FIG. 35):
FIG. 35 Master Source Code File Selection dialog
- Click Next to proceed to the Existing Master Source File Location dialog (FIG. 36).
FIG. 36 Existing Master Source File Location dialog
- Enter a path and filename of the desired Master Source Code File, or click the Browse (...) button to locate and select the desired AXS file via the Open dialog.
- Click Source Code File Description to enter an optional description (up to 2,000 characters) in the Source Code File Description dialog (see FIG. 32 on page 27).
- Click OK to return to the Existing Master Source File Location dialog.
- Click Next to complete the Wizard (FIG. 37):
FIG. 37 Wizard Complete dialog
Creating an AXS File Using Templates
This option generates an AXS file using the NetLinx template. This option results in a Source Code file that is formatted with header/footer information and all of the main sections of a typical Source Code File of the selected type:
- In the Master Source Code File Selection dialog, select Create an AXS File Using Templates (FIG. 38):
FIG. 38 Master Source Code File Selection dialog
- Click Next to proceed to the File Template dialog (FIG. 39).
FIG. 39 File Template dialog
- Select NetLinx Standard Template to use the standard NetLinx code template for this Master Source Code file. With this option selected, click Next to proceed to the File Template (Name) dialog (FIG. 40 on page 30).
If you select to use the NetLinx template, the new Source Code file will include all of the sections and headings DEFINE_DEVICE, DEFINE_CONSTANT, DEFINE_TYPE, etc.) that differentiate the various sections contained in a typical Source Code file for the indicated system type.
- Select User Def ined Template to use a selected AXS, AXI, AXB or other (.) file as the template for this Master Source Code file. With this option selected, click the browse button to select a file (via the Open dialog) to use as the template. With a file selected, click Next to proceed to the File Template (Name) dialog (FIG. 40 on page 30).
If you select User Defined Template, enter the file path for the AXS, AXI, AXB (or other) file to be used as the file template. Use the Browse (...) button to locate and select the file via the Open dialog.
- Enter a name (up to 128 characters) for the new Master Source Code File (FIG. 40).
FIG. 40 File Template dialog
- Click Next to proceed to the New File Location dialog (FIG. 41):
FIG. 41 New File Location dialog
- Specify the target location for the new file in the text box (click the Browse (...) button to locate and select a target directory via the Browse For Folder dialog).
- Click Next to complete the Wizard (FIG. 42):
FIG. 42 Wizard Complete dialog