Exporting/Importing a Background Procedure

Navigation:  How to Work with Background Procedures >

Exporting/Importing a Background Procedure

Previous pageReturn to chapter overviewNext page

 

Overview

 

Background Procedures that have been developed within MCL-Designer are reusable. Use the Library - a folder that stores reusable elements such as data files, programs, screens, etc.- for the "export"/"import" of the background procedure you want to make available for other projects.

Export the background procedure (created in a specific MCL-Designer project) into Library, then, have it imported, from Library, into another MCL-Designer project.

 

 

To Export a Background Procedure to Library

 

Step-by step

 

1. Open the "Procedures" module.

 

2. Right-click the background procedure you want to export.

 

3. In the resulting menu, click the "Library Export" option.

 

 

This opens an "Export to Library" window.

 

 

4. The default MCL-Designer Library is already selected but, if required, you can select a different source Library or rename it by clicking . See To Define a Library.

 

5. Fill in the following options:

 

Background Proc Information

Background Proc Name

Maintain or enter a new name for the background procedure about to be exported.

Text Box

If required, add notes regarding the background procedure being exported.

Export Options

MCL Source Code

Check this option if you want the settings/content of the background procedure being exported to be available for editing once it is imported into another MCL-Designer V4 project.

MCL-Script (executable)

Check this option if you want to lock the settings/content of the background procedure being exported. This means that when the background procedure is imported into another project, it will not be editable. The background procedure will be marked with a .

 

6. Click to conclude the export.

 

The exported background procedure is available in the Library ("Background Proc" section) and ready to be imported into another project.

 

As an alternative, you can use a Drag-and-Drop to initiate an export:

a. Open Library Manager (shortcut key - F4).

b. Drag the background procedure you want to export from the "Procedures" module and drop it on the "Library Manager" window. This opens the corresponding "Export to Library" window.

c. Proceed as described in steps 4, 5 and 6 ("To Export a Background Procedure to Library").

 

Click Here for Examples of Export Errors

 

 

To Import a Background Procedure from Library

 

Step-by-step

 

1. Open the destination project and use one of the following options to access the "Library Manager" window:

 

a. Go to the "Menu Bar", click "Tools" and, in the resulting menu, select "Library Manager".

 

 

b. Click <F4>.

 

c. Right click an empty area in the "Procedures" module, the "Background Procedures" section name or a background procedure and select "Library Import" in the resulting menu.

 

Whichever option you chose (a, b or c), it opens the "Library Manager" window.

If required, select a different source library or rename it by clicking . See To Define a Library.

 

 

2. Select the element type ("Background Proc") you want to import in the "Group" section, to the left.

 

 

"Library" elements that have Speech attributes, meaning, that were created within speech projects, are identified with a (ex: Background:Procedure_1).

A speech element (a program, a screen, a routine, a global procedure or a global event) can ONLY be imported into projects being developed within an MCL-Designer V4 with a Voice Add-on.

 

3. Use one of the following options to access the "Import into Project" window and continue the import operation:

 

a. Double-click the desired background procedure.

 

b. Drag the intended background procedure into the "Procedures" module area.

 

 

c. Select the intended background procedure and click .

 

d. Right-click the selected background procedure and click the "Import to Project" option.

 

 

The corresponding "Import into Project" window opens.

 

 

This window displays information that cannot be edited (regarding the background procedure being imported) and information you can edit (the "Destination" section).

 

If the destination project contains a background procedure with the same name as the background procedure being imported, the name of the imported background procedure will automatically change to "..._X" ("X "refers to an incremental number).

 

 

If the background procedure being imported is locked ("Export" option that turned the selected element into a non-editable element - see To Export a Background Procedure), you will not be able to edit its name. The option "Background Proc Name" will be inactive (displayed in gray).

 

 

You can either opt to change the name of the background procedure that already exists in the destination project (if it is not locked) and keep both background procedures OR  proceed with the import, in which case, the newly imported background procedure will overwrite the one that already exists in the destination project.

 

4. View, maintain or enter new information, as required by the project.

 

Import Background Proc

Displays the background procedure's name. NOT editable.

Text Box

Displays the background procedure's author and when it was added to the library. It can also include notes entered during the Export into Library operation. NOT editable.

Destination

Background Proc Name

Option only available if the element being imported was NOT previously "locked" during export.

Maintain the suggestion or enter a new name for the imported background procedure. Make sure the target project does not have a background procedure with the same name or the imported background procedure will overwrite the one that already exists in the destination project.

 

5. Click to conclude the background procedure import.

 

The newly imported background procedure is displayed in the "Procedures" module and available to the current project.

 

Click Here for an Example of an Import Error