Creating Synonyms With the Adapter for Alchemy

How to:

After adding an Alchemy connection, a set of predefined synonyms and example procedures (FOCEXECs) can be created for this connection.


Top of page

x
Procedure: How to Create a Synonym

To create a synonym, you must have previously configured the adapter. You can create a synonym from the Applications or Adapters pages of the Web Console.

  1. From the Web Console menu bar, click Adapters.

    The Adapters page opens.

  2. Open the ALCHEMY folder.
  3. Right-click a connection and select Create Synonym from the drop-down menu.

    The Select candidate(s) for ALCHEMY Synonym(s) page opens, as shown in the following image.

  4. Enter a folder name in the Application field or click the selector button (...) and navigate to one.
  5. Click Create Synonym.

    The synonyms and sample procedures are created in the application folder, as shown in the following image.

Note:



Example: Alchemy Master File and Access File

Master File

FILENAME=M6ILO, SUFFIX=REST    , $
  SEGMENT=M6ILO, SEGTYPE=S0, $
    FIELDNAME=APIKEY, ALIAS=apikey, USAGE=A40, ACTUAL=A40, ACCESS_PROPERTY=(NEED_VALUE),
      XDEFAULT='APIKEYenteredInCreateSynonym', $
    FIELDNAME=DOC, ALIAS=text, USAGE=TX50, ACTUAL=TX, ACCESS_PROPERTY=(NEED_VALUE),
      XDEFAULT='Happy', $
    FIELDNAME=__RESPONSE, USAGE=TX80L, ACTUAL=TX, ACCESS_PROPERTY=(INTERNAL), $
  SEGMENT=RESPONSE, SEGTYPE=S0, SEGSUF=XML     , PARENT=M6ILO, POSITION=__RESPONSE, $
    FIELDNAME=RESULTS, ALIAS=results, USAGE=A1, ACTUAL=A1, ACCESS_PROPERTY=(INTERNAL),
      PROPERTY=ELEMENT,  $
    FIELDNAME=STATUS, ALIAS=status, USAGE=A55, ACTUAL=A55,
      REFERENCE=RESULTS, PROPERTY=ELEMENT,  $
    FIELDNAME=STATUSINFO, ALIAS=statusInfo, USAGE=A200, ACTUAL=A200,
      REFERENCE=RESULTS, PROPERTY=ELEMENT,  $
    FIELDNAME=USAGE, ALIAS=usage, USAGE=A55, ACTUAL=A55,
      REFERENCE=RESULTS, PROPERTY=ELEMENT,  $
    FIELDNAME=URL, ALIAS=url, USAGE=A55, ACTUAL=A55,
      REFERENCE=RESULTS, PROPERTY=ELEMENT,  $
    FIELDNAME=LANGUAGE, ALIAS=language, USAGE=A55, ACTUAL=A55,
      REFERENCE=RESULTS, PROPERTY=ELEMENT,  $
    FIELDNAME=DOCSENTIMENT, ALIAS=docSentiment, USAGE=A1, ACTUAL=A1, ACCESS_PROPERTY=(INTERNAL),
      REFERENCE=RESULTS, PROPERTY=ELEMENT,  $
    FIELDNAME=TYPE, ALIAS=type, USAGE=A55, ACTUAL=A55,
      REFERENCE=DOCSENTIMENT, PROPERTY=ELEMENT,  $
    FIELDNAME=SCORE, ALIAS=score, USAGE=P20.10, ACTUAL=A20,
      REFERENCE=DOCSENTIMENT, PROPERTY=ELEMENT,  $

Access File

SEGNAME=M6ILO, CONNECTION=alchemy, OBJECT=TextGetTextSentiment, 
  SERVICETYPE=REST, HTTPMETHOD=POST, RESTRESPONSE=XML, HTTPBODY=ENCODE, $

iWay Software