Develop in CCMS Output Generator

If you have OGAT, you can develop and test CCMS Output Generator files in the Development Environment, then test the changes in the Test Environment and tag them for MadCap Software to upload to the Production Environment.

You must already point to OG. See Point to CCMS Output Generator.
Development requires a very strong awareness of the order of operations. In this case, that means using the right batch script at the right time. The sequence identified in OGAT script and folder functions is important enough to summarize again here.
  1. refresh_local.bat
  2. integrate_dita_ot.bat
  3. restart_dev_outgen.bat
  4. status_local.bat
  5. commit_changes.bat
  6. update_test_server.bat
  7. tag_current_state.bat
  8. restart_test_outgen.bat

To develop in CCMS Output Generator:

  1. Sign in to your RDP server.
  2. Every time you use the tool, update your copy of the repository by taking the following actions:
    Note: This step makes sure you have the latest updates from the trunk.
    1. In Drive Y (ogtools), double-click refresh_local.bat.
    2. Enter U to update without overwriting local modifications.
      refresh_local batch file
    3. Review the message that identifies all modifications.
  3. If there are conflicts between your local files and the repository, resolve them by taking the following actions:
    1. In the log file of your update operation in Y:\ogtools\log, review the list of file conflicts.
    2. Save a copy of your existing files outside of the Development Environment.
    3. Double-click refresh_local.bat, enter O to overwrite local modifications.
    4. Repeat your modifications in the Development Environment.
  4. Develop and test in the Development Environment by taking the following actions:
    1. In Drive Z (outgen), change the files as required.
    2. If you changed DITA Open Toolkits and need to run the integrator, double-click integrate_dita_ot.bat.
    3. Continue to make changes and test until all testing is successful.
  5. If you need to restart CCMS Output Generator in the Development Environment, double-click restart_dev_outgen.bat.
  6. Double-click status_local.bat to generate a log file where you can review the list of files ready for commit.
  7. Commit your changes and test them on the Test Environment by taking the following actions:
    1. Double-click commit_changes.bat to copy files from the Development Environment to the remote repository.
    2. When prompted, enter a message that describes your modifications.
    3. Double-click update_test_server.bat to copy files from the remote repository to the Test Environment.
    4. If you want to view logs generated by the update, go to the logs folder.
      Note: You cannot read the SVN logs directly, but you can read the log files in the Logs folder, which are in a text file format.
    5. If you need to restart CCMS Output Generator in the Test Environment, double-click restart_test_outgen.bat.
    6. In CCMS Desktop, set the Output Generator Hostname to the Test Environment Output Generator and test your changes.
  8. If you want to make additional changes, return to the development step.
  9. Issue a request to IXIA CCMS Customer Support to deploy the changes to your Production Environment by taking the following actions:
    1. Double-click tag_current_state.bat and enter a tag name to create an SVN tag of the current state of the files in the remote repository.
      Tip: You can continue developing because your earlier changes are captured in the tag.
    2. Create a ticket for IXIA CCMS Customer Support and request that they promote the modified files to the Production Environment.
      Note: Include tag names for the modified files.

      If you want to copy the tag name, you can find it in the log file in Y:\log\logs. The log file contains the comment you entered at the prompt, adds the date, and substitutes spaces with underscores. If you run tag_current_state.bat and a command window does not open, or if the command completes and you do not see the log file generated, please notify IXIA CCMS Customer Support. That could indicate an issue that requires further investigation.

    3. Monitor communications for a reply from IXIA CCMS Customer Support indicating that they promoted your changes.
    4. In CCMS Web in your Production environment, confirm your changes are present for Production Output Generator.
  10. Optional: After migration to Production, you may choose to run restart_test_outgen.bat.