Open APIs

Hi There,

Can anyone please advise where to capture the "Questionaire data" and "Site Safety" details in TMF API , in our implementation there are yes/no questionaire.

We were thinking to use "AttachmentRefOrValue"  for capturing info , is that right place?

Questionnaire sample-

1. any issues faced in installation (Yes/no)
2. is site near secured area (yes/no)

Thanks in advance!

Regards

Ash

This would seem to be a correct usage, presumably the questionnaire will be a PDF, image scan, or word document, or similar?

Note the difference between ref and value - specifically for attachment:

• Ref means that the attachment details are created elsewhere as a persistent object and you just refer to it by foreign key (id)
• Value means that the attachment details are embedded within your API object and not created elsewhere

This is orthogonal to the location of the attachment contents (the PDF, word, image file), here you have mutually exclusive properties in the attachment details:

• content - is the actual content of the attachment, in Base64 encoding, embedded within the attachment details
• url - points to the content of the attachment in some document management system or content management system

Hope it is clear

Hi There,

Can anyone please advise where to capture the "Questionaire data" and "Site Safety" details in TMF API , in our implementation there are yes/no questionaire.

We were thinking to use "AttachmentRefOrValue"  for capturing info , is that right place?

Questionnaire sample-

1. any issues faced in installation (Yes/no)
2. is site near secured area (yes/no)

Thanks in advance!

Regards

Ash

This would seem to be a correct usage, presumably the questionnaire will be a PDF, image scan, or word document, or similar?

Note the difference between ref and value - specifically for attachment:

• Ref means that the attachment details are created elsewhere as a persistent object and you just refer to it by foreign key (id)
• Value means that the attachment details are embedded within your API object and not created elsewhere

This is orthogonal to the location of the attachment contents (the PDF, word, image file), here you have mutually exclusive properties in the attachment details:

• content - is the actual content of the attachment, in Base64 encoding, embedded within the attachment details
• url - points to the content of the attachment in some document management system or content management system

Hope it is clear

Hi There,

Can anyone please advise where to capture the "Questionaire data" and "Site Safety" details in TMF API , in our implementation there are yes/no questionaire.

We were thinking to use "AttachmentRefOrValue"  for capturing info , is that right place?

Questionnaire sample-

1. any issues faced in installation (Yes/no)
2. is site near secured area (yes/no)

Thanks in advance!

Regards

Ash

Hi Jonathan,

Thanks for the clarification earlier, i still have few doubts and I hope you can advice on this:

We have two type of data which we are trying to map in TMF646:

• Health and Safety skills used by SFS to select the right engineers to send to the site that requires them (some example below)
  
  

  Skill Name	Skill ID	Answer
  S1 - Ladders leaning	HS1	Yes/No
  S2 - Ladders vertical	HS2	Yes/No
  S3 - Steps	HS3	Yes/No
  S4 - Drills	HS4	Yes/No
  S5 - Angle Grinders	HS5	Yes/No

• Questionnaire - Closure questionnaire presented to engineer upon marking the job as complete/incomplete. Sent to upstream in milestone notification or Questionnaires answered by the Field engineer's on site while doing the installation work as below
  
  

  Question	Field name	answer format	answer options
  QC01	Target Time	Date & Time format	System Defaulted
  QC02	Task complete date & time	**/**/****	Date & Time Format
  QC03	Ring Ahead ?	Drop down	Yes
  QC05	Service tested?	Drop down	Yes
  			No
  QC06	Why service not tested ?	Free Text
  QC07	Closure Notes	free Text

We want to pass this data to the upstream system which are used by Order management personal to keep a track of the appointment in case any changes are needed and some of the data also help them in passing information to other teams like configuration .

Not sure if we can use "AttachmentRefOrValue" object for this data set as this are mostly name/value pair kind of data?

At the moment there is no right placeholders available in 646 API for questionaire data, what do you recommend here - shall we make a simple extension of name value pair in existing API or use some object.

We want to align as much as possible with TMF API Standard but nit having right placeholders is what we are stuck with?

It would be really great if you can advise on the right way forward. I dont know if TMF already have any plans to enhance the API , may be someone else have also encountered similar issues.

I'll wait for your response, thanks in advance!

This would seem to be a correct usage, presumably the questionnaire will be a PDF, image scan, or word document, or similar?

Note the difference between ref and value - specifically for attachment:

• Ref means that the attachment details are created elsewhere as a persistent object and you just refer to it by foreign key (id)
• Value means that the attachment details are embedded within your API object and not created elsewhere

This is orthogonal to the location of the attachment contents (the PDF, word, image file), here you have mutually exclusive properties in the attachment details:

• content - is the actual content of the attachment, in Base64 encoding, embedded within the attachment details
• url - points to the content of the attachment in some document management system or content management system

Hope it is clear

Hi There,

Can anyone please advise where to capture the "Questionaire data" and "Site Safety" details in TMF API , in our implementation there are yes/no questionaire.

We were thinking to use "AttachmentRefOrValue"  for capturing info , is that right place?

Questionnaire sample-

1. any issues faced in installation (Yes/no)
2. is site near secured area (yes/no)

Thanks in advance!

Regards

Ash

If you want to pass more structured data, as you show here, name-value pairs, one possibility would be to define the questionnaire as a collection of Characteristics. But we strongly recommend that Characteristics are not used in an unrestricted fashion - they should be backed by Characteristic Specifications.

Possibly other people might be able to give alternative recommendations?

Hope it helps

Hi Jonathan,

Thanks for the clarification earlier, i still have few doubts and I hope you can advice on this:

We have two type of data which we are trying to map in TMF646:

• Health and Safety skills used by SFS to select the right engineers to send to the site that requires them (some example below)
  
  

  Skill Name	Skill ID	Answer
  S1 - Ladders leaning	HS1	Yes/No
  S2 - Ladders vertical	HS2	Yes/No
  S3 - Steps	HS3	Yes/No
  S4 - Drills	HS4	Yes/No
  S5 - Angle Grinders	HS5	Yes/No

• Questionnaire - Closure questionnaire presented to engineer upon marking the job as complete/incomplete. Sent to upstream in milestone notification or Questionnaires answered by the Field engineer's on site while doing the installation work as below
  
  

  Question	Field name	answer format	answer options
  QC01	Target Time	Date & Time format	System Defaulted
  QC02	Task complete date & time	**/**/****	Date & Time Format
  QC03	Ring Ahead ?	Drop down	Yes
  QC05	Service tested?	Drop down	Yes
  			No
  QC06	Why service not tested ?	Free Text
  QC07	Closure Notes	free Text

We want to pass this data to the upstream system which are used by Order management personal to keep a track of the appointment in case any changes are needed and some of the data also help them in passing information to other teams like configuration .

Not sure if we can use "AttachmentRefOrValue" object for this data set as this are mostly name/value pair kind of data?

At the moment there is no right placeholders available in 646 API for questionaire data, what do you recommend here - shall we make a simple extension of name value pair in existing API or use some object.

We want to align as much as possible with TMF API Standard but nit having right placeholders is what we are stuck with?

It would be really great if you can advise on the right way forward. I dont know if TMF already have any plans to enhance the API , may be someone else have also encountered similar issues.

I'll wait for your response, thanks in advance!

This would seem to be a correct usage, presumably the questionnaire will be a PDF, image scan, or word document, or similar?

Note the difference between ref and value - specifically for attachment:

• Ref means that the attachment details are created elsewhere as a persistent object and you just refer to it by foreign key (id)
• Value means that the attachment details are embedded within your API object and not created elsewhere

This is orthogonal to the location of the attachment contents (the PDF, word, image file), here you have mutually exclusive properties in the attachment details:

• content - is the actual content of the attachment, in Base64 encoding, embedded within the attachment details
• url - points to the content of the attachment in some document management system or content management system

Hope it is clear

Hi There,

Can anyone please advise where to capture the "Questionaire data" and "Site Safety" details in TMF API , in our implementation there are yes/no questionaire.

We were thinking to use "AttachmentRefOrValue"  for capturing info , is that right place?

Questionnaire sample-

1. any issues faced in installation (Yes/no)
2. is site near secured area (yes/no)

Thanks in advance!

Regards

Ash

Hi,

as I am currently working on upgrading the TMF646 (Appointment) from version 4 to version 5, I would like to better understand the scenario and how you plan to use this API. From my understanding, you are talking about two use cases:

1. Arrange for a technician having the needed skills at a given place and find a time slot where he will be available.
   I think this should be done by POSTing a SearchTimeSlot that includes the requestedTimeSlot; what is not so obvious is how one can express the needed skills; I imagine that the relatedParty might point to a PartyRole that does not have an engagedParty attached, which expresses that we know that we need a "technician", but do not yet know which person will take that role. The PartyRole would then have to point to the needed skills (that would be an extension of PartyRole, I assume), and based on that information a person (Party/Individual) can be identified that has the required skills and is available at the requested time and location to work on the relatedEntity, and then the relatedParty on the SearchTimeSlot would be changed to point to the identified person, with role="technician".
   To enable this, you would either have to use PartyRole.characteristic as mentioned by Jonathan, or to extend PartyRole by Skill, similar to the Skill on Party.
2. When on site, the technician captures the described information and inserts it into some document, that you model as AttachmentRefOrValue.
   In version 4, AttachmentRefOrValue has only limited capabilities to carry concrete information, the captured information could be captured as attachmentType and maybe description (as far as I understand it is not necessary to interpret Attachment as a document, could be some piece of information only), or you store the data in some document that you store via the Document API and refer to by AttachmentRef. The Document (managed by TMF667) can either be some binary file like a PDF or similar, or you can use its characteristics to store the captured data. The document could also be specified by a DocumentSpecification, and that defines via CharactersticSpecification which characteristics exist in that type of document.

Does this make sense?

Do we have to modify/extend anything in the Attachment API when we create the Version 5?

If you want to pass more structured data, as you show here, name-value pairs, one possibility would be to define the questionnaire as a collection of Characteristics. But we strongly recommend that Characteristics are not used in an unrestricted fashion - they should be backed by Characteristic Specifications.

Possibly other people might be able to give alternative recommendations?

Hope it helps

Hi Jonathan,

Thanks for the clarification earlier, i still have few doubts and I hope you can advice on this:

We have two type of data which we are trying to map in TMF646:

• Health and Safety skills used by SFS to select the right engineers to send to the site that requires them (some example below)
  
  

  Skill Name	Skill ID	Answer
  S1 - Ladders leaning	HS1	Yes/No
  S2 - Ladders vertical	HS2	Yes/No
  S3 - Steps	HS3	Yes/No
  S4 - Drills	HS4	Yes/No
  S5 - Angle Grinders	HS5	Yes/No

• Questionnaire - Closure questionnaire presented to engineer upon marking the job as complete/incomplete. Sent to upstream in milestone notification or Questionnaires answered by the Field engineer's on site while doing the installation work as below
  
  

  Question	Field name	answer format	answer options
  QC01	Target Time	Date & Time format	System Defaulted
  QC02	Task complete date & time	**/**/****	Date & Time Format
  QC03	Ring Ahead ?	Drop down	Yes
  QC05	Service tested?	Drop down	Yes
  			No
  QC06	Why service not tested ?	Free Text
  QC07	Closure Notes	free Text

We want to pass this data to the upstream system which are used by Order management personal to keep a track of the appointment in case any changes are needed and some of the data also help them in passing information to other teams like configuration .

Not sure if we can use "AttachmentRefOrValue" object for this data set as this are mostly name/value pair kind of data?

At the moment there is no right placeholders available in 646 API for questionaire data, what do you recommend here - shall we make a simple extension of name value pair in existing API or use some object.

We want to align as much as possible with TMF API Standard but nit having right placeholders is what we are stuck with?

It would be really great if you can advise on the right way forward. I dont know if TMF already have any plans to enhance the API , may be someone else have also encountered similar issues.

I'll wait for your response, thanks in advance!

This would seem to be a correct usage, presumably the questionnaire will be a PDF, image scan, or word document, or similar?

Note the difference between ref and value - specifically for attachment:

• Ref means that the attachment details are created elsewhere as a persistent object and you just refer to it by foreign key (id)
• Value means that the attachment details are embedded within your API object and not created elsewhere

This is orthogonal to the location of the attachment contents (the PDF, word, image file), here you have mutually exclusive properties in the attachment details:

• content - is the actual content of the attachment, in Base64 encoding, embedded within the attachment details
• url - points to the content of the attachment in some document management system or content management system

Hope it is clear

Hi There,

Can anyone please advise where to capture the "Questionaire data" and "Site Safety" details in TMF API , in our implementation there are yes/no questionaire.

We were thinking to use "AttachmentRefOrValue"  for capturing info , is that right place?

Questionnaire sample-

1. any issues faced in installation (Yes/no)
2. is site near secured area (yes/no)

Thanks in advance!

Regards

Ash

Hi,

as I am currently working on upgrading the TMF646 (Appointment) from version 4 to version 5, I would like to better understand the scenario and how you plan to use this API. From my understanding, you are talking about two use cases:

1. Arrange for a technician having the needed skills at a given place and find a time slot where he will be available.
   I think this should be done by POSTing a SearchTimeSlot that includes the requestedTimeSlot; what is not so obvious is how one can express the needed skills; I imagine that the relatedParty might point to a PartyRole that does not have an engagedParty attached, which expresses that we know that we need a "technician", but do not yet know which person will take that role. The PartyRole would then have to point to the needed skills (that would be an extension of PartyRole, I assume), and based on that information a person (Party/Individual) can be identified that has the required skills and is available at the requested time and location to work on the relatedEntity, and then the relatedParty on the SearchTimeSlot would be changed to point to the identified person, with role="technician".
   To enable this, you would either have to use PartyRole.characteristic as mentioned by Jonathan, or to extend PartyRole by Skill, similar to the Skill on Party.
2. When on site, the technician captures the described information and inserts it into some document, that you model as AttachmentRefOrValue.
   In version 4, AttachmentRefOrValue has only limited capabilities to carry concrete information, the captured information could be captured as attachmentType and maybe description (as far as I understand it is not necessary to interpret Attachment as a document, could be some piece of information only), or you store the data in some document that you store via the Document API and refer to by AttachmentRef. The Document (managed by TMF667) can either be some binary file like a PDF or similar, or you can use its characteristics to store the captured data. The document could also be specified by a DocumentSpecification, and that defines via CharactersticSpecification which characteristics exist in that type of document.

Does this make sense?

Do we have to modify/extend anything in the Attachment API when we create the Version 5?

If you want to pass more structured data, as you show here, name-value pairs, one possibility would be to define the questionnaire as a collection of Characteristics. But we strongly recommend that Characteristics are not used in an unrestricted fashion - they should be backed by Characteristic Specifications.

Possibly other people might be able to give alternative recommendations?

Hope it helps

Hi Jonathan,

Thanks for the clarification earlier, i still have few doubts and I hope you can advice on this:

We have two type of data which we are trying to map in TMF646:

• Health and Safety skills used by SFS to select the right engineers to send to the site that requires them (some example below)
  
  

  Skill Name	Skill ID	Answer
  S1 - Ladders leaning	HS1	Yes/No
  S2 - Ladders vertical	HS2	Yes/No
  S3 - Steps	HS3	Yes/No
  S4 - Drills	HS4	Yes/No
  S5 - Angle Grinders	HS5	Yes/No

• Questionnaire - Closure questionnaire presented to engineer upon marking the job as complete/incomplete. Sent to upstream in milestone notification or Questionnaires answered by the Field engineer's on site while doing the installation work as below
  
  

  Question	Field name	answer format	answer options
  QC01	Target Time	Date & Time format	System Defaulted
  QC02	Task complete date & time	**/**/****	Date & Time Format
  QC03	Ring Ahead ?	Drop down	Yes
  QC05	Service tested?	Drop down	Yes
  			No
  QC06	Why service not tested ?	Free Text
  QC07	Closure Notes	free Text

We want to pass this data to the upstream system which are used by Order management personal to keep a track of the appointment in case any changes are needed and some of the data also help them in passing information to other teams like configuration .

Not sure if we can use "AttachmentRefOrValue" object for this data set as this are mostly name/value pair kind of data?

At the moment there is no right placeholders available in 646 API for questionaire data, what do you recommend here - shall we make a simple extension of name value pair in existing API or use some object.

We want to align as much as possible with TMF API Standard but nit having right placeholders is what we are stuck with?

It would be really great if you can advise on the right way forward. I dont know if TMF already have any plans to enhance the API , may be someone else have also encountered similar issues.

I'll wait for your response, thanks in advance!

This would seem to be a correct usage, presumably the questionnaire will be a PDF, image scan, or word document, or similar?

Note the difference between ref and value - specifically for attachment:

• Ref means that the attachment details are created elsewhere as a persistent object and you just refer to it by foreign key (id)
• Value means that the attachment details are embedded within your API object and not created elsewhere

This is orthogonal to the location of the attachment contents (the PDF, word, image file), here you have mutually exclusive properties in the attachment details:

• content - is the actual content of the attachment, in Base64 encoding, embedded within the attachment details
• url - points to the content of the attachment in some document management system or content management system

Hope it is clear

Hi There,

Can anyone please advise where to capture the "Questionaire data" and "Site Safety" details in TMF API , in our implementation there are yes/no questionaire.

We were thinking to use "AttachmentRefOrValue"  for capturing info , is that right place?

Questionnaire sample-

1. any issues faced in installation (Yes/no)
2. is site near secured area (yes/no)

Thanks in advance!

Regards

Ash