Open topic with navigation

Checking Out Source Control Files

When you need to work on any of the Flare project files, you can check them out. Checking out files means to copy the latest source control files to your local Flare project and remove the "Read Only" designation from them so that you can edit the files. A red check mark is displayed next to each file that is checked out.

How to check out files from source control

1. Do one of the following, depending on the particular file(s) that you want to work with.

   All files in the project: 

   1. In the Standard toolbar, click the down arrow next to the Source Control button . (You can also use the menu bar and select File>Source Control).
   2. Select Project.

   Specific content files only:

   1. Make sure the Content Explorer is open. By default, the Content Explorer is located on the left side of the interface in an accordion structure with the Project Organizer, unless you have previously moved it and saved the new layout. You may have to click the Content Explorer bar to bring it into view.

   2. Select the relevant folder or file.

      If you choose a folder, you can recursively select all files under the folder.

      If you want to choose all content files, select the root Content folder.

      Note: If you want to select several specific files at the same time, open the File List window pane instead (View>File List) and choose the appropriate files using the CTRL or SHIFT key.

   3. In the Standard toolbar, click the down arrow next to the Source Control button .

      Note: Alternatively, you can right-click on the file or folder and select Source Control from the popup menu.

   Specific project files only:

   1. Make sure the Project Organizer is open. By default, the Project Organizer is located on the left side of the interface in an accordion structure with the Content Explorer, unless you have previously moved it and saved the new layout. You may have to click the Project Organizer bar to bring it into view.

   2. Select the relevant folder or file.

      If you choose a folder, you can recursively select all files under the folder.

      If you want to choose all project files, select the root Project folder.

   3. In the Standard toolbar, click the down arrow next to the Source Control button .

      Note: Alternatively, you can right-click on the file or folder and select Source Control from the popup menu.

   Main FLPRJ file:

   1. Select Project>Project Properties.

      The Project Properties dialog opens.

   2. Select the Source Control tab.
   3. In the Project File section, click the down arrow next to the Source Control button .

2. Select Check Out (or Check Out All if working with all files in the project).

   The Check Out dialog opens.

3. If you have selected a folder and want to check out all files under it (or if you are working with all project files), click the Recursive check box.
4. If the local files on your machine are different from those in source control, select one of the options in the Check Out Files That Differ section:
   • Prompt me for each file. Another dialog will open for each file, asking you to confirm whether to check out the file even though it is different from the local file, or to not check out the file.
   • Get latest version, overwriting the local copy of the file and check out the file. Use this option if you know that you prefer to use the source control copy of the file, rather than your local copy. The local file will be overwritten, and the source control copy will be checked out to you.
   • Keep changes made to the file and check out the file. Use this option if you know that you prefer to use the local copy of the file, rather than the source control copy. The local changes will be preserved, and the file will be checked out to you. When you check the file in, the source control copy will be overwritten with your local copy.
   • Do not check out the file. Use option if you do not want to check out the file.

   Note: These options are most likely to apply to your situation if you are working in a multi-author environment. If you are the only author working on the project, your source control files will most likely already match your local files when you perform a check out.

5. If other authors are also working on the Flare project, select one of the options in the Multi-User Check Out section:
   • Prompt me for each file. Another dialog will open for each file, asking you to confirm whether to check out the file even though it is already checked out by another user, or to not check out the file.
   • Check out the file, even though it is currently checked out by another user. Use this option if you are working in a multi-user mode in the source control application. The files will be checked out to you, even if another author is also editing them at the same time. Your changes will be merged with those of the other author after you both check in the files. In order to successfully take advantage of this option, you must ensure you are correctly set up for multi-user check outs in the source control application.
   • Do not check out the file. Use this option if you do not want to check out the file.

You do not need to worry about these options if you are the only individual working in the project.

6. Click OK.

   What happens next depends on the circumstances:

   • If you are the only author working on the project, the file(s) is/are normally checked out. (If you are working from the Project Properties dialog, click OK.) However, if the source control file differs from the local file, the Confirm Get Latest and Check Out dialog may open. If so, select an option in that dialog to use either the source control version or the local version of the file, and click OK.
   • If another writer has the file(s) checked out and you selected the first option in the previous step, the Confirm Check Out dialog opens. Continue with the next step.
   • If another writer has the file(s) checked out and you selected the second option in the previous step, the file(s) is/are checked out. (If you are working from the Project Properties dialog, click OK.)
   • If you selected the last option in either of the previous steps, the dialog closes and the file(s) is/are not checked out. (If you are working from the Project Properties dialog, click OK.)
7. Select one of the available options in the Confirm Check Out dialog. This includes the ability to request the other user to check in the file(s).
   • Option 1: Request check in To send the other user an instant message or email, complete the following steps:

     1. Click Request Check In.

        The Send Request Check-In Message dialog opens. The individual who has the file(s) checked out is automatically selected in the dialog.

     2. Select either Send Instant Message or Send EMail.

     3. (Optional) Enter a message to the other user.

        If you leave the Message field blank, Flare sends a default message.

     4. Click Send.

        A popup indicates that the instant message or email has been sent to the other user.

     5. Click OK.
     6. If you are working from the Project Properties dialog, click OK.

     When the other user receives the instant message, that person can click a button in the message that automatically checks the file in. 

     When the other user receives the email, it will contain an attachment. When that person opens the attachment, the file is automatically checked in.

     Afterwards, you will receive a message indicating that the file has been checked in, and you can click a button in that message to automatically check the file out.

   • Option 2: Check out the file, even though it is currently checked out by another user. Use this option if you are working in a multi-user mode in the source control application. The files will be checked out to you, even if another author is also editing them at the same time. Your changes will be merged with those of the other author after you both check in the files. In order to successfully take advantage of this option, you must ensure you are correctly set up for multi-user check outs in the source control application.
   • Option 3: Do not check out the file. Use this option if you do not want to check out the file.

See Also

Open topic with navigation