Issues for Mailing list of the Services Directory 1.0 (ServD) Finalization Task Force

To comment on any of these issues, send email to servd-ftf@omg.org. (Please include the issue number in the Subject: header, thusly: [Issue ###].) To submit a new issue, send email to issues@omg.org.

List of issues (green=resolved, yellow=pending Board vote, red=unresolved)

List options: All ; Open Issues only; or Closed Issues only

Issue 18654: Unable to identify location of RetrieveDetailsURL for pending changes
Issue 18662: Unable to identify location of RetrieveDetailsURL for newly added records
Issue 18663: Search Parameter objects for Provider and ServiceSite missing ID fields
Issue 18664: Availability objects CurrentLocalSystemTime is meaningless
Issue 18665: The PagesSearchResult is missing PageSize
Issue 18666: LastModificationDate on the SearchItem and Search Params
Issue 18667: Scope of ServD not clearly defined
Issue 18668: Component Capability Discovery. It is unclear why this sub-clause is present
Issue 18669: The context of the ELS in the Terms and Definitions is unclear
Issue 18670: Interaction Diagrams missing instance indicator ":"
Issue 18671: Profile Binding Diagram not in Model (EA file)
Issue 18672: Profile Binding ELS Note context unclear
Issue 18673: Scope of CTS2 implementation required
Issue 18674: Notation for String (collection) should be explained
Issue 18694: RecordRequiringApproval does not have RecordStatus
Issue 18700: ServiceSiteProvider Inconsistent Operation Naming/incorrect return parameters
Issue 18710: There is no RetrieveServiceSiteProvider operation
Issue 18711: The SearchInputParameters object does not have a CoverageArea property
Issue 18712: RegisterSearchEndpointForCoverageArea operation does not indicate if a reset is required
Issue 18713: GetReferenceListDetails cannot define which type of interface
Issue 18720: Site, ServiceSite, ServiceSiteProvider Parent Ids missing/not mandatory
Issue 18780: Vendor names in wsdls need to be removed

Issue 18654: Unable to identify location of RetrieveDetailsURL for pending changes (servd-ftf)

Click here for this issue's archive.
Source: Database Consultants Australia (Mr. Brian Postlethwaite, bpostlethwaite(at)data.com.au)
Nature: Clarification
Severity: Significant
Summary:
When retrieving the list of changes that are available the results do not indicate the location of a retrieve details service that can provide the complete object, and also missing is the "parent" object which can be used to locate the entity pending the change (specifically where there is no Retrieve method for the entity, such as an address or contact point, as they are in the context of a provider, or organization)

Resolution: The RecordRequiringApproval Data structure is to be extended to include 2 new properties, one for the RetrieveDetailsURL, and another for the Parent Records index. To make this change more apparent the diagram in section 8.2.6 on page 29 on the Reject Change Workflow is modified to separate the MaintainableServD Core into the 2 interfaces to show which interface is required to be called
Revised Text: for details see report dtc/2013-06-09 at http://www.omg.org/cgi-bin/doc?dtc/2013-06-09
Actions taken:
April 12, 2013: received issue

Issue 18662: Unable to identify location of RetrieveDetailsURL for newly added records (servd-ftf)

Click
here for this issue's archive.
Source: Database Consultants Australia (Mr. Brian Postlethwaite, bpostlethwaite(at)data.com.au)
Nature: Clarification
Severity: Significant
Summary:
When you add a new organisation (or other record) the return object does not contain the location of a retrieve details service that can provide the complete object as added.

Resolution: In order to satisfy this requirement the generic RecordResult object that is the base class for both the Update and Delete result is extended to include the URL. Brian: I believe this is on the correct object as the delete may require moderation and thus the object will still exist, and hence the retrieve details URL is valid.
Revised Text: for details see report dtc/2013-06-09 at http://www.omg.org/cgi-bin/doc?dtc/2013-06-09
Actions taken:
April 13, 2013: received issue

Issue 18663: Search Parameter objects for Provider and ServiceSite missing ID fields (servd-ftf)

Click
here for this issue's archive.
Source: Database Consultants Australia (Mr. Brian Postlethwaite, bpostlethwaite(at)data.com.au)
Nature: Clarification
Severity: Significant
Summary:
The Search Parameter Object ProviderSearchParameter is missing the Provider ID field to permit the direct locating of a specific record.
Also missing is the ServiceSiteID on the ServiceSiteSearchParameter object.
These fields are required to permit the location of a specific record to then be able to locate the appropriate RetrieveDetails URL to get the complete picture.
Issue is observed in the overview diagram on page 78 and also the object definitions on pages 83 and 87

Resolution: In order to be able to specify a search for an item exactly as requested the ProviderSearchParameter and ServiceSiteSearchParameter objects have add the appropriate Ids added to them, and the parameters diagram updated.
Revised Text: for details see report dtc/2013-06-09 at http://www.omg.org/cgi-bin/doc?dtc/2013-06-09
Actions taken:
April 13, 2013: received issue

Issue 18664: Availability objects CurrentLocalSystemTime is meaningless (servd-ftf)

Click
here for this issue's archive.
Source: Database Consultants Australia (Mr. Brian Postlethwaite, bpostlethwaite(at)data.com.au)
Nature: Clarification
Severity: Minor
Summary:
The Availability Object has a CurrentLocalSystemTime property which is not usefull for handling timezones.
The specification need to ensure that timezone information is correctly handled on the AvailableAt property. 

This could be handled by ensuring that all callers only interact with the ServD system using UTC, and all dates in the system are assumed to be UTC (or converted to UTC) for processing/storage/return values

Resolution: Remove the CurrentLocalSystemTime property from the Availability object as specified in Section 8.8.3 on Page 79. All the date-time properties must have the timezone specified and handled accordingly. The Directory must process all date-times in UTC, converting where required. The description for the AvailableAt property in this object is also unclear, need to reword it.
Revised Text: for details see report dtc/2013-06-09 at http://www.omg.org/cgi-bin/doc?dtc/2013-06-09
Actions taken:
April 14, 2013: received issue

Issue 18665: The PagesSearchResult is missing PageSize (servd-ftf)

Click
here for this issue's archive.
Source: Database Consultants Australia (Mr. Brian Postlethwaite, bpostlethwaite(at)data.com.au)
Nature: Enhancement
Severity: Significant
Summary:
If the Service decides that the requested page-size was not acceptable and uses a different page size to the one requested (I.e. the caller put in millions to try and "dump" the database, and service decides that it wants to only accept 100 as highest number) then the caller has no idea what the actual page size used was.
(Except maybe to see that there are more pages of data, and that the number of items is different to what was expected)

Resolution: The addition of a PageSize property on the PagesSearchResult object resovles this issue.
Revised Text: for details see report dtc/2013-06-09 at http://www.omg.org/cgi-bin/doc?dtc/2013-06-09
Actions taken:
April 14, 2013: received issue

Issue 18666: LastModificationDate on the SearchItem and Search Params (servd-ftf)

Click
here for this issue's archive.
Source: Database Consultants Australia (Mr. Brian Postlethwaite, bpostlethwaite(at)data.com.au)
Nature: Enhancement
Severity: Significant
Summary:
This would be very useful to be able to see if changes have been made and keep local address books up to date.
And then easy to see if changes need to be loaded further by calling the retrieve details which is a "heavier" call to the service for a more complete level of detailed information.

Resolution: Update the SearchItem object to contain a LastModifiedDate property. Update the SearchInputParameters object to contain a nullable property ModifiedAfterDate that if specified will only return objects where there are changes that have been made to the requested data after this date. Note: It was considered how to handle deleted entries in this respect. To cover this the record will be included in the search output with a status of deleted, and the LastModifiedDate is the date that the record was deleted, and the SearchItem will have the record status so that the context of the item is known.
Revised Text: for details see report dtc/2013-06-09 at http://www.omg.org/cgi-bin/doc?dtc/2013-06-09
Actions taken:
April 14, 2013: received issue

Discussion:


Issue 18667: Scope of ServD not clearly defined (servd-ftf)

Click
here for this issue's archive.
Source: Fujitsu (Mr. Tom Rutt, tom(at)coastin.com)
Nature: Clarification
Severity: Minor
Summary:
1. Scope - first sentence implies that ServD only supports location information. What about service characteristics?


Doesn't ServD support all information about the providers, organizations, sites and their services and relevant characteristics. Both for consumption by both People and computers.
Need to reword to be clearer.

Resolution: Reword the text to more clearly articulate the scope of the directory standard
Revised Text: Replace the first sentence of section 1 Scope with the following: “The Services Directory (ServD) specification provides an SOA model to support the discovery of, and access to, service provider individual, and organizational information including; locations, associations, contact details, services, identifiers and many other relevant characteristics/attributes. This information can be relevant for use by both people and/or computers.”
Actions taken:
April 15, 2013: received issue

Issue 18668: Component Capability Discovery. It is unclear why this sub-clause is present (servd-ftf)

Click
here for this issue's archive.
Source: Fujitsu (Mr. Tom Rutt, tom(at)coastin.com)
Nature: Clarification
Severity: Minor
Summary:
ELS does not seem to be included in any of the specified components. Why is this text not just included in Annex A? 
Also, i.e. ELS related to other web services and Open distributed processing interface directory functions, such as ODP/CORBA Trader and UDDI?

Resolution: The text was extended to better describe the context.
Revised Text: Insert the following text under the section 1.3 Component Capability Discovery heading: “Once an actor has found the Service, Provider, Site or Organization that they are seeking they then need to know what communicate methods are available. These can be either the simple details that they found during the search such as a phone, fax number, or website address. Where the actor is using an application that supports electronic communications the capabilities of the remote system’s connectivity options needs to be available, along with any additional information required to make the connection, such as public keys for PKI connections.” Insert the following text before the last sentence in section 1.3 Component Capability Discovery heading: “The ELS is similar in function to a UDDI service, except that the ELS is not restricted to Web Services, and can be used for secure email addressing, video conferencing addressing or many others.”
Actions taken:
April 15, 2013: received issue

Issue 18669: The context of the ELS in the Terms and Definitions is unclear (servd-ftf)

Click
here for this issue's archive.
Source: Fujitsu (Mr. Tom Rutt, tom(at)coastin.com)
Nature: Clarification
Severity: Minor
Summary:
4. Terms and Definitions. ELS is listed as a term. Is its function limited to computer interface service endpoints? 
Is ServD restricted to physical locations of services provided by people and organizations, or can ServD be used to find Endpoints for machine interfaces offering computerized services?

Resolution: Revise the text to more clearly describe the ELS functionality
Revised Text: In Section 4 Terms and Definitions append the following text to the meaning column for the ELS row: “These capabilities are not limited to SOAP based web services; the capability can also describe email, REST or other interface types. Note: The ServD interfaces are primarily used to locate an entity that you want to receive services with and basic human based connectivity information (such as phone/fax/website) for computer based interactions where appropriate addressing, security requirements and compatible standards are needed the ELS provides this extended information.”
Actions taken:
April 15, 2013: received issue

Issue 18670: Interaction Diagrams missing instance indicator ":" (servd-ftf)

Click
here for this issue's archive.
Source: Fujitsu (Mr. Tom Rutt, tom(at)coastin.com)
Nature: Clarification
Severity: Minor
Summary:
.2 Interaction diagrams. 
Each of these diagrams has an invoking component. It is unclear why this is not shown as a type, i.e. why is there not a ":" before the component name?
Also many of the interface lifelines do not have a ":" before the interface type in the lifeline header. 
The ":" prefix use appears to be inconsistent in its application throughout the Sequence Diagrams in 8.2.
8.2.1 Provider Search Sequence diagram. the locator lifeline should be labelled ":Locator" rather than "Locator".

Resolution: Update the diagrams to be consistent with the use of instance classifiers
Revised Text: for details see report dtc/2013-06-09 at http://www.omg.org/cgi-bin/doc?dtc/2013-06-09
Actions taken:
April 15, 2013: received issue

Issue 18671: Profile Binding Diagram not in Model (EA file) (servd-ftf)

Click
here for this issue's archive.
Source: Fujitsu (Mr. Tom Rutt, tom(at)coastin.com)
Nature: Clarification
Severity: Minor
Summary:
8.3 Profile binding. Are the class diagrams in this subclause included in the EA file? I cannot find them. Where is the source file for these diagrams?

Resolution: The EA model file has the profile binding diagram added into it. Also the Federation and Coverage areas diagram was not in the EA model file, now it is.
Revised Text: There is no change to the specification document itself
Actions taken:
April 15, 2013: received issue

Issue 18672: Profile Binding ELS Note context unclear (servd-ftf)

Click
here for this issue's archive.
Source: Fujitsu (Mr. Tom Rutt, tom(at)coastin.com)
Nature: Clarification
Severity: Minor
Summary:
8.3 Profile binding. It is unclear why the note regarding ELS under the first diagram is required. ELS does not appear in the figure.

Resolution: The ELS is an optional component of the Federation and has its own profile, outside of the ServD Federation
Revised Text: for details see report dtc/2013-06-09 at http://www.omg.org/cgi-bin/doc?dtc/2013-06-09
Actions taken:
April 15, 2013: received issue

Issue 18673: Scope of CTS2 implementation required (servd-ftf)

Click
here for this issue's archive.
Source: Fujitsu (Mr. Tom Rutt, tom(at)coastin.com)
Nature: Clarification
Severity: Minor
Summary:
8.4.1 ServD Locator configuration. States "All of the required TCS2 reference lists must be configured. Is use of CTS2 required for conformance to this specification, and if so, How much of CTS2 is required.

Resolution: Additional text is added to better define what components of CTS2 are required.
Revised Text: Append the following text to the Description cell for the CTS2 Reference Lists row in section 8.4.1 ServD Locator: “This is the URL for the CTS2 valueset interface. Note: The use of this standard provides facilities for mapping values if required, but is not mandated by this specification. ServD requires this interface (valueset) to be able to retrieve descriptions for the code values which are stored in the ServD data-store
Actions taken:
April 15, 2013: received issue

Issue 18674: Notation for String (collection) should be explained (servd-ftf)

Click
here for this issue's archive.
Source: Fujitsu (Mr. Tom Rutt, tom(at)coastin.com)
Nature: Clarification
Severity: Minor
Summary:
8.5.2.1 Method LocateSearchEndpointsForCoverageArea. Return value specified as "String (collection)", It should be explained that this is a convention to show a Return Result which is an array.
8.5.2.2 Method GetReferenceListDetails. The signature has a return value of ReferenceListDetail (collection). Is this supposed to be multi-valued (i.e, array). This notation should be explained somewhere. It shows with a [] in the UML diagram in section 8.5.1

Resolution: The convention used to explain this was included and diagrams updated to be more clear with respect to cardinality and associations.
Revised Text: for details see report dtc/2013-06-09 at http://www.omg.org/cgi-bin/doc?dtc/2013-06-09
Actions taken:
April 15, 2013: received issue

Issue 18694: RecordRequiringApproval does not have RecordStatus (servd-ftf)

Click
here for this issue's archive.
Source: Database Consultants Australia (Mr. Brian Postlethwaite, bpostlethwaite(at)data.com.au)
Nature: Enhancement
Severity: Significant
Summary:
You cannot tell the status of a record that requires approval apart from in the description or summary fields, hence a caller is not able to elegantly present the information to a user for actioning

Resolution: The RecordRequiringApproval entity was extended to have the Record Status Property
Revised Text: for details see report dtc/2013-06-09 at http://www.omg.org/cgi-bin/doc?dtc/2013-06-09
Actions taken:
May 2, 2013: received issue

Issue 18700: ServiceSiteProvider Inconsistent Operation Naming/incorrect return parameters (servd-ftf)

Click
here for this issue's archive.
Source: Database Consultants Australia (Mr. Brian Postlethwaite, bpostlethwaite(at)data.com.au)
Nature: Clarification
Severity: Minor
Summary:
The ServiceSiteProvider Maintenance functions for Add and Update do not return an array of results where they should, and they the name is not in the same format as for all other operations.


Should be renamed to:
ServiceSiteProviderAdd
and
ServiceSiteProviderUpdate

(existing implementations could continue with the old name and return parameters for compatibility)

Resolution: Make the function name and return parameter changes as recommended.
Revised Text: In Section 8.5.6.13: • Rename the method from “AddServiceSiteProvider” to “ServiceSiteProviderAdd” • Change the Return value from “UpdateRecordResult” to “UpdateRecordResult (collection)” In Section 8.5.6.14: • Rename the method from “UpdateServiceSiteProvider” to “ServiceSiteProviderUpdate” • Change the Return value from “UpdateRecordResult” to “UpdateRecordResult (collection)” Make changes to the Maintainable-ServDCore.wsdl @@ -17,6 +17,7 @@ <xs:sequence> <xs:element minOccurs="0" name="AddressSearchParameters" nillable="true" type="tns:AddressSearchParameters"/> <xs:element minOccurs="0" name="Availability" nillable="true" type="tns:ArrayOfAvailability"/> + <xs:element minOccurs="0" name="CoverageAreaCodes" nillable="true" type="q1:ArrayOfstring" xmlns:q1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/> <xs:element minOccurs="0" name="ModifiedAfterDate" nillable="true" type="xs:dateTime"/> <xs:element minOccurs="0" name="OrganizationSearchParameters" nillable="true" type="tns:ArrayOfOrganizationSearchParameters"/> <xs:element minOccurs="0" name="ProviderSearchParameters" nillable="true" type="tns:ArrayOfProviderSearchParameters"/>
Actions taken:
May 8, 2013: received issue

Issue 18710: There is no RetrieveServiceSiteProvider operation (servd-ftf)

Click
here for this issue's archive.
Source: Database Consultants Australia (Mr. Brian Postlethwaite, bpostlethwaite(at)data.com.au)
Nature: Enhancement
Severity: Significant
Summary:
To be more consistent with the other RetrieveDetails and Maintenance interfaces there should be a routine that directly reads the ServiceSiteProvider record from its ID.
This enables callers to verify the status of a link in a more direct way.

Resolution: Include the RetreiveServiceSiteProvider Operation
Revised Text: for details see report dtc/2013-06-09 at http://www.omg.org/cgi-bin/doc?dtc/2013-06-09
Actions taken:
May 14, 2013: received issue

Issue 18711: The SearchInputParameters object does not have a CoverageArea property (servd-ftf)

Click
here for this issue's archive.
Source: Database Consultants Australia (Mr. Brian Postlethwaite, bpostlethwaite(at)data.com.au)
Nature: Enhancement
Severity: Significant
Summary:
Without the CoverageArea property being in the search parameters the federated search is not possible as shown in the diagram in section 8.2.2 Provider Search (Federated).
The implementation does not have a coverage area to interrogate the federation as to which directories to issue the search to.

As this is the primary search field it should be in the main search parameter object: SearchInputParameters

Resolution: Include a new property “CoverageAreaCode” of type string on the SearchInputParameters as described.
Revised Text: for details see report dtc/2013-06-09 at http://www.omg.org/cgi-bin/doc?dtc/2013-06-09
Actions taken:
May 14, 2013: received issue

Issue 18712: RegisterSearchEndpointForCoverageArea operation does not indicate if a reset is required (servd-ftf)

Click
here for this issue's archive.
Source: Database Consultants Australia (Mr. Brian Postlethwaite, bpostlethwaite(at)data.com.au)
Nature: Enhancement
Severity: Significant
Summary:
When calling the RegisterSearchEndpointForCoverageArea operation there is no definition in the specification for what the implementation should do with any coverage areas not included in the call (delete them, or leave them alone).
The return code includes a summary of items added, updated, and deleted.
So the implication is that it should delete them, but it isn't defined.

Suggest that an additional parameter be added to make that decision explicit.

Resolution: Add the new parameter to the RegisterSearchEndpointForCoverageArea operation as described. This then provides the caller of the operation a way to indicate what behavior the Locator should have.
Revised Text: for details see report dtc/2013-06-09 at http://www.omg.org/cgi-bin/doc?dtc/2013-06-09
Actions taken:
May 14, 2013: received issue

Issue 18713: GetReferenceListDetails cannot define which type of interface (servd-ftf)

Click
here for this issue's archive.
Source: Database Consultants Australia (Mr. Brian Postlethwaite, bpostlethwaite(at)data.com.au)
Nature: Enhancement
Severity: Significant
Summary:
When calling the GetReferenceListDetails interface, there is no way to determine if the caller wants to know about REST or WSDL style interfaces.
This needs to be passed in as a parameter to the call.

probably of type ImplementationProfile from the CTS2 CoreService

Resolution: A new parameter is added to the GetReferenceListDetails operation to permit the caller to indicate what type of interface is desired, and some supportive text in the Locator Profile Binding (section 8.4.1) to describe how this is to used. It was decided to use a string instead of the enumeration from CTS2 as it will be more flexible to support other types of reference list implementations other than those provided by the current version of CTS2.
Revised Text: for details see report dtc/2013-06-09 at http://www.omg.org/cgi-bin/doc?dtc/2013-06-09
Actions taken:
May 14, 2013: received issue

Issue 18720: Site, ServiceSite, ServiceSiteProvider Parent Ids missing/not mandatory (servd-ftf)

Click
here for this issue's archive.
Source: Database Consultants Australia (Mr. Brian Postlethwaite, bpostlethwaite(at)data.com.au)
Nature: Enhancement
Severity: Significant
Summary:
The objects Site and ServiceSite do not have their parent’s ID included in the object structure. Hence when calling retrieve details the object does not have the information as to what Id it’s parent has (unless it already knew via the search call or previous history ­ it is not explicitly included).

The ServiceSiteProvider record’s ServiceSiteId field is not marked as mandatory and the ProviderId is marked as mandatory. This is inconsistent.

Resolution: Add the OrganizationId property to the Site record, add the SiteId property to the ServiceSite record. The ServiceSiteId field on the ServiceSiteProvider record will no longer be marked as mandatory to be consistent with the others. As a result of this change, the Id for the context of the Add is no redundant in the AddSite and AddServiceSite Maintenance Operations.
Revised Text: for details see report dtc/2013-06-09 at http://www.omg.org/cgi-bin/doc?dtc/2013-06-09
Actions taken:
May 16, 2013: received issue

Issue 18780: Vendor names in wsdls need to be removed (servd-ftf)

Click
here for this issue's archive.
Source: Unisys (Dr. Doug Tolbert, dtolbert408(at)gmail.com)
Nature: Clarification
Severity: Minor
Summary:
Machine readable documents dtc/13-05-06 thru dtc/13-05-09, inclusive, have XML namespace definitions containing vendor names.  Please remove them.

Resolution: The namespaces in question were from Microsoft and introduced as a result of the way in which the Visual Studio toolset creates the wsdl files for the following datatypes: string[] (an array of strings) This is output as an ArrayOfString type in the Microsoft namespace. This was changed to be a local datatype and not one from the Microsoft namespace (although it is exactly the same definition) enum where the numeric values assigned to the values were not sequential from 0 some Microsoft WSDL extensions were included to capture these values in the WSDL. All enumerated types were modified to remove the specific numeric values and therefore no longer have the Microsoft extensions required.
Revised Text: The “Value” column from each of the enumerated type’s tables were removed: 8.7.2 AttributeVerificationStatusEnum 8.7.3 ConditionalIndicatorEnum 8.7.8 RecordStatusEnum 8.7.9 RecordTypeEnum 8.7.10 RecordUpdateResultStatusEnum 8.7.13 SearchResultsStatusEnum 8.7.14 StringMatchTypeEnum Make changes to the Maintainable-ServDCore.wsdl, ServDVerifier.wsdl and ServDLocator.wsdl to remove the Microsoft references and schema that it imports. Update the namespace as indicated above, and also the enumerated types extended properties (the values)
Actions taken:
June 17, 2013: received issue