Set up the extaccess record

In the default Service Manager system, Request Management tables are not published as a Web Service.

Note Enter all fields that need to be exposed, and then create field captions for those fields. The field captions cannot be XML-reserved characters and cannot contain spaces. Use of mixed case is supported.

To create a new Web Service, do the following:

  1. Log in to Service Manageras a System Administrator.
  2. Click Tailoring > Web Services > Web Service Configuration.
  3. To publish Request Management Quotes, create a new record with the following information:

  4. Field Value
    Service Name

    RequestManagement

    Note Type the name of the web service that you want to use to publish this table may be comprised of multiple Service Manager tables. The name you type in this field becomes the alias name for the service and it becomes part of the web service URL. For example, when you type RequestManagement as the service name, then the WSDL you publish will be called RequestManagement.wsdl. The name cannot contain URL-reserved characters, such as spaces, slashes, or colons.

    Name ocmq
    Object Name

    Quote

    Note Type the name you want to use to identify the table. This name becomes the alias name for the table, and then becomes part of the web service WSDL. For example, when you type Quote as the object name, then the SOAP operations for this table include Quote as part of the WSDL element, such as UpdateQuote, CreateQuote, and DeleteQuote.

    The name cannot consist of XML-reserved characters, such as brackets (< and >), colons (:), or quotation marks (" and '). Never use "CamelCase" (mixed case) notation in the Object name, as this creates an incorrect or missing filename when calling the web service via Service Manager. As a workaround, you can use a tool that lets you modify the XML to include the filename in the SOAP body request. However, Service Manager and some other tools do not allow modifications.

    Allowed Actions

    The Allowed Actions have to match the action field in the Display Option, and in the display action field in the State record. Only options that have a true condition will be available through the web service interface. Operator privileges will be checked to ensure security.

    1st entry save
    2nd entry GenNewHire
    Action Names Type the name you want to use in the Web Services application program interface (API) to identify the Document Engine display actions for this table. The name you type for this field becomes the alias name for the display action, and then becomes part of the web service WSDL. The only action that can be used to add a record to a Service Manager table is Create. Updating actions can be named to fit the action. Foe example, if you type Create for the add action of the Quote object, then the WSDL operation becomes CreateQuote and the WSDL message is CreateQuoteRequest. The name cannot consisit of XML-reserved characters, such as brackets(< and >), colons (:), or quotation marks (" and ').
    1st entry Update
    2nd entry Create

    Action Type

     

    1st entry

    Merge

    2nd entry Create only
    Expressions tab if null(number in $L.file) then ($L.mode="add")
  5. On the Fields tab, type the following:

    Field Caption Type

    priority

    Priority

    StringType

    requested.for

    Requestor

    StringType
    requestor.dept RequestingDepartment StringType
    reason Reason StringType
    location Location StringType
    hire.type HireType StringType
    requested.date StartDate DateTimeType
    requestor.fname NewEmployeeFirstName StringType
    requestor.lname NewEmployeeLastName StringType
    category Category StringType
    current.phase Phase StringType
    number Number StringType
  6. If you want to use RESTful API, on the RESTful tab, type the following:

    Field Value

    RESTful Enabled

    Checked

    Attachment Enabled

    Checked if you want to use attachment later.

    Resource Collection Name quotes
    Resource Name Quote
    Unique Keys number
    Max Records Returned in Query 1000
    Query Authorization true
    Resource Collection Actions: POST Create
    Resource Actions:POST Update
    Resource Actions: PUT Update

When your Web service is set up, it is ready to be consumed by a custom client. Windows and Web clients are unaffected by changes you make to the extaccess table. The operator's application profile is used to determine which tables the user can access, and which actions the user can perform.