Defining Business Services

Use this page to define basic information about a Business Service.

You can access the portal from the Admin Menu > System > Business Service. You are brought to a query portal with options for searching for a specific business service. Once a business service has been selected you are brought to the maintenance portal to view and maintain the selected record.

CAUTION: Important! If you introduce a new business service, carefully consider its naming convention. Refer to System Data Naming Convention for more information.

The following zones may appear as part of the portal's Main tab page.

  • Business Service. This zone provides information about the selected business service.
  • Schema Editor. This zone describes the business service's schema and supports basic edits in plain text. Refer to the Schema tab below for additional schema editor information.

The following zones may appear as part of the portal's Schema tab page.

  • Schema Editor. This zone allows you to edit the business service's schema using the Schema Designer tool. The purpose of the schema is to describe the business service's properties and map them to the underlying internal service fields.
    Fastpath: Refer to Schema Syntax and UI Hint syntax for a complete list of the XML nodes and attributes available to you when you construct a schema.
    Tip: Click the View Schema hyperlink to view the business service's expanded schema definition. Doing this opens the schema viewer window.

The following zones may appear as part of the portal's References tab page.

  • Business Service References. This zone list various configuration entities referencing the current business service or its schema.

Actions

The page supports the following special actions:

  • View Schema. Click the hyperlink to view the business service's expanded schema definition. Doing this opens the schema viewer window.
  • Test. Use this action to test your business service. Enter input values and save. The service is performed and output information is presented. If the service issues an error the corresponding message is displayed. Note that the input and output testing user interface is dyamically rendered based on UIHints embedded in the business service's schema. As such, the user interface may be as elaborate or basic as the UIhints in that schema.
    Note: This action is secured by a designated "Test a Service" application service and requires also security rights for creating a script, which is the alternative way for testing any service. It is recommended to allow access to this function in non-production environments only.

Related Topics:

Parent Topic: Business Services