SCM Macros

This section covers the Enterprise Extensions SMP/E SCM Macros which extend the EWM Ant toolkit by offering a build features that interact with the SCM.

The SCM Macros are utilities used by all of the Enterprise Extensions SMP/E Ant Scripts to request SCM services. The repository for the SCM Macros is the $scmcmd.xml file, which is imported in the top-level section of an Ant script using the following code snippet:

<!-- Load build extensions -->
<xt:loadBuildExtensions/>
<xt:getJarLocation property="jarPath"/>

<!-- Load common resources -->
<import>
    <javaresource name="scripts/smpe/imports/$common.xml">
        <classpath location="${jarPath}"/>
    </javaresource>
</import>
<import>
    <javaresource name="scripts/smpe/imports/$scmcmd.xml">
        <classpath location="${jarPath}"/>
    </javaresource>
</import>

    

Note:

• ScmAccept
  The ScmAccept macro is used to accept changes into a repository workspace.
• ScmAddComponent
  The ScmAddComponent macro is used to add components to a workspace or stream.
• ScmAddFlowtarget
  The ScmAddFlowtarget macro is used to add flow targets to a workspace or stream.
• ScmAddWorkitem
  The ScmAddWorkitem macro is used to associate a change set with a work item.
• ScmCheckin
  The ScmCheckin macro is used to check changes into the current workspace.
• ScmCheckinComment
  The ScmCheckinComment macro is used to check changes into the current workspace while adding a comment to the change set.
• ScmCreateBaseline
  The ScmCreateBaseline macro is used to create a new baseline for components.
• ScmCreateChangeset
  The ScmCreateChangeset macro is used to create a change set.
• ScmCreateComponent
  The ScmCreateComponent macro is used to create a component in the specified workspace or stream.
• ScmCreateSnapshot
  The ScmCreateSnapshot macro is used to create a snapshot that is associated with a workspace or stream.
• ScmCreateStream
  The ScmCreateStream macro is used to create a stream in the repository.
• ScmCreateWorkspace
  The ScmCreateWorkspace macro is used to create a repository workspace.
• ScmDeliver
  The ScmDeliver macro is used to deliver changes from a source workspace or stream to a target workspace or stream.
• ScmDiscard
  The ScmDiscard macro is used to discard change sets.
• ScmGetBaseline
  The ScmGetBaseline macro is used to get the attributes for a baseline.
• ScmGetComponent
  The ScmGetComponent macro is used to get the attributes for a component.
• ScmGetSnapshot
  The ScmGetSnapshot macro is used to get the attributes for a snapshot.
• ScmGetWorkspace
  The ScmGetWorkspace macro is used to get the attributes for a workspace.
• ScmListBaselines
  The ScmListBaselines macro is used to to list baselines.
• ScmListChangesets
  The ScmListChangesets macro is used to list the change sets that are in the repository.
• ScmListComponents
  The ScmListComponents macro is used to list components.
• ScmListFlowtargets
  The ScmListFlowtargets macro is used to list flow targets of the workspace or stream.
• ScmListSnapshots
  The ScmListSnapshots macro is used to list the snapshots that are associated with a workspace or stream.
• ScmListStreams
  The ScmListStreams macro is used to list streams that are available in the repository.
• ScmListWorkspaces
  The ScmListWorkspaces macro is used to list repository workspaces that are in the repository.
• ScmLoad
  The ScmLoad macro is used to load the contents of the specified workspace into the local file system.
• ScmLogin
  The ScmLogin macro is used to store the credentials to use when logging onto a repository.
• ScmLogout
  The ScmLogout macro is used to delete the stored credentials for the given repository.
• ScmProperties
  The ScmProperties macro is used to set properties and metadata used by the SCM command macros.
• ScmRemoveComponent
  The ScmRemoveComponent macro is used to remove components from a workspace.
• ScmRemoveFlowtarget
  The ScmRemoveFlowtarget macro is used to remove flow targets from a workspace or stream.
• ScmRemoveWorkitem
  The ScmRemoveWorkitem macro is used to remove a link between a work item and a change set.
• ScmReplaceComponents
  The ScmReplaceComponents macro is used to to replace components in a workspace.
• ScmResume
  The ScmResume macro is used to resume change sets into a workspace from the stored suspended set that is on the server.
• ScmSetBaseline
  The ScmSetBaseline macro is used to set the attributes for a baseline.
• ScmSetChangesetComment
  The ScmSetChangesetComment macro is used to set the change set comment text.
• ScmSetChangesetComplete
  The ScmSetChangesetComplete macro is used to set the change set complete.
• ScmSetChangesetCurrent
  The ScmSetChangesetCurrent macro is used to set the change set current.
• ScmSetComponent
  The ScmSetComponent macro is used to set the attributes for a component.
• ScmSetFlowtarget
  The ScmSetFlowtarget macro is used to set flow targets for a workspace or stream.
• ScmSetFlowtargetComponent
  The ScmSetFlowtargetComponent macro is used to set flow targets for component in a workspace or stream.
• ScmSetSnapshot
  The ScmSetSnapshot macro is used to set the attributes for a snapshot.
• ScmSetWorkspace
  The ScmSetWorkspace macro is used to set the attributes for a workspace.
• ScmShowStatus
  The ScmShowStatus macro is used to show pending changes.
• ScmSuspend
  The ScmSuspend macro is used to suspend change sets from a workspace.
• ScmUndo
  The ScmUndo macro is used to reverse changes to files.
• ScmUnload
  The ScmUnload macro is used to unload the workspace, component, or root paths.