Platform SDK: Team Productivity Update

Instantiation URL: Configure URL and Deploy URL

An application can define its own factory if you pass it the value TAFT_FACTORY as the TeamAppFactory type parameter to TeamAppManager::RegisterAppFactory(). In this mode, instantiation can involve the following three URLs:

An application in Factory mode returns the following XML to the Team Productivity Update when the Instantiation URL is invoked:

<TeamAppFactory>
<Configure>Configure_URL</Configure >
<Deploy>Deploy_URL</Deploy>
<DropConfigure>DropConfigure_URL</DropConfigure>
<Result>
        <Code>0</Code>
        <Description>Application successfully installed</Description>
</Result>
</TeamAppFactory>

The Configure URL allows an application to ask questions of the requesting Team Workspace owner. It uses a modal dialog. Using a form, the Team Productivity Update passes to this URL the following arguments:

For detailed descriptions, see Instantiation URL Arguments. For sample XML code that defines roles for the Team Workspace, see Roles XML Reference.

The application communicates responses from the Configure URL to the Deploy URL. The application developer determines the mechanism for this communication. One approach might be to use a text file that the Instantiation URL could add to both the Configure URL and the Deploy URL. The ConfigSessionID itself might also serve as a file name. The Configure URL, like the Instantiation URL, should also return a <Result>.

The Deploy URL follows the same behavior as the Instantiation URL in the Deploy-Only case. In this case, however, the Instantiation URL script must have a mechanism for reading any data gathered by the Configure URL, such as reading the text file to which the Configure URL has written.

The DropConfigure URL is always launched using the HTTP POST method to clean up any configuration information saved by the Configure URL. These circumstances include:

  1. When the user decides not to deploy the application after the Configure URL is called but before the Deploy URL is called. This happens when a user clicks Cancel.
  2. When the administrator does not approve a request.
  3. After the application's Deploy URL is called.

The DropConfigure URL should return an appropriate <Result> tag.

The DropConfigure URL is not required. If it is not supplied, the Team Productivity Update calls no URL when the configuration is cancelled.