Policy Server Guides › Policy Server Administration Guide › Policy Server Tools › XPSExplorer

XPSExplorer

XPSExplorer is an interactive command-line utility that allows an administrator or application developer to view the data in a policy store. XPSExplorer has two uses:

• To determine the identifiers of objects for a granular export or import by exploring a list of domains or realms
• To repair the object store in the event that the store is damaged and must be repaired manually. This action should be performed only under the guidance of CA support.

To use XPSExplorer, you must be an administrator with XPSExplorer rights.

Syntax

XPSExplorer has the following format:

XPSExplorer [-?] [-vT | -vI | -vW | -vE | -vF]
[-l log_path] [-e err_path] [-r rec_path]

Parameters

XPSExplorer includes the following options:

-?

(Optional) Displays help information for this utility.

-vT | -vI | -vW | -vE | -vF

(Optional) Specifies when to log error information to the error file and how much information to log.

-vT

Logs detailed information so that you can TRACE errors.

-vI

Logs information in case there is an error.

-vW

Logs error information in the event of a WARNING, ERROR, or FATAL error.

-vE

Logs error information in the event of an ERROR or FATAL error.

-vF

Logs error information in the event of a FATAL error.

-l

(Optional) Outputs logging information to the specified location.

Default: stdout

-e

(Optional) Outputs error information to the specified location.

Default: stderr

-r

(Optional) Outputs a record of the session to the specified location.

Export a Subset of Policy Store Data

To export a subset of policy store data, you need the identifiers of the objects (XIDs) that you want to export. You can use XPSExplorer to locate object identifiers. To use XPSExplorer, you must be an administrator with XPSExplorer rights.

In this use case, you export the following accounting applications:

• Accounts Payable
• Accounts Receivable
• General Ledger
• Payroll

Export a subset of policy store data

1. Open a command prompt on the machine hosting the Policy Server.
2. Enter the following command:

   XPSExplorer
   

   The main menu opens and lists vendors, products, and classes.

   Note: Only objects in top-level classes can be exported. Top-level classes are marked with asterisks.

3. Enter the number corresponding to the class of objects that you want to export.

   The Class Menu opens.

   Example: If the number 15 corresponds to accounting, enter 15.

4. Enter S to view the objects in the class.

   The Search Menu opens and the objects in the class are listed.

   Example Search Results:

   1-CA.SM::Accounting@0e-08c6cadb-e30b-4e06-9e2e-b3d7a866fab8

   (I) Name : "Accounts Payable"

   (C) Desc : "accounts payable"

   2-CA.SM::Accounting@0e-3b0f4ccf-71f3-4968-b095-2b5a830c3244

   (I) Name : "Accounts Receivable"

   (C) Desc : "accounts receivable"

   3-CA.SM::Accounting@03-1c7ac22e-6646-4c61-8f2f-6261a0ef3a92

   (I) Name : "General Ledger"

   (C) Desc : "general ledger"

   4-CA.SM::Accounting@10-8d78bb81-ae15-11d1-9cdd-006008aac24b

   (I) Name : "Payroll"

   (C) Desc : "payroll"

   5-CA.SM::Accounting@@12-88f119a0-3fd1-46d0-b8ac-c1e83f00f97d

   (I) Name : "Job Costing"

   (C) Desc : "job costing"

   Example Object Identifiers (XIDs):

   CA.SM::Accounting@0e-08c6cadb-e30b-4e06-9e2e-b3d7a866fab8

   CA.SM::Accounting@0e-3b0f4ccf-71f3-4968-b095-2b5a830c3244

   CA.SM::Accounting@03-1c7ac22e-6646-4c61-8f2f-6261a0ef3a92

   CA.SM::Accounting@10-8d78bb81-ae15-11d1-9cdd-006008aac24b

   CA.SM::Accounting@@12-88f119a0-3fd1-46d0-b8ac-c1e83f00f97d

5. Enter Q three times to exit the Search, Class, and Main Menus and return to the command prompt.
6. Enter the following command at the command prompt:

   XPSExport output_file -xo object_XID_1 -xo object_XID_2
   -xo object_XID_3 -xo object_XID_4
   

   output_file

   Specifies the XML file to which the policy store data is exported.

   -xo object_XID

   Specifies the identifier of each object that you want to export.

   Note: You can copy the object identifiers (XIDs) from the Search results and paste them in the command line.

   Example:

   XPSExport accounting.xml
   -xo CA.SM::Accounting@0e-08c6cadb-e30b-4e06-9e2e-b3d7a866fab8
   -xo CA.SM::Accounting@0e-3b0f4ccf-71f3-4968-b095-2b5a830c3244
   -xo CA.SM::Accounting@03-1c7ac22e-6646-4c61-8f2f-6261a0ef3a92
   -xo CA.SM::Accounting@10-8d78bb81-ae15-11d1-9cdd-006008aac24b
   

   The policy store data for the specified accounting applications is exported to accounting.xml.

More information:

XPSExport

XCart Management

XPSExplorer includes the XCart feature. XCart allows you to collect the identifiers of the objects (XIDs) that you want to export and save them to a file for later use without manually copying and pasting each one. To use XPSExplorer, you must be an administrator with XPSExplorer rights.

To access XCart, enter X for XCart Management in the Main Menu of XPSExplorer. The XCart Menu opens and displays any objects that are in the XCart. The following options are context-sensitive and may or may not be displayed depending on the context:

C - Clear cart.

Empties the XCart.

L - Load cart from file.

• Initial load - Loads the XCart with the contents of the specified file and remembers the specified file name as the XCart file.
• Subsequent loads - Adds the contents of the specified file to the XCart.

  Note: The name of the XCart file does not change.

S - Save cart to file: xcart_file

Saves the contents of the XCart to the XCart file.

Important! The S command overwrites the contents of the XCart file without prompting first.

N - Save cart to new file.

Saves the contents of the XCart to the specified file and remembers the specified file name as the XCart file.

Note: The N Command prompts before overwriting the specified file.

Each object is tagged with an import mode that determines how it will be imported from the XPS file to the policy store:

A - Set import mode to ADD.

Adds new objects; does not replace existing objects.

O - Set import mode to OVERLAY.

Replaces existing objects; does not add new objects.

R - Set import mode to REPLACE.

Replaces existing objects and adds new objects.

D - Set import mode to default.

Specifies the default import mode.

Note: For each product class, there is a default import mode defined in the product's data dictionary.

Q - Quit

Exits the XCart Menu and returns to the Main Menu.

Export a Subset of Policy Store Data Using XCart

To export a subset of policy store data, you need the identifiers of the objects (XIDs) that you want to export. You can use the XCart feature of XPSExplorer to locate objects and save them in an XCart file for later use when you export. For example, an administrator can set up an XCart file for members of operations to use as needed. To use XPSExplorer, you must be an administrator with XPSExplorer rights.

In this use case, you save the following four accounting applications in a file for later use:

• Accounts Payable
• Accounts Receivable
• General Ledger
• Payroll

Export a subset of policy store data using XCart

1. Open a command prompt on the machine hosting the Policy Server.
2. Enter the following command:

   XPSExplorer
   

   The Main Menu opens and lists vendors, products, and classes.

   Note: Only objects in top-level classes can be exported. Top-level classes are marked with asterisks.

3. Enter X for XCart Management.

   The XCart Menu opens.

4. Create a text file.

   Example: C:\xcart\accounting.txt

   Note: This is where you want the contents of the XCart to be saved.

5. Enter L for Load cart from file.
6. Enter the path and name of the text file you created.

   The specified file name is remembered as the XCart file.

   Example: C:\xcart\accounting.txt

   Note: The file must exist. If not, L has no effect.

7. Enter Q to return to the Main Menu.
8. Enter the number corresponding to the class that you want to export.

   The Class Menu opens.

   Example: If the number 15 corresponds to Accounting, enter 15.

9. Enter S to view the objects in the class.

   The Search Menu opens and the objects in the class are listed.

   Example Search Results:

   1-CA.SM::Accounting@0e-08c6cadb-e30b-4e06-9e2e-b3d7a866fab8

   (I) Name : "Accounts Payable"

   (C) Desc : "accounts payable"

   2-CA.SM::Accounting@0e-3b0f4ccf-71f3-4968-b095-2b5a830c3244

   (I) Name : "Accounts Receivable"

   (C) Desc : "accounts receivable"

   3-CA.SM::Accounting@03-1c7ac22e-6646-4c61-8f2f-6261a0ef3a92

   (I) Name : "General Ledger"

   (C) Desc : "general ledger"

   4-CA.SM::Accounting@10-8d78bb81-ae15-11d1-9cdd-006008aac24b

   (I) Name : "Payroll"

   (C) Desc : "payroll"

   5-CA.SM::Accounting@@12-88f119a0-3fd1-46d0-b8ac-c1e83f00f97d

   (I) Name : "Job Costing"

   (C) Desc : "job costing"

10. For Accounting applications one through four:
    1. Enter the number corresponding to the application.
    2. Enter X for Add to XCart.
    3. Enter Q to exit the XCart Menu and return to the Search Menu.

       Note: An asterisk before an application indicates that it is in the XCart.

11. Enter Q twice to exit the Search and Class Menus and return to the Main Menu.
12. Enter X for XCart Management.
13. Enter S to Save the cart to the XCart file: C:\xcart\accounting.txt.
14. Enter Q twice to exit the XCart and Main Menus and return to the command prompt.
15. Enter the following command at the command prompt:

    XPSExport output_file -xf xcart_file
    

    output_file

    Specifies the XML file to which the policy store data is exported.

    -xf xcart_file

    Specifies the path and name of the XCart file containing the identifiers of the objects (XIDs) to export.

    Example:

    XPSExport accounting.xml C:\xcart\accounting.txt
    

    The policy store data for the accounting applications saved in the XCart file is exported to accounting.xml.

Add an Application to an XCart File

In this use case, you add a fifth accounting application, Job Costing, to the following four accounting applications already in the XCart file, accounting.txt, using the XCart feature of XPSExplorer:

• Accounts Payable
• Accounts Receivable
• General Ledger
• Payroll

Note: To use XPSExplorer, you must be an administrator with XPSExplorer rights.

Add an application to an XCart file

1. Open a command prompt on the machine hosting the Policy Server.
2. Enter the following command:

   XPSExplorer
   

   The Main Menu opens and lists vendors, products, and classes.

   Note: Only objects in top-level classes can be exported. Top-level classes are marked with asterisks.

3. Enter X for XCart Management.

   The XCart Menu opens.

4. Enter L for Load cart from file.
5. Enter the path and name of the existing text file containing the four accounting applications.

   The specified file name is remembered as the XCart file.

   Example: C:\xcart\accounting.txt

6. Enter Q to return to the Main Menu.
7. Enter the number corresponding to the class that you want added to the XCart file.

   The Class Menu opens.

   Example: If the number 15 corresponds to accounting, enter 15.

8. Enter S to view the objects in the class.

   The Search Menu opens and the objects in the class are listed.

   Example Search Results:

   1-CA.SM::Accounting@0e-08c6cadb-e30b-4e06-9e2e-b3d7a866fab8

   (I) Name : "Accounts Payable"

   (C) Desc : "accounts payable"

   2-CA.SM::Accounting@0e-3b0f4ccf-71f3-4968-b095-2b5a830c3244

   (I) Name : "Accounts Receivable"

   (C) Desc : "accounts receivable"

   3-CA.SM::Accounting@03-1c7ac22e-6646-4c61-8f2f-6261a0ef3a92

   (I) Name : "General Ledger"

   (C) Desc : "general ledger"

   4-CA.SM::Accounting@10-8d78bb81-ae15-11d1-9cdd-006008aac24b

   (I) Name : "Payroll"

   (C) Desc : "payroll"

   5-CA.SM::Accounting@@12-88f119a0-3fd1-46d0-b8ac-c1e83f00f97d

   (I) Name : "Job Costing"

   (C) Desc : "job costing"

   Note: An asterisk before an application indicates that it is in the XCart.

9. To add Job Costing to the XCart file:
   1. Enter 5 for the Job Costing application.
   2. Enter X for Add to XCart.
   3. Enter Q to exit the XCart menu and return to the Search Menu.

      The asterisk before the application indicates that it is in the XCart.

   4. Enter Q twice to exit the Search and Class Menus and return to the Main Menu.
   5. Enter X for XCart Management.
   6. Enter S to Save the XCart to the XCart file: C:\xcart\accounting.txt.

      Job Costing is added to accounting.txt.

10. Enter Q twice to exit the XCart and Main Menus and return to the command prompt.