CA API Gateway 9.1

9.4 9.1

Import a Global Resource

You can import resources and dependencies into the Manage Global Resources table using the import wizard. You can add resources individually or in bulk.
gateway91
You can import resources and dependencies into the Manage Global Resources table using the import wizard. You can add resources individually or in bulk.
To import a global resource
:
  1. In the Policy Manager, select
    [Tasks] > Global Settings > Manage Global Resources
     from the Main Menu. The Manage Global Resources dialog appears.
  2. Click [
    Import
    ]. The Resource Import Wizard appears.
  3. Complete the wizard as described below:
Wizard Step
Description
Step 1: Select Resources
In this step, specify the resources to import. You can either add them directly from a URL or file, or search within a specified directory.
To add a resource directly, do either of the following:
  • Click [
    Add from URL
    ] and enter the URL.
    To configure options for the URL (for example, to specify the credentials, SSL, or proxy options), click [HTTP Options] to open the Manage HTTP Options dialog.
  • Click [
    Add from File
    ] and browse to the file containing the resource to add.
To remove resources from the list, do either of the following:
  • Select a resource to remove and then click [
    Remove
    ]. The resource is removed from the list.
  • Click [
    Clear
    ]. This removes all the resources from the list.
To add resources by searching within a directory
:
  1. Enter the path in the Directory field or click [
    Select
    ] to browse for the directory.
  2. Select [
    Include subdirectories
    ] to include the subdirectories of the specified directory in the search. Otherwise, only the specified directory itself is searched.
  3. Optionally specify a Pattern to match. If you do not specify a pattern, all files with the following extensions are located: *.xsd or *.dtd.
  4. Select the Type of resource to match using the drop-down list: XML Schema or DTD.
  5. Click [
    Find
    ]. The matching resources are added to the "Resources to Import" table.
  6.  Review the resources in the "Resources to Import" table carefully to ensure that the correct resources have been identified. To make corrections:
  • Use either of the [
    Add...
    ] buttons to manually specify the resource to import. (See "To add a resource directly" from above.)
  • Use [
    Remove
    ] to remove a single resource from the list.
  • Use [
    Clear
    ] to clear all files from the list to start over again.
Step 2: Import Options
In this step, indicate how the wizard should respond to any of the following issues during resource importing:
  • If a resource dependency's target namespace matches multiple existing XML Schemas:
    • Ask
      : Allows you to choose a resolution each time this issue occurs. This setting is the default.
    • Manually select an existing XML Schema: Lets you select an existing XML Schema to use; does not import the XML Schema belonging to the dependency.
    • Import the XML Schema: Always import the XML Schema associated with the dependency. This will create a new resource with the same target namespace.
    • Don't import the XML Schema: Don't import the dependency or any resources that depend on it. This represents a failure case as the main schema will not be imported.
  •  
    If a resource dependency's public identifier matches multiple existing resources:
    • Ask
      : Allows you to choose a resolution each time this issue occurs. This setting is the default.
    • Manually select an existing resource: Lets you select the existing resource to use for the dependency.
    • Import the duplicate resource: Always import the resource associated with the dependency. This will create a new resource with the same target namespace.
    • Don't import the duplicate resource: Don't import the dependency or any resources that depend on it.
  • If an imported resource's system identifier conflicts with an existing system identifier:
    • Ask
      : Allows you to choose a resolution each time this issue occurs. This setting is the default.
    • Use the existing resource: The existing resource is used; a new resource is not created for this dependency.
    • Update the existing resource: Replace the existing system identifier with the one from the imported resource
    • Don't import the conflicting resource: Exclude the conflicting resource from the import. Resources that depend on the resource will not be imported. This is a failure case for the import.
  • If an imported XML Schema's target namespace matches an existing value:
    • Ask
      : Allows you to choose a resolution each time this issue occurs. This setting is the default.
    • Use the existing XML Schema: Use the existing XML Schema; the contents of the imported dependency are ignored.
    • Update the existing XML Schema: Update the existing XML Schema with the import. This will preserve the current URI and use the content of the imported schema.
    • Replace the existing XML Schema: Replace the existing XML Schema with the one from the import. This will use the URI and content from the import. Any existing XML Schemas that reference the dependency should be updated to use the new URI.
    • Import the XML Schema: Import the incoming XML Schema as is. This will use the URI from the import. This will create a new resource.
    • Don't import the matching resource: Exclude the resource with the matching target namespace from the import. Resources that depend on the resource will not be imported.
  • If an imported resource's public identifier duplicates an existing value:
    • Ask
      : Allows you to choose a resolution each time this issue occurs. This setting is the default.
    • Use the existing resource: Use the existing resource; the contents of the imported dependency are ignored.
    • Update the existing resource: Update the resource with the contents from the import. This will preserve the current URI.
    • Replace the existing resource: Replace the existing resource with the one from the import. This will use the URI and content from the import. Any existing resources that reference the dependency should be updated to use the new URI.
    • Import the duplicate resource: Always import the resource, using the import URI. This will result in duplicate resources.
    • Don't import the duplicate resource: Exclude the duplicate resource from the import. Resources that depend on the resource will not be imported.
  •  
    If a resource dependency cannot be found, or is invalid:
    • Ask
      : Allows you to choose a resolution each time this issue occurs. This setting is the default.
    • Manually resolve or fix the dependency: Displays a dialog that lets you manually resolve or update the dependency.
    • Don't import the invalid resource: Exclude the invalid resource from the import. Also exclude all other resources that depend on this resource.
Step 2: Import Options (cont'd)
(manually responding to issues)
When 'Ask' is specified in any of the settings, you will be prompted to respond to any issues that need attention.
Example 1:
The following dialog is displayed when there is a conflicting System ID:
Select a resolution from the drop-down list, then specify whether:
  • [
    This Time Only
    ]: Use the selected action only for this occurrence of the conflict. When another similar conflict occurs, you will be asked again how to resolve it.
  • [
    Always
    ]: Use the selected action for all the conflicts of this type. You will not be prompted for a resolution if another similar conflict occurs during this import. This is the same as configuring the choice in the wizard step.
Example 2:
The following dialog is displayed when a dependency of an imported resource is invalid:
Select a resolution from the drop-down list, as in the previous example. If you choose to manually resolve, you will be given a chance to fix the dependency in the following dialog:
Click [
Import
] to select the dependency from a URL or a file.
Step 3: Import Details
This step summarizes what actions will be taken when finishing the import. If any resource could not be created due to an error, the details will be shown here.
Import Summary
The table lists all the resources involved in the import:
  • System ID
    : The URI of the resource being imported.
  • Details
    : The target namespace (for XML Schemas) or the public identifier of the resource (for DTDs).
  • Type
    : Whether the resource is a XML Schema or DTD.
  • Status
    : The resource import status.
  • Action
    : What will be done with the resource:
  • Ignore
    : The resource will not be imported.
  • Update
    : The resource will update an existing global resource.
  • Create
    : A new global resource will be created for the resource.
  • [
    View
    ]: Use this to view the contents of a resource.
  • [
    Remove
    ]: Use this to remove a resource from the import list. Any resource that depends on this resource will also be removed.
  • [
    Update
    ]: Use this to update the system identifiers of any matching resources before importing, if this is possible. This will alter all resources being imported for consistency; it does not act on any resource that may be selected in the import list. Enter the current and updated System Identifier prefixes as prompted. Note: The updated system identifiers must be absolute URIs.
You cannot update system identifiers if:
  • The updated system identifier conflicts with an existing global resource.
  • The content of a resource must be updated due to the change and the dependency is not an XML Schema.
Resource Details
This section displays details about the currently selected resource:
  • System ID
    : The URI of the resource.
  • Description
    : A description of the resource.
  • Status
    : The resource import status.
  • Status Detail
    : A more verbose description explaining why the particular status was assigned.
  • Dependencies
    : Shows the dependencies for the resource. You can choose to Show all dependencies, Show only direct dependencies, or Show only transitive dependencies (these are shown in italicized text). Note: Transitive dependencies of existing resources are not displayed here.
    • Uses
      : The resource(s) that the selected resource uses.
    • Used by
      : The resource(s) in which the selected resource is used.
The [
Finish
] button is activated only when there are resources that can be imported. If it is not possible to import any resources, use the [
Back
] button to return to previous steps to make corrections, or click [
Cancel
] to exit the wizard and try again later.

Content feedback and comments