OGAT script and folder functions

Output Generator Access Tool includes a list of Windows batch files that run in the background and several additional folders that support the use of the tool.

Table 1. OGAT batch scripts in order of operation
Item in sequence

File name

Function

Applicable scenario

1

refresh_local.bat

Pulls file modifications from the remote repository to the Development Environment

  • U updates only, so retrieves a fresh copy of the files, but also preserves any modifications in the Development Environment
  • O overwrites all files in the Development Environment with copies from the remote repository
  • After migration from Dev to Production
  • After modifications commit, to push from your repository to Dev
Note: You must run this batch script after MadCap Software acts on migrating your requested modifications to Production.

2

integrate_dita_ot.bat

Runs the integrator for each DITA Open Toolkit in the CCMS Output Generator

  • After addition of new plugin

  • After significant changes to an existing plugin, such as the addition of a transformation type

3

restart_dev_outgen.bat

Restarts CCMS Output Generator in the Development Environment
  • CCMS Output Generator is not running after migration from Dev to Production
  • After installation of a new DITA Open Toolkit

4

status_local.bat

Obtain a list of the files in the Development environment for commit when you run commit_changes.bat.

 After modifications to files in Development environment
Tip: Review list of changes to ensure only the files you intend to modify are part of your commit operation

5

commit_changes.bat

Pushes modifications from the Development Environment to the remote repository, and so requires you to enter a message describing your updates

After modifications to files in Development environment

6

update_test_server.bat

Pushes files after your commits from the remote repository to the Test Environment

 Activate in the Test environment all modifications committed from the Development environment

7

tag_current_state.bat

Captures an SVN tag of the current state of files in the remote repository and associates it with a label that you define

 Prepare to log a request in OTRS for your commits
Note: Use the related tag to identify the specific file revision for promotion to the Production Environment.

8

restart_test_outgen.bat

Restarts CCMS Output Generator in the Test Environment
  • CCMS Output Generator is not running
  • After installation of a new DITA Open Toolkit
Table 2. Additional folders

Folder

Function

Logs

Contains an itemized history of the script and any problematic issues that resulted, for example when running refresh_local.bat

Note: There is one batch script that does not create a log file: update_test_server.bat.

Resources

Contains read-only files that act as reference material for developers using OGAT